Skip to content

环境与凭据

环境地址

环境API授权页用途
测试https://rpa-test-api.xiaowu005.xyzhttps://rpa-test-auth.xiaowu005.xyz开发联调、签名验证、异常场景测试
生产https://rpa-api.xiaowu005.xyzhttps://rpa-auth.xiaowu005.xyz正式业务调用

健康检查:

bash
curl -s https://rpa-test-api.xiaowu005.xyz/health
curl -s https://rpa-api.xiaowu005.xyz/health

切环境只换两样东西

从测试切到生产只替换域名和凭据。接口路径、请求 Schema、签名算法完全一致, 不需要改任何业务代码分支。

凭据

凭据用途存放位置
API KeyX-Channel-Key 请求头客户服务端环境变量 / 密钥管理服务
Callback Secret计算请求签名、验证回调签名、派生 SM4 密钥都靠它同上
渠道编码数据接口请求体的 channelCode可作为普通配置

Callback Secret 承担三重职责,泄露后果比 API Key 更严重:

  1. 计算 X-Channel-Signature(V2 接口与开启强制签名的数据接口);
  2. 校验平台回调的 X-RPA-Signature
  3. 当订单启用 output_encryption=SM4 时,派生 SM4 密钥。

隔离要求

  • 测试与生产使用各自独立的 API Key 和 Callback Secret,不得混用。
  • 两个环境的订单与数据相互隔离;正式上线后需在生产环境重新创建业务订单。
  • 凭据不得出现在前端代码、移动端包体、日志、监控标签或工单附件中。

请求约定

项目要求
POST 请求体JSON,Content-Type: application/json; charset=utf-8
V1 普通接口携带 X-Channel-Key
V1 数据接口至少 X-Channel-Key;渠道启用强制签名时还需时间戳、Nonce、签名
V2 发票接口必须同时携带 Key、时间戳、Nonce、HMAC 签名
状态查询优先接收回调;轮询间隔 15–30 秒
时间字段ISO 8601(UTC);签名时间戳为 Unix 秒

回调与返回地址的配置

callback_urlsuccess_urlexit_url 三个地址会经过平台安全校验:

  • 必须是完整的公网 HTTPS 地址;
  • success_urlexit_url 不得指向平台自身的管理端或授权入口;
  • 未在请求中传入时,使用渠道在平台后台配置的默认值。

联调前把测试回调地址与返回地址提供给平台配置;正式上线前再配置生产地址。

联调建议

  1. 在测试环境完成授权创建、页面跳转、结果通知、状态查询、数据获取的全流程。
  2. 覆盖成功、处理中、失败、重复回调、签名错误、链接过期六类场景。
  3. 测试环境可使用模拟数据,也可在取得企业授权后使用真实数据 —— 使用真实账号时必须落实账号、密码与业务数据的安全保护。
  4. 生产上线前,在生产环境用一笔真实订单完成端到端验证。

适配平台 1.5.3 · 接入指南、接口参考、字段字典与税局状态统一入口。