规范说明

1.通信协议

​ HTTP/HTTPS协议。

2.字符编码

所有接口的请求和响应数据编码皆为UTF-8。

3.API请求结构

名称	描述	备注
API入口	具体API接口地址	如 http://api.xx.xx/xxx
公共参数	每个接口都包含的通用参数	详见公共参数说明
私有参数	每个接口特有的参数	详见每个API接口定义

4.响应公共字段

所有接口响应值采用json格式，如无特殊说明，每次请求的返回值中，都包含下面字段：

参数名称	类型	描述
code	Number	接口调用状态，0：正常；其他值：调用出错，返回码见各接口对应
success	Boolean	接口调用标志位，true或false
msg	String	结果说明，如果接口调用出错，那么返回错误描述；成功返回sucees
data	数组或对象	接口返回结果，各个接口自定义，若为空标识返回正常，返回数据结构请参考具体文档说明
traceId	String	单次请求的唯一id，用于故障定位