OpenAPI 接口文档
OpenAPI 接口文档

响应结构

当请求到达 Open API,且由 Open API 正常生成响应时,业务成功和业务失败均返回 HTTP 200。调用方必须解析 JSON 并根据 code 判断结果。

传输层异常

HTTP 200 约定不覆盖请求或响应在传输途中发生的故障。DNS 解析失败、TLS 建连失败、连接中断,以及 CDN、网关、WAF 或网络代理返回的异常,都可能表现为非 200、非 JSON 或空响应。调用方不得把这些结果判定为业务成功。

如果响应中存在 X-TRACE-ID,应保存该值;如果没有可用的追踪编号,应至少保存请求时间、请求路径和调用方自己的请求记录。后续处理应区分操作类型:

  • 对 GET 等读取操作,可在网络恢复后重新发起查询。
  • 对 POST、PATCH 等写操作,传输失败不能证明请求没有生效。带 request_no 的创建操作不得使用原请求号或新请求号盲目重提,应先通过已有查询核对,并遵循请求号与重复提交;其他写操作应先查询当前状态,再决定是否继续处理。

成功响应

{
  "code": 0,
  "msg": "success",
  "data": {},
  "next": null
}
字段 类型 说明
code integer 0 表示成功;非 0 表示失败
msg string 成功时固定为 success;失败时为与 X-LANG 对应的结果说明
data object、array 或 null 接口返回的数据;失败时为 null
next string 或 null 预留字段,当前版本固定为 null

X-LANG 不改变成功响应的 msg,只影响失败文案和可翻译的 data 字段。

失败响应

{
  "code": 400009,
  "msg": "The request parameters are invalid.",
  "data": null,
  "next": null
}

HTTP 200 不代表业务成功。JSON 解析失败、响应字段缺失或 code 未知时,不要把请求记为成功;保存响应头中可获得的 X-TRACE-ID 后进入异常处理流程。

分页响应

分页接口的 data 使用统一结构:

{
  "list": [],
  "total": 0,
  "page_no": 1,
  "page_size": 20
}

分页规则见分页规则

On this page