文档

集成SDK

更新时间:
一键部署

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

环境要求

net framework >= 4.5 或 .Net Core >= 2.0

第一步:设置访问凭据

调用阿里云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. 在您的项目中载入该依赖包。

其.NET语言安装产品如下:

dotnet add package AlibabaCloud.SDK.Dysmsapi20170525 --version 2.0.24

泛化调用

泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包AlibabaCloud.OpenApiClient。其PHP语言安装配置文件如下,最新版本请参见AlibabaCloud.OpenApiClient

dotnet add package AlibabaCloud.OpenApiClient --version 0.1.8

第三步:调用OpenAPI

您可以根据快速开始文档下载示例代码。接下来我们以特化调用代码为例,讲解调用过程。如果您选择泛化调用方案,请打开Common模式生成示例的开关。

初始化请求客户端

方法一:使用AK初始化

AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
	// 必填,您的 AccessKey ID
	AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
	// 必填,您的 AccessKey Secret
	AccessKeySecret = accessKeySecret,
};
// Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
config.Endpoint = "dysmsapi.aliyuncs.com";
// 特化请求客户端
AlibabaCloud.SDK.Dysmsapi20170525.Client client = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config);

方法二:使用STS Token初始化

public static void CreateClient()
{
	AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
	{
		// 必填,您的 AccessKey ID
		AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
		// 必填,您的 AccessKey Secret
		AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
		// 必填,您的STS Token
		SecurityToken = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_SECURITY_TOKEN")
	};
	// Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
	config.Endpoint = "dysmsapi.aliyuncs.com";
  // 特化请求客户端
	AlibabaCloud.SDK.Dysmsapi20170525.Client dysmsapiClient = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config);
}

方法三:使用Credentials工具初始化

public static void Main()
{
    AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
    {
        // 使用默认凭证初始化Credentials Client
        Credential=new Aliyun.Credentials.Client(null)
    };
    // 若接入dysmsapi即短信服务,则初始化dysmsapi产品包的Client类
    config.Endpoint = "dysmsapi.aliyuncs.com";
    // 特化请求客户端
    AlibabaCloud.SDK.Dysmsapi20170525.Client dysmsapiClient = new AlibabaCloud.SDK.Dysmsapi20170525.Client(config);
}

创建请求对象&运行时配置

通常您需要根据业务的实际需要传入参数,您也可自定义运行时配置。

// 创建请求对象并设置入参
AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest
{
	PhoneNumbers = "<YOUR_VALUE>",
	SignName = "<YOUR_VALUE>",
};
// 创建运行时配置对象
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();

发起请求

升级版 SDK 中每个产品的 Client 包含了所有的 OpenAPI,所以可以指定 OpenAPI 请求方法来请求,其方法名对应 OpenAPI 首字母小写,一般有三个:

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

    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.IO;
    using System.Threading.Tasks;
    using Tea;
    using Tea.Utils;
    
    
    namespace AlibabaCloud.SDK.Sample
    {
        public class Sample
        {
            public static void Main(string[] args)
            {
                Aliyun.Credentials.Client credentialClient = new Aliyun.Credentials.Client(null);
                AlibabaCloud.OpenApiClient.Models.Config smsConfig = new AlibabaCloud.OpenApiClient.Models.Config();
                smsConfig.Credential = credentialClient;
                smsConfig.RegionId = "<regionId>";
                AlibabaCloud.SDK.Dysmsapi20170525.Client smsClient = new AlibabaCloud.SDK.Dysmsapi20170525.Client(smsConfig);
                // 构造请求对象
                AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest();
                // 获取响应对象
                AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsResponse response = smsClient.SendSms(sendSmsRequest);
                // response 包含服务端响应的 body 和 headers
                System.Console.WriteLine(response.Body);
                System.Console.WriteLine(response.Headers);
            }
        }
    }
    
  • <接口名称>WithOptions:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置

    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.IO;
    using System.Threading.Tasks;
    using Tea;
    using Tea.Utils;
    
    
    namespace AlibabaCloud.SDK.Sample
    {
        public class Sample
        {
            public static void Main(string[] args)
            {
                Aliyun.Credentials.Client credentialClient = new Aliyun.Credentials.Client(null);
                AlibabaCloud.OpenApiClient.Models.Config smsConfig = new AlibabaCloud.OpenApiClient.Models.Config();
                smsConfig.Credential = credentialClient;
                smsConfig.RegionId = "<regionId>";
                AlibabaCloud.SDK.Dysmsapi20170525.Client smsClient = new AlibabaCloud.SDK.Dysmsapi20170525.Client(smsConfig);
                // 构造请求对象
                AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest sendSmsRequest = new AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsRequest();
                // 构造运行时参数
                AlibabaCloud.TeaUtil.Models.RuntimeOptions runtimeOptions = new AlibabaCloud.TeaUtil.Models.RuntimeOptions()
                {
                    // 读取超时
                    ReadTimeout = 10000,
                    // 连接超时
                    ConnectTimeout = 5000,
                    // 是否自动重试
                    Autoretry = false
                };
                // 获取响应对象
                AlibabaCloud.SDK.Dysmsapi20170525.Models.SendSmsResponse response = smsClient.SendSmsWithOptions(sendSmsRequest,runtimeOptions);
                // response 包含服务端响应的 body 和 headers
                System.Console.WriteLine(response.Body);
                System.Console.WriteLine(response.Headers);
            }
        }
    }
    
  • <接口名称>Advance:专门用于应对直接上传Object 的场景,该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸产品为例介绍SDK如何使用本地文件上传调用 API。

    // 视觉智能开放平台人体人脸产品依赖:
    dotnet add package AlibabaCloud.SDK.Facebody20191230 --version 3.0.8
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.IO;
    using System.Threading.Tasks;
    using Tea;
    using Tea.Utils;
    
    
    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()
        {
            // 读取超时
            ReadTimeout = 10000,
            // 连接超时
            ConnectTimeout = 5000,
            // 是否自动重试
            Autoretry = false
        };
        // 通过 SDK Core 执行实际的 Http 请求将返回的结果序列化为 SDK 的 Response 结构
        var response = client.DetectBodyCountAdvance(request, runtimeOptions);
        System.Console.WriteLine(response.Body.RequestId);
        System.Console.WriteLine(response.Body.Data.PersonNumber);
    }
        }
    }
    
  • 本页导读 (1)
文档反馈