返回结果
调用 API 服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回 4xx 或5xx的HTTP状态码代表调用失败。调用返回的数据格式为Json。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
返回成功
HTTP/1.1 200 OK
Date: Tue, 28 Aug 2018 06:33:44 GMT
Content-Type: application/json
{
"KEY1": "VALUE1",
"KEY2": "VALUE2"
}
时间格式
所有返回的时间类型使用UTC(世界标准时间)时间,用ISO8601进行格式化:
YYYY-MM-DDTHH:MM:SS.MMMZ
错误结果
调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。
授权API:
HTTP/1.1 400 Bad Request
Date: Tue, 28 Aug 2018 06:33:44 GMT
Content-Type: application/json
{
"error": "ERROR",--错误代码
"error_description": "ERROR_DESCRIPTION"--错误信息
}
其它API:
HTTP/1.1 400 Bad Request
Date: Tue, 28 Aug 2018 06:33:44 GMT
Content-Type: application/json
{
"Code": "CODE",--错误代码
"Message": "MESSAGE",--错误信息
}