集成阿里云SDK主要有三步:引入阿里云SDK、设置访问凭据、编写调用代码。本文以调用短信服务 SMS(Short Message Service)的发送短信接口为例,讲解完整的集成步骤。
环境要求
net framework >= 4.5 或 .Net Core >= 2.0
1. 引入SDK
阿里云SDK支持泛化与特化两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。
获取特化调用SDK安装方式
特化调用SDK中包含了参数处理、请求组装以及返回值处理等OpenAPI请求的主要逻辑。开发者只需安装相关产品的SDK包依赖,即可调用阿里云OpenAPI。
OpenAPI Explorer
登录SDK Center,选择将要使用产品,例如您将要调用短信服务 SMS(Short Message Service)的API。
在安装页面,所有语言选择C#。然后在快速入门页签中,您可以获取短信服务 SMS(Short Message Service)的SDK安装方式。
GitHub
您也可以访问开源平台GitHub,查看源码及相关安装指引。V2.0 SDK GitHub地址:GitHub - aliyun/alibabacloud-csharp-sdk。
获取泛化调用SDK安装方式
泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包AlibabaCloud.OpenApiClient
。其PHP语言安装配置文件如下,最新版本请参见AlibabaCloud.OpenApiClient。
dotnet add package AlibabaCloud.OpenApiClient --version 0.1.8
2. 设置访问凭据
调用阿里云OpenAPI通常需要设置访问凭据(AccessKey),详情请参见凭据。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见凭据的安全使用方案。以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
为例:
Linux和macOS系统配置方法
通过export命令配置环境变量
使用export命令配置的临时环境变量仅当前会话有效,当会话退出之后所设置的环境变量将会丢失。若需长期保留环境变量,可将export命令配置到对应操作系统的启动配置文件中。
配置AccessKey ID并按回车。
# 将<ACCESS_KEY_ID>替换为您自己的AccessKey ID。 export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
配置AccessKey Secret并回车。
# 将<ACCESS_KEY_SECRET>替换为您自己的AccessKey Secret。 export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>
验证是否配置成功。
执行
echo $ALIBABA_CLOUD_ACCESS_KEY_ID
命令,如果返回正确的AccessKey ID,则说明配置成功。
Windows系统配置方法
通过图形用户界面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,则说明配置成功。
3. 调用OpenAPI
以调用短信服务 SMS(Short Message Service)发送短信接口为例,为您介绍使用特化调用方式调用OpenAPI过程。如果您选择泛化调用方式调用OpenAPI,具体操作步骤请参见泛化调用。
3.1 初始化请求客户端
请求客户端的初始化方式有多种,这里以使用AK初始化为例。更多初始化方式,请参见管理访问凭证。
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
AccessKeySecret = aEnvironment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
};
// 配置 Endpoint
config.Endpoint = "dysmsapi.aliyuncs.com";
// 特化请求客户端
AlibabaCloud.SDK.Dysmsapi20170525.Client client = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config);
3.2 创建请求对象&运行时配置
通常您需要根据业务的实际需要传入参数,您也可自定义运行时配置。
// 创建请求对象并设置入参
AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest
{
// <PHONE_NUMBER>替换为接收短信的手机号码
PhoneNumbers = "<PHONE_NUMBER>",
// <SIGN_NAME>替换为短信签名名称
SignName = "<SIGN_NAME>",
// <TEMPLATE_CODE>替换为短信模板Code
TemplateCode = "<TEMPLATE_CODE>",
// <TEMPLATE_PARAM>替换为短信模板变量对应的实际值。支持传入多个参数。
TemplateParam = "<TEMPLATE_PARAM>"
};
// 创建运行时配置对象
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
3.3 发起请求
云产品Client包含了该产品所有的OpenAPI。针对每一个OpenAPI,Client提供了多种接口定义方式,以便开发者能够以最符合自身项目需求的方式调用OpenAPI,从而提升开发的灵活性与效率。
<接口名称>为OpenAPI名称。
<接口名称>
:使用默认的运行时配置发起接口调用。namespace AlibabaCloud.SDK.Sample { public class Sample { public static void Main(string[] args) { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config { // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。 AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"), // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。 AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET") }; // 配置 Endpoint config.Endpoint = "dysmsapi.aliyuncs.com"; AlibabaCloud.SDK.Dysmsapi20170525.Client client = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config); // 创建请求对象并设置入参 AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest { PhoneNumbers = "<PHONE_NUMBER>", SignName = "<SIGN_NAME>", TemplateCode = "<TEMPLATE_CODE>", TemplateParam = "<TEMPLATE_PARAM>" }; // 复制代码运行请自行打印 API 的返回值 AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsResponse resp = client.SendSms(sendSmsRequest); Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(resp)); } } }
<接口名称>WithOptions
:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置。namespace AlibabaCloud.SDK.Sample { public class Sample { public static void Main(string[] args) { AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config { // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。 AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"), // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。 AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET") }; // 配置 Endpoint config.Endpoint = "dysmsapi.aliyuncs.com"; AlibabaCloud.SDK.Dysmsapi20170525.Client client = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config); // 创建请求对象并设置入参 AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest { PhoneNumbers = "<PHONE_NUMBER>", SignName = "<SIGN_NAME>", TemplateCode = "<TEMPLATE_CODE>", TemplateParam = "<TEMPLATE_PARAM>" }; // 创建运行时配置对象 AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions(); // 调用 API AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsResponse resp = client.SendSmsWithOptions(sendSmsRequest, runtime); Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(resp)); } } }
<接口名称>Advance
:专门用于应对直接上传Object 的场景,该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸
产品为例介绍SDK如何使用本地文件上传调用 API。// 视觉智能开放平台人体人脸产品依赖: dotnet add package AlibabaCloud.SDK.Facebody20191230 --version 3.0.8
namespace AlibabaCloud.SDK.Sample { public class Sample { public static void Main(string[] args) { AlibabaCloud.OpenApiClient.Models.Config facebodyConfig = new AlibabaCloud.OpenApiClient.Models.Config { // 使用默认凭证初始化Credentials Client Credential = new Aliyun.Credentials.Client(null), }; facebodyConfig.Endpoint = "facebody.cn-shanghai.aliyuncs.com"; AlibabaCloud.SDK.Facebody20191230.Client facebodyClient = new AlibabaCloud.SDK.Facebody20191230.Client(facebodyConfig); AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest request = new AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest() { ImageURLObject = new System.IO.FileStream("<YourFilePath>", System.IO.FileMode.Open) }; AlibabaCloud.TeaUtil.Models.RuntimeOptions runtimeOptions = new AlibabaCloud.TeaUtil.Models.RuntimeOptions(); // 通过 SDK Core 执行实际的 Http 请求将返回的结果序列化为 SDK 的 Response 结构 var response = client.DetectBodyCountAdvance(request, runtimeOptions); System.Console.WriteLine(response.Body.RequestId); System.Console.WriteLine(response.Body.Data.PersonNumber); } } }