文档首页 > > API签名指南> 签名SDK与demo> Python

Python

分享
更新时间: 2019/09/07 GMT+08:00

本节以IntelliJ IDEA工具为例,介绍如何在Python环境中集成API请求签名的SDK。您可以直接导入示例工程体验,然后参考调用说明部分将签名SDK集成到您的应用中。

准备环境

  • 获取并安装IntelliJ IDEA,可至IntelliJ IDEA官方网站下载。
  • 获取并安装Python安装包(可使用2.7.9+或3.X,包含2.7.9),可至Python官方下载页面下载。
    Python安装完成后,在命令行中使用pip安装“requests”库。
    pip install requests
    说明:

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

  • 在IDEA中安装Python插件,如下图所示。

获取SDK

请访问https://obs.cn-north-1.myhuaweicloud.com/apig-sdk/APIGW-python-sdk.zip下载SDK。

下载“APIGW-python-sdk.zip”压缩包,解压后目录结构如下:

名称

说明

apig_sdk\__init__.py

SDK代码

apig_sdk\signer.py

main.py

示例代码

licenses\license-requests

第三方库license文件

示例工程导入

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

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

  2. 再次单击“Next”,弹出以下对话框。单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。

  3. 完成工程创建后,目录结构如下。

请求签名与API调用

  1. 在命令行中,使用pip安装“requests”库。

    1
    pip install requests
    

  2. 在工程中引入apig_sdk。

    1
    2
    from apig_sdk import signer
    import requests
    

  3. 生成一个新的Signer,填入AK和SK。

    1
    2
    3
    4
    sig = signer.Signer()
    # Set the AK/SK to sign and authenticate the request.
    sig.Key = "QTWAOY********VKYUC"
    sig.Secret = "MFyfvK41ba2giqM7**********KGpownRZlmVmHc"
    

  4. 生成一个新的Request,指定域名、方法名、请求uri和body。

    以下示例,HTTP方法为 GET,域名(Endpoint)为 service.region.example.com,请求URI为VPC的一个查询VPC列表接口URI: /v1/77b6a44cba5143ab91d13ab9a8ff44fd/vpcs?limit=1
    1
    2
    3
    # The following example shows how to set the request URL and parameters to query a VPC list.
    r = signer.HttpRequest("GET", "https://service.region.example.com/v1/77b6a44cba5143ab91d13ab9a8ff44fd/vpcs?limit=1")
    # r.body = "{\"a\":1}"
    

  5. 添加需要签名的请求消息头,或者其他用途的头域,如多项目场景中添加X-Project-Id,或者全局服务场景中添加X-Domain-Id。如果添加多个请求消息头,使用英文逗号分隔。

    1
    r.headers = {"content-type": "application/json"}
    

  6. 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。

    1
    sig.Sign(r)
    

  7. 访问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)
    

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区