Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 4.92 KB

AlipayOpenMiniSafedomainApi.md

File metadata and controls

149 lines (104 loc) · 4.92 KB

Alipay\OpenAPISDK\AlipayOpenMiniSafedomainApi

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

Method HTTP request Description
create() POST /v3/alipay/open/mini/safedomain/create 小程序添加域白名单
delete() DELETE /v3/alipay/open/mini/safedomain/delete 小程序删除域白名单

create()

create($alipayOpenMiniSafedomainCreateModel): object

小程序添加域白名单

小程序添加域白名单

Example

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



$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenMiniSafedomainApi(
    // 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);

$alipayOpenMiniSafedomainCreateModel = new \Alipay\OpenAPISDK\Model\AlipayOpenMiniSafedomainCreateModel(); // \Alipay\OpenAPISDK\Model\AlipayOpenMiniSafedomainCreateModel

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

Parameters

Name Type Description Notes
alipayOpenMiniSafedomainCreateModel \Alipay\OpenAPISDK\Model\AlipayOpenMiniSafedomainCreateModel [optional]

Return type

object

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($safeDomain): object

小程序删除域白名单

小程序删除域白名单

Example

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



$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenMiniSafedomainApi(
    // 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);

$safeDomain = example.com; // string | 服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。 删除域白名单后需重新上传应用版本(模板模式下小程序模板及商家应用都需重新上传、实例化版本)才会生效。老版本应用继续使用老版本名单(即删除域名可继续使用)。

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

Parameters

Name Type Description Notes
safeDomain string 服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。 删除域白名单后需重新上传应用版本(模板模式下小程序模板及商家应用都需重新上传、实例化版本)才会生效。老版本应用继续使用老版本名单(即删除域名可继续使用)。 [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]