Skip to content

Latest commit

 

History

History
217 lines (151 loc) · 7 KB

AlipayOpenPublicPersonalizedExtensionApi.md

File metadata and controls

217 lines (151 loc) · 7 KB

Alipay\OpenAPISDK\AlipayOpenPublicPersonalizedExtensionApi

All URIs are relative to https://openapi.alipay.com.

Method HTTP request Description
batchquery() POST /v3/alipay/open/public/personalized/extension/batchquery 扩展区批量查询接口
create() POST /v3/alipay/open/public/personalized/extension/create 个性化扩展区创建接口
delete() DELETE /v3/alipay/open/public/personalized/extension/delete 扩展区删除接口

batchquery()

batchquery(): \Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel

扩展区批量查询接口

开发者可使用此接口批量查询扩展区列表，包括默认扩展区和个性化扩展区

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenPublicPersonalizedExtensionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);


try {
    $result = $apiInstance->batchquery();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlipayOpenPublicPersonalizedExtensionApi->batchquery: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

create()

create($alipayOpenPublicPersonalizedExtensionCreateModel): \Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionCreateResponseModel

个性化扩展区创建接口

开发者可使用该接口创建一套个性化扩展区，符合该扩展区规则的用户进入生活号主页后会看到该个性化扩展区

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenPublicPersonalizedExtensionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$alipayOpenPublicPersonalizedExtensionCreateModel = new \Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionCreateModel(); // \Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionCreateModel

try {
    $result = $apiInstance->create($alipayOpenPublicPersonalizedExtensionCreateModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlipayOpenPublicPersonalizedExtensionApi->create: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
alipayOpenPublicPersonalizedExtensionCreateModel \Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionCreateModel [optional]

Return type

\Alipay\OpenAPISDK\Model\AlipayOpenPublicPersonalizedExtensionCreateResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

delete()

delete($extensionKey): object

扩展区删除接口

开发者可调用该接口删除创建的一套扩展区，包括个性化扩展区和默认扩展区

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenPublicPersonalizedExtensionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$extensionKey = 10000; // string | 一套扩展区的key，删除默认扩展区时传入default ，查询扩展区列表可以获得每套扩展区的key

try {
    $result = $apiInstance->delete($extensionKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlipayOpenPublicPersonalizedExtensionApi->delete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
extensionKey string 一套扩展区的key，删除默认扩展区时传入default ，查询扩展区列表可以获得每套扩展区的key [optional]

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]