全部產品
Search
文件中心

Alibaba Cloud SDK:整合SDK

更新時間:Nov 19, 2024

整合阿里雲SDK主要有三步:引入阿里雲SDK、設定訪問憑據、編寫調用代碼。本文以調用Short Message Service (SMS)的傳送簡訊介面為例,講解完整的整合步驟。

環境要求

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

1. 引入SDK

阿里雲SDK支援泛化與特化兩種方式調用OpenAPI,詳情參見泛化調用與特化調用,不同的調用方式需要引入的SDK也不同。

擷取特化調用SDK安裝方式

特化調用SDK中包含了參數處理、請求組裝以及傳回值處理等OpenAPI請求的主要邏輯。開發人員只需安裝相關產品的SDK包依賴,即可調用阿里雲OpenAPI。

OpenAPI Explorer

  1. 登入SDK Center,選擇將要使用產品,例如您將要調用Short Message Service (SMS)的API。

  2. 安裝頁面,所有語言選擇C#。然後在快速入門頁簽中,您可以擷取Short Message Service (SMS)的SDK安裝方式。image

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_IDALIBABA_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_IDGet-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正確的AccessKey,則說明配置成功。

3. 調用OpenAPI

以調用Short Message Service (SMS)傳送簡訊介面為例,為您介紹使用特化調用方式調用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);
            }
        }
    }