如何使用阿里云OpenAPI的SDK开发包-号码认证服务(PNVS)-阿里云帮助中心

本文介绍如何使用OpenAPI调用DescribeVerifyScheme接口获取认证方案详情的完整示例。

步骤一：查看 OpenAPI 文档

在调用OpenAPI前，建议您阅读对应接口文档DescribeVerifyScheme，了解、学习调用该接口所需要的参数及权限等，更多详情请参见API概览。根据接口文档，我们了解调用该接口需要的参数及权限。

步骤二：认证配置

创建RAM用户并完成授权

重要

阿里云主账号拥有较高权限，建议您通过RAM用户进行API调用和日常运维。有关RAM用户的更多信息，请参见RAM用户概览。

创建RAM用户：访问创建RAM用户，完成相关名称设置，并选择访问配置为使用永久 AccessKey 访问，单击确定后即可完成RAM用户的创建。请及时保存AccessKey信息。
为RAM用户授权：访问RAM用户列表，找到您所创建的RAM用户，单击操作列的新增授权。在权限策略文本搜索框中输入AliyunDysmsFullAccess后选中此策略，单击确认新增授权，即可完成授权操作。

说明

AliyunDypnsFullAccess：管理号码认证服务的权限。
AliyunDypnsReadOnlyAccess：只读访问号码认证服务的权限。
如果您需要新建自定义权限，请参见授权信息。

获取访问凭证

请配置环境变量，通过环境变量读取访问密钥（AccessKey）。环境变量配置方法，请参见在Linux、macOS和Windows系统配置环境变量。

说明

为避免在代码中硬编码AccessKey而造成泄露，请通过配置环境变量的方式，来获取AccessKey。
本文代码示例以环境变量名ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET为例，进行后续操作。

步骤三：调用 OpenAPI

本文以Python语言SDK调用OpenAPI，其他语言SDK的用法类似，更多信息请参见号码认证SDK。您也可根据业务的实际需要选择其他调用方式，更多调用方法请参见调用方式。

准备 Python 环境

下载并安装Python 3。如您已安装Python，查看Python版本的命令示例：python --version。

说明

调用接口前，需要配置环境变量，以便通过环境变量读取访问凭证。AccessKey ID和AccessKey Secret的环境变量名：VMS_AK_ENV 、VMS_SK_ENV。配置详情请参见在Linux、macOS和Windows系统配置环境变量。

安装依赖

在终端设备中，逐条运行如下命令，安装环境依赖。

pip install alibabacloud_credentials
pip install alibabacloud_dypnsapi20170525
pip install alibabacloud_tea_console

下载示例代码

访问DescribeVerifyScheme。
在左侧的参数配置页签，填写需要的参数信息，本示例服务地址选择华东1（杭州）。
在右侧的SDK示例页签，选择Python语言，单击下载完整工程按钮，下载示例代码包。
本地解压并进入alibabacloud_sample目录。

运行代码

执行以下命令

python sample.py

得到如下输出结果：

{
  "headers": {
    "date": "Tue, 04 Jul 2023 05:37:58 GMT",
    "content-type": "application/json;charset=utf-8",
    "content-length": "392",
    "connection": "keep-alive",
    "keep-alive": "timeout=25",
    "access-control-allow-origin": "*",
    "access-control-expose-headers": "*",
    "x-acs-request-id": "BC2766D5-CC72-5302-8091-1CEC6AF75***",
    "x-acs-trace-id": "b6dbcf003b020c6689f278520a480***",
    "etag": "3GiaUeTRBz/488MtwdjI+4g2"
  },
  "statusCode": 200,
  "body": {
    "Code": "OK",
    "Message": "OK",
    "RequestId": "BC2766D5-CC72-5302-8091-1CEC6AF756***",
    "SchemeQueryResultDTO": {
      "AppEncryptInfo": "***"
    }
  }
}