更新时间:2022-03-11 GMT+08:00
分享

Python SDK使用说明

操作场景

使用Python语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。

前提条件

  • 已获取API的调用信息,具体请参见开发准备
  • 已安装开发工具和Python开发语言环境,具体请参见开发准备

    Python安装完成后,在命令行中使用pip安装“requests”库。

    pip install requests

    如果pip安装requests遇到证书错误,请下载并使用Python执行此文件,升级pip,然后再执行以上命令安装。

  • 已在IntelliJ IDEA中安装Python插件,如果未安装,请按照图1所示安装。
    图1 安装Python插件

获取SDK

登录ROMA Connect实例控制台,在“服务集成 APIC > API调用”页面中下载SDK。解压后目录结构如下:

名称

说明

apig_sdk\__init__.py

SDK代码

apig_sdk\signer.py

main.py

示例代码

backend_signature.py

后端签名示例代码

licenses\license-requests

第三方库license文件

新建工程

  1. 打开IDEA,选择菜单“File > New > Project”。

    弹出“New Project”对话框,选择“Python”,单击“Next”。

    图2 New Project
  2. 再次单击“Next”,弹出以下对话框。单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。
    图3 选择解压后的SDK路径
  3. 完成工程创建后,目录结构如下。
    图4 新建工程的目录结构

    “main.py”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例

调用API示例

  1. 在工程中引入apig_sdk。
    from apig_sdk import signer
    import requests
  2. 生成一个新的Signer,输入集成应用的Key和Secret。
    sig = signer.Signer()
    sig.Key = "4f5f626b-073f-402f-a1e0-e52171c6100c"
    sig.Secret = "******"
  3. 生成一个Request对象,指定方法名、请求uri、header和body。
    r = signer.HttpRequest("POST",
                           "https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1",
                           {"x-stage": "RELEASE"},
                           "body")
  4. 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。

    X-Sdk-Date是一个必须参与签名的请求消息头参数。

    sig.Sign(r)
  5. 访问API,查看访问结果。
    //若使用系统分配的子域名访问https请求的API时,需要在data=r.body后添加“,verify=False”,用来忽略证书校验
    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)
分享:

    相关文档

    相关产品

close