集成SDK
集成阿里云SDK主要有三步:设置访问凭据、引入阿里云SDK、编写调用代码。 本文将以PHP
语言调用短信服务 SMS(Short Message Service)的发送短信接口为例,讲解完整的集成步骤。
环境要求
PHP版本 >= 5.6。
必须在系统上全局安装 Composer。
执行 composer 安装 SDK 的 PHP 版本要小于或等于实际运行时的 PHP 版本。 例如,在 PHP7.2 环境下安装 SDK 后生成 vendor 目录,只能在 PHP7.2 以上版本使用,如果拷贝到 PHP5.6 环境下使用,会出现依赖版本不兼容问题。一些用户可能由于网络问题无法安装,可以通过以下命令使用阿里云 Composer 全量镜像。
composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
调用阿里云OpenAPI通常需要设置访问密钥(AccessKey),详情参见凭据。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见凭据的安全使用方案。以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
为例:
Linux和macOS系统配置方法
创建
.bash_profile
文件说明如果是第一次设置环境变量,可以使用
touch ~/.bash_profile
创建一个配置文件,如果已经存在配置文件,则使用vim ~/.bash_profile
命令直接编辑文件。touch ~/.bash_profile vim ~/.bash_profile
配置
.bash_profile
文件# 将以下命令中的<ACCESS_KEY_ID>和<ACCESS_KEY_SECRET>替换为您自己的AccessKey ID和AccessKey Secret。 # 变量名称可以根据实际情况进行替换,例如OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET。 export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>
编辑完成后保存退出。
使用
.bash_profile
文件# 使配置文件生效 source ~/.bash_profile # 显示配置是否生效 echo $ALIBABA_CLOUD_ACCESS_KEY_ID
若返回正确的AccessKey ID,则说明配置成功。
Windows系统配置方法
以设置环境变量
ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
为例:通过图形用户界面GUI
操作步骤
以下为Windows 10中通过图形用户界面设置环境变量的步骤。
在桌面右键单击此电脑,选择属性>高级系统设置>环境变量>系统变量/用户变量>新建,完成以下配置:
变量
示例值
AccessKey ID
变量名:ALIBABA_CLOUD_ACCESS_KEY_ID
变量值:LTAI4GDty8ab9W4Y1D****
AccessKey Secret
变量名:ALIBABA_CLOUD_ACCESS_KEY_SECRET
变量值:IrVTNZNy5yQelTETg0cZML3TQn****
测试设置是否成功
单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行
echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%
命令。若返回正确的AccessKey,则说明配置成功。
通过命令行提示符CMD
操作步骤
以管理员身份打开命令提示符,并使用以下命令在系统中新增环境变量。
setx ALIBABA_CLOUD_ACCESS_KEY_ID LTAI4GDty8ab9W4Y1D**** /M setx ALIBABA_CLOUD_ACCESS_KEY_SECRET IrVTNZNy5yQelTETg0cZML3TQn**** /M
其中
/M
表示系统级环境变量,设置用户级环境变量时可以不携带该参数。测试设置是否成功
单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行
echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%
命令。若返回正确的AccessKey,则说明配置成功。
通过Windows PowerShell
在PowerShell中,设置新的环境变量(对所有新会话都有效):
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::User)
为所有用户设置环境变量(需要管理员权限):
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::Machine)
设置临时的环境变量(仅当前会话有效):
$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "LTAI4GDty8ab9W4Y1D****" $env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "IrVTNZNy5yQelTETg0cZML3TQn****"
在PowerShell中,执行
Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID
、Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET
命令。若返回正确的AccessKey,则说明配置成功。
第二步:引入SDK
阿里云SDK支持泛化调用与特化调用两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。
特化调用
您可以访问OpenAPI门户网站,搜索您需要的产品,查看产品支持的SDK语言及安装方法,然后在您的项目中引入SDK。本案例的SDK获取步骤如下:
访问短信服务SDK。
在所有语言栏目中选择您需要的SDK语言。
选择您需要的安装方式,将代码复制到您的项目中。
在您的项目中载入该依赖包。
其PHP语言安装产品如下:
composer require alibabacloud/dysmsapi-20170525 2.0.23
泛化调用
泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包Darabonba\OpenApi
。其PHP语言安装配置文件如下,最新版本请参见alibabacloud/darabonba-openapi。:
composer require alibabacloud/darabonba-openapi
第三步:调用OpenAPI
您可以根据快速开始文档下载示例代码。接下来我们以特化调用代码为例,讲解调用过程。如果您选择泛化调用方案,请打开Common模式生成示例的开关,更多信息请参见泛化调用与特化调用。
初始化请求客户端
方法一:使用AK初始化
<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;
public static function createClient(){
$config = new Config([
// 必填,您的 AccessKey ID
"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
// 必填,您的 AccessKey Secret
"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
]);
// Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
$config->endpoint = "dysmsapi.aliyuncs.com";
// 特化请求客户端
$dysmsApiClient = new DysmsAPI($config);
}
方法二:使用STS Token初始化
<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;
public static function createClient(){
$config = new Config([
// 必填,您的 AccessKey ID
"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
// 必填,您的 AccessKey Secret
"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
// 必填,您的STS Token
"securityToken" => getenv('ALIBABA_CLOUD_SECURITY_TOKEN')
]);
// Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
$config->endpoint = "dysmsapi.aliyuncs.com";
// 特化请求客户端
$dysmsApiClient = new DysmsAPI($config);
}
方法三:使用Credentials工具初始化
<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;
// 使用默认凭证初始化Credentials Client。
$credential = new Credential([]);
$config = new Config([
// 使用 credential 配置凭证
'credential' => $credential,
]);
// 若接入dysmsapi即短信服务,则初始化dysmsapi产品包的Client类
$config->endpoint = 'dysmsapi.aliyuncs.com';
// 初始化dysmsapi产品包的Client类
$dysmsApiClient = new DysmsAPI($config);
创建请求对象&运行时配置
通常您需要根据业务的实际需要传入参数,您也可自定义运行时配置。
// 创建请求对象并设置入参
$sendSmsRequest = new SendSmsRequest([
"phoneNumbers" => "<YOUR_VALUE>",
"signName" => "<YOUR_VALUE>"
]);
// 创建运行时配置对象
$runtime = new RuntimeOptions([]);
发起请求
升级版 SDK 中每个产品的 Client 包含了所有的 OpenAPI,所以可以指定 OpenAPI 请求方法来请求,其方法名对应 OpenAPI 首字母小写,一般有三个:
<接口名称>
:使用默认的运行时配置发起接口调用,可以不用传入运行参数的请求方法。<?php use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi; use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest; use Darabonba\OpenApi\Models\Config; use AlibabaCloud\Credentials\Credential; // composer 自动加载机制,require_once(vendor目录下autoload.php文件) require_once('../vendor/autoload.php'); // 使用默认凭证初始化Credentials Client。 $credentialClient = new Credential([]); $smsConfig = new Config([ // 使用 credential 配置凭证 'credential' => $credentialClient, // 产品服务域名 'endpoint' => 'ecs.aliyuncs.com' ]); $smsClient = new Dysmsapi($smsConfig); // 构造请求对象 $sendSmsRequest = new SendSmsRequest([]); // 获取响应对象 $response = $smsClient->sendSms($sendSmsRequest); var_dump($response);
<接口名称>WithOptions
:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置。<?php use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi; use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest; use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions; use Darabonba\OpenApi\Models\Config; use AlibabaCloud\Credentials\Credential; // composer 自动加载机制,require_once(vendor目录下autoload.php文件) require_once('../vendor/autoload.php'); // 使用默认凭证初始化Credentials Client。 $credentialClient = new Credential([]); $smsConfig = new Config([ // 使用 credential 配置凭证 'credential' => $credentialClient, // 产品服务域名 'endpoint' => 'ecs.aliyuncs.com' ]); $smsClient = new Dysmsapi($smsConfig); // 构造请求对象 $sendSmsRequest = new SendSmsRequest([]); $runtime = new RuntimeOptions(); // 是否自动重试 $runtime->autoretry = true; // 连接超时 $runtime->connectTimeout = 10000; // 读取超时 $runtime->readTimeout = 10000; // 获取响应对象 $response = $smsClient->sendSmsWithOptions($sendSmsRequest,$runtime); var_dump($response);
<接口名称>Advance
:专门用于应对直接上传Object 的场景,该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸
产品为例介绍SDK如何使用本地文件上传调用 API。<?php use Darabonba\OpenApi\Models\Config; use GuzzleHttp\Psr7\Stream; use AlibabaCloud\Credentials\Credential; use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions; use AlibabaCloud\Tea\Exception\TeaError; use AlibabaCloud\SDK\Facebody\V20191230\Facebody; use AlibabaCloud\SDK\Facebody\V20191230\Models\DetectBodyCountAdvanceRequest; // composer 自动加载机制,require_once(vendor目录下autoload.php文件) require_once('../vendor/autoload.php'); $credentialClient = new Credential([]); $facebodyConfig = new Config([ // 使用 credential 配置凭证 'credential' => $credentialClient, // 产品服务域名 'endpoint' => 'facebody.cn-shanghai.aliyuncs.com' ]); $request = new DetectBodyCountAdvanceRequest(); // 读取文件并将文件流配置给SDK请求对象 $request->imageURLObject = new Stream(fopen("<filepath>", "rb")); $runtime = new RuntimeOptions(); $facebodyClient = new Facebody($facebodyConfig); try { // 调用本地文件上传方法,将文件上传 $response = $facebodyClient->detectBodyCountAdvance($request, $runtime); var_dump($response); } catch (TeaError $e) { var_dump($e->getMessage()); var_dump($e->getErrorInfo()); var_dump($e->getLastException()); var_dump($e->getLastRequest()); }