接入指南

当前 API 仅支持 http 调用,暂不支持 https,所以最佳的调用方式是通过服务端代码进行调用,不建议在浏览器端进行直接调用。

接口鉴权

接口需要鉴权,通过 HTTP 的 Authorization 字段传递 token 进行鉴权,token 的获取可以参考获取和使用 Token,即在接口请求的 http header 中包含 Authorization: Bearer <Your Token>

HTTP Code

所有接口在能被顺利访问的情况下都返回 200 HTTP Code,这仅表示接口被顺利调用,但是不能代表此次调用按预期完成了一次事务。

接口调用是否按预期工作是根据返回的 HTTP Body 中的 code 字段来定义的,详情见下文

通俗地说,接口能被访问即返回 200,但是进一步的消息需要查看 Response Body 中的 code 字段,如果因为各种原因导致接口访问受阻,则不会返回 200

Response Body Code

在接口返回 200 HTTP Code 的情况下,我们需要查看 Response Body 来进一步确定接口调用是否符合预期,Body 中有一个 code 字段:

{
  "code": 0, // 整数,0 表示正常,非 0 表示异常
  "msg": '', // 字符串,接口有异常的时候通过该字段指明原因
  "foo": bar // 其他数据字段
}
  • 符合预期的情况
    如果接口调用是符合预期的,事务被正常地完成,那么接口返回的 Response Body 中 code 字段必然为 0

  • 异常情况
    如果接口能访问到,但是因为各种原因不能如预期实现事务,那么接口返回的 Response Body 中必然有两个字段,一个是 code,值为非 0,另一个是 msg,指明了异常原因。
    全局的 code 返回值及其含义见列表全局错误码

上次修改: 2019-07-12 16:59