API规范

目前此套API使用OAuth2接入用户账号

API返回格式均为JSON,除非服务器或者网络故障,请求的HTTP status均为200,一些特殊情况也会返回其他status

Token传递方式

1.设置HTTP header, 格式为Authorization: Bearer TOKEN

2.在query string里传递,https://api.shanbay.com/endpoint/?access_token=TOKEN

3.在post请求的body里传递

API访问频次

单个用户  2000次/小时
一个用户通过一个应用 200次/小时

API返回结果示例:

{
    "msg":"SUCCESS",
    "status_code":0,
    "data": {}
}

API返回字段说明:

msg: 提示信息,成功为SUCCESS,否则返回错误的提示信息
status_code: 参见错误代码说明
data: 请求返回的数据,可能是一个object 或者object的一个array

错误代码 status_code

0        success
1        failed
400      bad request        (请求数据有问题)
401      forbidden          (权限不够)
404      not found          (请求资源不存在)
409      duplicated         (重复创建资源)

HTTP status

200       ok                (请求成功返回)
401       unauthorized      (用户未登录,或者token过期)
429       too many requests (请求次数过多)