请求参数说明
本文档中若无特殊说明,对于 GET``POST请求,参数传递的定义如下:
- 无论哪种请求,若url格式形如
https://xxx.com/<value>/...则其中的<value>字段需要替换为该字段对应的数据.
- 无论哪种请求,若url格式形如
- 对于
GET请求,请求参数通过?key1=value&key2=value形式传递
- 对于
- 对于
POST请求,请求参数通过json请求传递
- 对于
响应参数说明
接口若无特殊说明,所有响应参数均为json格式,并伴随一个代表响应状态的http状态码.
对于http状态码不为200的请求,必定伴随一个error字段,说明异常的原因
常见的http状态说明如下
| 状态码 | 说明 |
|---|---|
| 200 | 处理成功 |
| 401 | 请求参数不是预期值 |
| 403 | 登录过期或未登录,此时需要去登录 |
| 500 | 未知异常 |
登录相关
本模块下的接口文档若无特殊说明,均需要在登录状态下调用
