更新时间:2024-10-09 GMT+08:00
Python
操作场景
使用Python语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。
本章节以IntelliJ IDEA 2018.3.5版本为例介绍。
前提条件
- 已获取API的调用信息,具体请参见认证前准备。
- 已安装Python安装包2.7.9或3.X版本,如果未安装,请至Python官方下载页面下载。
Python安装完成后,在cmd/shell窗口中使用pip安装“requests”库。
pip install requests
如果pip安装requests遇到证书错误,请下载并使用Python执行此文件,升级pip,然后再执行以上命令安装。
- 已安装IntelliJ IDEA 2018.3.5或以上版本,如果未安装,请至IntelliJ IDEA官方网站下载。
- 已在IntelliJ IDEA中安装Python插件,如果未安装,请按照图1所示安装。
获取SDK
请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。
获取“ApiGateway-python-sdk.zip”压缩包,解压后目录结构如下:
名称 |
说明 |
---|---|
apig_sdk\__init__.py |
SDK代码 |
apig_sdk\signer.py |
|
main.py |
示例代码 |
backend_signature.py |
后端签名示例代码 |
licenses\license-requests |
第三方库license文件 |
新建工程
- 打开IDEA,选择菜单“File > New > Project”。
弹出“New Project”对话框,选择“Python”,单击“Next”。
图2 Python
- 再次单击“Next”,弹出以下对话框。单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。
图3 选择解压后的SDK路径
- 完成工程创建后,目录结构如下。
图4 新建工程python的目录结构
“main.py”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
调用API示例
- 在工程中引入apig_sdk。
1 2 3
from apig_sdk import signer import requests import os
- 生成一个新的Signer,填入AppKey和AppSecret。
- 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
- 生成一个新的Signer,填入已设置的环境变量。
1 2 3
sig = signer.Signer() sig.Key = os.getenv('CLOUD_SDK_AK') sig.Secret = os.getenv('CLOUD_SDK_SK')
- 生成一个Request对象,指定方法名、请求uri、header和body。
1 2 3 4
r = signer.HttpRequest("POST", "https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1", {"x-stage": "RELEASE"}, "body")
- 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。
X-Sdk-Date是一个必须参与签名的请求消息头参数。
1
sig.Sign(r)
- 访问API,查看访问结果。
1 2 3
resp = requests.request(r.method, r.scheme + "://" + r.host + r.uri, headers=r.headers, data=r.body) print(resp.status_code, resp.reason) print(resp.content)
父主题: 使用APP认证调用API