-
Notifications
You must be signed in to change notification settings - Fork 12
API说明 总体
Hstb edited this page Aug 28, 2017
·
1 revision
为了减少不必要的数据处理,插件强制要求使用POST
方法调用API接口,而且必须将参数组合成 JSON
数据格式 提交。
所有API均需要提交参数fun
,值为该API的英文描述名
提交的参数区分大小写,没有给出参数默认值时,表示该参数不可空
如果开启了 数据校验 功能,请注意额外提交authTime
和authToken
这两个检验参数,具体说明请参考「提交说明 - 校验参数说明」
对于任意请求:
- 200:表示成功调用了API,但不能保证调用结果是正确的
- 403:表示缺少API所需信息
- 404:表示调用了不存在的API
- 405:表示使用了接口不支持的协议,如
GET
,HEAD
- 406:表示提交的数据非支持的数据格式,如
XML
如果使用了 数据校验 功能,在出错的情况下会返回以下状态码
- 401:表示缺少校验参数,或传递的参数有误
- 408:表示该请求超过有效时间
响应数据为JSON格式:
{
"status":0,
"errMsg":"",
"result":"",
"request":{
"fun":"xxx"
}
}
字段说明:
字段名 | 数据类型 | 说明 |
---|---|---|
status |
int | 状态码,0 表示成功,非0 表示失败 |
errMsg |
string | 错误原因,只在status 为负值时出现 |
result |
string /array /object
|
执行结果,部分API的返回值不存在此字段 |
request |
string /object
|
本次请求内容,方便排查错误 |
-
status
只有-400
~-600
之间的值为接口错误码,并请会在errMsg
中返回错误原因;非此返回的错误码为酷Q错误码,请参考「官方文档」 - API说明中将不再描述
status
,errMsg
与request
字段信息 - 若字段名为
a.xx
格式,则表示这是一个子属性