基本规则

基本信息

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

请求时不应忽略服务器证书验证的错误，避免被恶意劫持。

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

API使用 JSON (opens new window)作为消息体的数据交换格式。请求须设置HTTP头部（图片上传API除外）：

Content-Type: application/json  
Accept: application/json

提示
API应答中的数据有可能包含传入的数据，即可能是未经检查的用户输入内容。为了避免XSS（Cross-site scripting）攻击，请调用方在使用应答数据前根据场景做适当的转义或者过滤。

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

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

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

新的API版本可能在请求或应答中加入新的参数或者JSON的键值对

新的API版本不会去除请求和应答中已经存在的必填参数或者JSON的键值对

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

API仅支持UTF-8字符编码的一个子集：使用一至三个字节编码的字符。也就是说，不支持Unicode辅助平面中的四至六字节编码的字符。

yyyy-MM-DDTHH:mm:ss.SSSZ
yyyy-MM-DDTHH:mm:ssZ
yyyy-MM-DDTHH:mm:ss.SSS+08:00
yyyy-MM-DDTHH:mm:ss+08:00

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

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

已经被成功接受待处理的请求，将返回202；

请求处理失败时，如缺少必要的入参，将会返回4xx范围内的错误码；

请求处理时发生了API侧的服务系统错误，将返回500/501/503的状态码。

HTTP协议要求发起请求的客户端在每一次请求中都使用HTTP头User-Agent来标识自己。建议调用方选用以下两种方式的一种：

① 使用HTTP客户端默认的User-Agent。
② 遵循HTTP协议，使用自身系统和应用的名称和版本等信息，组成自己独有的User-Agent。

API很可能会拒绝处理无User-Agent的请求。