接口规则

基本规则

所有的 API 请求必须使用 HTTPS 。

请按照接口加签说明要求生成请求签名，请务必在服务端完成签名生成。

调用方每次发起调用时，都需使用 User-Agent HTTP 请求头来标识自己，平台会拒绝处理无 User-Agent 的请求

数据格式

平台 API 使用 JSON 作为消息体的数据交换格式。请求须设置 HTTP 头部：

参数兼容性

请求是否成功，与请求参数的顺序无关。

请求是否成功，与请求 JSON 中的键值对出现的顺序无关。

处理应答时，不应假设应答 JSON 中的键值对出现的顺序。

当请求或应答中的 JSON 键值对的值为空（null）时，可以省略。

错误信息

平台 API 使用 HTTP 状态码来表示请求处理的结果。

处理成功的请求，如果有应答的消息体将返回200。

请求处理失败时，如缺少必要的入参、签名错误等，将会返回400范围内的错误码。

请求处理时发生了平台方的服务系统错误，将返回500的状态码。这种情况比较少见。

错误码与错误提示

当请求处理失败时，除了 HTTP 状态码表示错误之外，API 将在消息体返回错误相应说明具体的错误原因。
code：接口错误码。
message：错误描述，使用易理解的文字表示错误的原因。

User Agent

HTTP 协议要求发起请求的客户端在每一次请求中都使用 HTTP 头 User-Agent 来标识自己。平台建议应用方选用以下两种方式的一种：
1.使用 HTTP 客户端默认的 User-Agent 。
2.遵循 HTTP 协议，使用自身系统和应用的名称和版本等信息，组成自己独有的 User-Agent。
平台 API 会拒绝处理无 User-Agent 的请求

基本规则#

数据格式#

参数兼容性#

错误信息#