应用 API 协议
开发者接入开放平台OpenAPI,调用API必须遵循以下规则:
| 参数 | 说明 |
|---|---|
| 正式环境网关 | https://openapi.sceneopen.com |
| 测试环境网关 | https://openapi.test.sceneopen.com |
| 传输方式 | HTTPS |
| 请求方式 | POST |
| 请求格式 | application/json |
| 响应格式 | application/json |
| 内容编码 | UTF-8 |
| 签名算法 | SHA |
| 签名要求 | 请求和接收数据均需要校验签名,详细方法请参考签名方法 |
注意
所有的 API 请求必须通过 HTTPS 发送,使用 HTTP 会被服务器拒绝。
📄️ 公共参数
请求的公共参数
📄️ 签名方法
为了防止API调用过程中被恶意篡改,调用任何一个API都需要携带签名
📄️ 验签方法
为了防止API返回过程中被恶意篡改,调用方需对返回值做签名验证,并解密获取到返回值内容
📄️ 应用回调说明
* 由平台通过HTTP的方式回到给开发者,在使用前请保证已经配置了应用的回调地址,或者接口中上送了回调地址。
📄️ 应用AESKey说明
AESKey是AES加密的密钥,用于加密数据: 一般用于以下场景API回调参数解密;详细参见 回调说明。
📄️ 错误码
服务端的错误码