文档

集成SDK

更新时间:
一键部署

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

环境要求

Python版本 >= 3.7。

第一步:设置访问凭据

调用阿里云OpenAPI通常需要设置访问密钥(AccessKey),详情参见凭据。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见凭据的安全使用方案。以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET为例:

  • Linux和macOS系统配置方法

    1. 创建.bash_profile文件

      说明

      如果是第一次设置环境变量,可以使用touch ~/.bash_profile创建一个配置文件,如果已经存在配置文件,则使用vim ~/.bash_profile命令直接编辑文件。

      touch ~/.bash_profile
      vim ~/.bash_profile
    2. 配置.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>

      编辑完成后保存退出。

    3. 使用.bash_profile文件

      # 使配置文件生效
      source ~/.bash_profile
      # 显示配置是否生效
      echo $ALIBABA_CLOUD_ACCESS_KEY_ID

      若返回正确的AccessKey,则说明配置成功。

  • Windows系统配置方法

    以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_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_ID3 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,则说明配置成功。

第二步:引入SDK

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

特化调用

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

  1. 访问短信服务SDK

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

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

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

其Python语言安装产品如下:

pip install alibabacloud_dysmsapi20170525==2.0.24

泛化调用

泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包alibabacloud_tea_openapi。其Python语言安装产品如下,最新版本请参见alibabacloud-tea-openapi

pip install alibabacloud-tea-openapi

第三步:调用OpenAPI

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

初始化请求客户端

方法一:使用AK初始化

from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
import os

@staticmethod
def create_client():
	config = open_api_models.Config(
		# 必填,您的 AccessKey ID,
		access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		# 必填,您的 AccessKey Secret,
		access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
	)
	# Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
	config.endpoint = f'dysmsapi.aliyuncs.com'
	# 特化请求客户端
	dysmsapi_client = Dysmsapi20170525Client(config)

方法二:使用STS Token初始化

from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
import os

@staticmethod
def create_client():
	config = open_api_models.Config(
		# 必填,您的 AccessKey ID,
		access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		# 必填,您的 AccessKey Secret,
		access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
		# 必填,您的 STS Token
		security_token=os.environ.get('ALIBABA_CLOUD_SECURITY_TOKEN')
	)
	# Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
	config.endpoint = f'dysmsapi.aliyuncs.com'
	# 特化请求客户端
	dysmsapi_client = Dysmsapi20170525Client(config)

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

from alibabacloud_credentials.client import Client as CredClient
from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi.models import Config

# 使用默认凭证初始化Credentials Client。
cred = CredClient()
config = Config(credential=cred)
# 若接入dysmsapi即短信服务,则初始化dysmsapi产品包的Client类
config.endpoint = 'dysmsapi.aliyuncs.com'
# 特化请求客户端
dysmsapi_client = Dysmsapi20170525Client(config)

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

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

from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_models
from alibabacloud_tea_util import models as util_models

# 创建请求对象并设置入参
send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
	phone_numbers='<YOUR_VALUE>',
	sign_name='<YOUR_VALUE>'
)
# 创建运行时配置对象
runtime = util_models.RuntimeOptions()

发起请求

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

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

    from alibabacloud_credentials.client import Client as CredClient  # Credentials和云产品SDK都需引入Client,此处为创建别名。
    from alibabacloud_dysmsapi20170525.client import Client as DysmsApiClient  # 引入阿里云短信服务 SDK,此处以短信服务产品为例。
    from alibabacloud_tea_openapi.models import Config
    from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_models  # 引入阿里云SDK核心包。
    
    # 使用默认凭证初始化Credentials Client。
    credentialClient = CredClient()
    smsConfig: Config = Config(credential=credentialClient)
    # 配置云产品服务接入地址(endpoint)。
    smsConfig.endpoint = 'ecs.aliyuncs.com'
    # 使用Credentials Client初始化SMS Client。
    smsClient = DysmsApiClient(smsConfig)
    # 构造请求对象
    sendSmsRequest = dysmsapi_20170525_models.SendSmsRequest()
    # 获取响应对象
    sendSmsResponse = smsClient.send_sms(sendSmsRequest)
    print(sendSmsResponse.to_map())
  • <接口名称>_with_options:可配置自定义运行时参数发起接口调用,更多运行时参数配置请参见进阶配置

    from alibabacloud_credentials.client import Client as CredClient  # Credentials和云产品SDK都需引入Client,此处为创建别名。
    from alibabacloud_dysmsapi20170525.client import Client as DysmsApiClient  # 引入阿里云短信服务 SDK,此处以短信服务产品为例。
    from alibabacloud_tea_openapi.models import Config
    from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_models  # 引入阿里云SDK核心包。
    from alibabacloud_tea_util import models as util_models
    
    # 使用默认凭证初始化Credentials Client。
    credentialClient = CredClient()
    smsConfig: Config = Config(credential=credentialClient)
    # 配置云产品服务接入地址(endpoint)。
    smsConfig.endpoint = 'ecs.aliyuncs.com'
    # 使用Credentials Client初始化SMS Client。
    smsClient = DysmsApiClient(smsConfig)
    # 构造请求对象
    sendSmsRequest = dysmsapi_20170525_models.SendSmsRequest()
    # 构造运行时参数对象
    runtime = util_models.RuntimeOptions()
    # 读取超时
    runtime.readTimeout=10000;
    # 连接超时
    runtime.connectTimeout=5000;
    # 是否自动重试
    runtime.autoretry=True;
    # 获取响应对象
    sendSmsResponse = smsClient.send_sms_with_options(sendSmsRequest,runtime)
    print(sendSmsResponse.to_map())
    
  • <接口名称>Advance:专门用于应对直接上传Object 的场景,该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸产品为例介绍SDK如何使用本地文件上传调用 API。

    # 视觉智能开放平台人体人脸产品依赖:
    pip install alibabacloud_facebody20191230==4.0.9
    from alibabacloud_credentials.client import Client as CredClient   # Credentials和云产品SDK都需引入Client,此处为创建别名。
    from alibabacloud_facebody20191230.client import Client as FacebodyClient  # 引入阿里云Facebody SDK,此处以人体人脸产品为例。
    from alibabacloud_tea_openapi.models import Config    # 引入阿里云SDK核心包。
    from alibabacloud_tea_util import models as util_models
    from alibabacloud_facebody20191230 import models as facebody_20191230_models
    
    # 使用默认凭证初始化Credentials Client。
    credentialClient = CredClient()
    facebodyConfig = Config(credential=credentialClient)
    # 配置云产品服务接入地址(endpoint)。
    facebodyConfig.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
    facebody_client = FacebodyClient(facebodyConfig)           
    detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest()
    detect_body_count_advance_request.image_urlobject = open('<filepath>', 'rb')
    # 构造运行时参数对象
    runtimeOptions = util_models.RuntimeOptions()
    # 读取超时
    runtimeOptions.readTimeout=10000;
    # 连接超时
    runtimeOptions.connectTimeout=5000;
    # 是否自动重试
    runtimeOptions.autoretry=True;
    
    response = facebody_client.detect_body_count_advance(detect_body_count_advance_request, runtimeOptions)
    print(response.to_map())

  • 本页导读 (1)