集成SDK

更新时间: 2023-10-27 13:52:31

集成阿里云SDK主要有三步:设置访问凭据、引入阿里云SDK、编写调用代码。 本文将以PHP语言调用短信服务 SMS(Short Message Service)的发送短信接口为例,讲解完整的集成步骤。

环境要求

重要

执行 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_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

  • Linux和macOS系统配置方法

    命令行终端执行以下命令:

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

    <access_key_id>需替换为已准备好的AccessKey ID,<access_key_secret>替换为AccessKey Secret。

  • Windows系统配置方法

    1. 新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。

第二步:引入SDK

阿里云SDK支持泛化调用与特化调用两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。

特化调用

您可以访问OpenAPI门户网站,搜索您需要的产品,查看产品支持的SDK语言及安装方法,然后在您的项目中引入SDK。本案例的SDK获取步骤如下:

  1. 访问短信服务SDK

  2. 所有语言栏目中选择您需要的SDK语言。

  3. 选择您需要的安装方式,将代码复制到您的项目中。

  4. 在您的项目中载入该依赖包。

其PHP语言安装产品如下:

composer require alibabacloud/dysmsapi-20170525 2.0.23

泛化调用

泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包Darabonba\OpenApi。其PHP语言安装配置文件如下:

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请求客户端会为每个OpenAPI提供两个调用函数:

  1. <接口名称>:使用默认的运行时配置发起接口调用。

  2. <接口名称>WithOptions:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置

发送短信对应的OpenAPI名称为sendSms,生成调用函数sendSmssendSmsWithOptions

示例代码如下:

try {
// 使用默认运行时配置发起接口调用
$response = $client->sendSms($sendSmsRequest);
// 使用自定义运行时配置发起接口调用
// $response->sendSmsWithOptions($sendSmsRequest, $runtime);
}
catch (Exception $error) {
// 如有需要,请打印 error
}

阿里云首页 阿里云SDK 相关技术圈