本文以Python語言為例,為您介紹如何使用阿里云OpenAPI的SDK開發包。
步驟一:查看OpenAPI文檔
在調用OpenAPI前,建議您閱讀對應接口文檔BindAxb,了解、學習調用該接口所需要的參數及權限等,更多詳情請參見API概覽。
步驟二:創建RAM用戶并完成授權
阿里云賬號擁有所有API的訪問權限,建議您創建并使用RAM用戶進行API訪問或日常運維。
您可以使用阿里云賬號(主賬號)、RAM用戶、RAM角色調用該接口,有關各種身份的差異請參見身份。
本案例中,我們使用RAM用戶進行接口調用。
登錄RAM訪問控制。
在左側導航欄,選擇
。在用戶頁面,單擊創建用戶。
在創建用戶頁面,設置登錄名稱和顯示名稱、訪問方式為控制臺訪問。
單擊確定。
創建RAM用戶成功后,請記錄用戶登錄名稱和密碼,您在調用OpenAPI時,需要使用該RAM用戶登錄阿里云OpenAPI開發者門戶。
- 說明
AliyunDyplsReadOnlyAccess:只讀訪問號碼隱私保護服務的權限。
AliyunDyplsFullAccess:管理號碼隱私保護服務的權限。
如果您需要新建自定義權限,請參見授權信息。
訪問RAM用戶列表。
單擊目標RAM用戶操作列的添加權限。
在文本框中搜索
Aliyundypls
,選擇AliyunDyplsReadOnlyAccess策略。單擊確認新增授權,完成授權操作。
進入到對應的RAM用戶詳情頁,在認證管理頁簽,點擊創建 AccessKey。
更多操作詳情,請參見創建AccessKey。
步驟三:調用OpenAPI
本文以Python語言SDK調用OpenAPI為例,其他語言SDK的用法也類似,更多信息請參見號碼隱私保護SDK。您也可根據業務的實際需要選擇其他調用方式,更多調用方法請參見調用方式。
準備Python環境
下載并安裝Python 3。如您已安裝Python,查看Python版本的命令示例:python --version
。
調用接口前需配置環境變量,通過環境變量讀取訪問憑證。
AccessKey ID和AccessKey Secret的環境變量名:SECRET_AK_ENV 、SECRET_SK_ENV。配置詳情請參見在Linux、macOS和Windows系統配置環境變量。
安裝依賴
在終端設備中,逐條運行如下命令,安裝環境依賴。
pip3 install alibabacloud_credentials
pip install alibabacloud_dyplsapi20170525
pip3 install alibabacloud_tea_console
下載示例代碼
以下操作以調用BindAxb接口為例,您可以在OpenAPI門戶選擇需要調用的接口。
訪問BindAxb,進入該接口在OpenAPI門戶的調試地址。
在左側的參數配置頁簽,填寫需要的參數信息,本示例需在服務地址中選擇華東1(杭州)。
在右側的SDK示例頁簽,選擇Python語言,單擊下載完整工程按鈕,下載示例代碼包。
本地解壓并進入alibabacloud_sample目錄。
運行代碼
執行以下命令:
python sample.py
返回示例如下:
[
LOG
] {
"headers": {
"date": "Fri, 07 Jul 2023 07:07:52 GMT",
"content-type": "application/json;charset=utf-8",
"content-length": "115",
"connection": "keep-alive",
"keep-alive": "timeout=25",
"access-control-allow-origin": "*",
"access-control-expose-headers": "*",
"x-acs-request-id": "8C87CFDC-F3EF-55E3-9661-BCBA1FF3****",
"x-acs-trace-id": "4ef68ba273fa232c203d83737198****",
"etag": "1P+Uo9nOE01KYKLpAKl1****"
},
"statusCode": 200,
"body": {
{
"SecretBindDTO": {
"Extension": "1998320****",
"SecretNo": "1705552****",
"SubsId": "100011****464511"
},
"Message": "OK",
"RequestId": "4A2568E1-7D83-5491-8DEF-600D8AFF97E7",
"Code": "OK"
}
}
}