响应结果


API 接口默认返回 JSON 数据,返回非 JSON 格式的接口会在文档中做出说明。返回 JSON 数据时最大限制为 10 MB,如果返回的数据超过最大限制,请求会失败并返回内部错误。

注意:目前只要请求被服务端正常处理了,响应的 HTTP 状态码均为200。例如返回的消息体里的错误码是签名失败,但 HTTP 状态码是200,而不是401。

正确返回结果

若调用成功,其可能的返回如下为:

{
    "status": true,
    "code": 200,
    "message": "Success",
    "data": {
        "content": "test"
    },
    "request_id": "91a31c6d-4f2f-49db-97e4-bbe9826017da"
}

request_id 是固定的字段,用于一个 API 请求的唯一标识,无论请求成功与失败,只要 API 处理了,则必定会返回。如果 API 出现异常,可以联系 在线客服 或 提交工单,并提供该 ID 来解决问题。

status (未来将废弃) 是固定字段,用于标注 API 处理结果,响应为布尔值, true-成功;false-失败。

code 响应代码 200为成功,其他均为失败。

message 用于描述 API 处理结果的说明信息。

data API 返回的结果对象。

错误返回结果

{
    "status": false,
    "code": 400,
    "message": "签名数据无效",
    "request_id": "91a31c6d-4f2f-49db-97e4-bbe9826017da"
}

code 表示具体出错的错误码,仅在 code 等于 200 的时候代表请求成功,当请求出错时可以先根据该错误码在公共错误码和当前接口对应的错误码列表里面查找对应原因和解决方案。

公共错误码

返回结果中如果存在 status 字段值等于 false,则表示调用 API 接口失败。 code 字段表示错误码,所有业务都可能出现的错误码为公共错误码。完整的错误码列表请参考本产品“API 文档”目录下的“错误码”页面。