Open API基于HTTP,在开始上手前,请先了解基本的HTTP约定。

HTTP请求

HTTP应答

状态码(status)

根据实际情况会返回如下状态码之一

  • 400 发生在任意接口。
  • 403 发生在获取access token时。
  • 404 发生在访问不在本文范围内的接口。
  • 429 发生在任意接口。
  • 200

头部字段(header)

为支持跨域访问,HTTP应答包含了如下头部字段:

Access-Control-Allow-Methods:GET,POST,DELETE,OPTIONS
Access-Control-Allow-Origin:*

除开个别直接下载文件的接口,绝大部分HTTP应答消息体为UTF-8编码json数据。

Content-Type:application/json

消息体(body)是不可缓存的

Cache-Control:no-cache

消息体(body)

本节内容只对状态码为200时有效

通用格式为:

{
    "err":"ok",
    "data":{"id":"12345678"}
    //[其他字段]
}

该数据(下文称为resp)必然有errdata这两个字段。是否成功由err是否为”ok”来指定。
若err为”ok”,则data类型为Object或者Array,用来表示成功获取到的数据;失败的情况下data应当被忽略。
data数据块中没有类型为int或number,都用string代替,例如上文中的”id”为”12345678”而非12345678。

resp中也可能包含其他字段。在接口手册中有详细说明。

文档更新时间: 2019-01-16 17:06   作者:Gocloud