跳到主要内容

端点包

端点包是一组 Python 脚本,IaaS API 的每个调用对应一个脚本,并按本文档的相同章节组织。每个脚本都会构造 API-CLIENT-KEY 和 AUTHORIZATION header、发送请求,并打印状态码和响应。适合正在集成、希望在 Sandbox 中测试某个调用而不必从零编写签名逻辑的开发者。

下载端点包(.zip)

配置​

  1. 安装依赖:pip install -r requirements.txt。

  2. 在端点包根目录将 .env.example 复制为 .env,并填写:

    变量说明
    BASE_URL您的角色及环境对应主机的 Base URL。参见环境(主机)。
    API_KEY您集成的 API key。
    PRIVATE_KEY_PATH私钥 .pem 文件的路径。
    ALGORITHM您密钥的算法:RSA 密钥使用 RS256;EC P-256、P-384 或 P-521 密钥分别使用 ES256、ES384 或 ES512。密钥交换中的 EC P-521 密钥使用 ES512。
  3. 打开脚本,替换标记为 <...> 的值后运行。建议从 5.1 - Primeiros passos/5.1 - GET Teste de autenticação.py 开始。

API key 只在您所属角色的主机上有效

并非每个调用都在所有主机上提供。每个脚本的头部列出了提供该调用的主机,端点包中的 README.md 按文件夹给出了对照表。发往其他角色主机的调用会被拒绝并返回 Invalid API Key。

重要提示!

脚本中使用的是虚构的 CPF 和 CNPJ。请勿在 Sandbox 中使用真实的自然人或法人数据。