枢谷 - 接口规范文档

写在最前：

  1. 全站https；
  2. 非特殊请求全部统一采用 POST 请求方式；
  3. 统一数据结构（返回和提交），均采用JSON格式；
  4. 数据返回时，字段命名统一以小写开头驼峰命名；
  5. 日期格式提交是统一是字符串格式，返回时候为统一格式yyyy-MM-dd HH:mm:ss；
  6. 服务端返回的时间统一是北京时间，部分需要精确到毫秒的业务的时间字段协商返回时间格式为：yyyy-MM-dd HH:mm:ss；

请求公共参数（ClientSystemInfo）每次提交接口时，都请提交的参数；请将此字段置于命名为 的HTTP Header信息中

返回数据结构

字段类型 参数名 类型 取值范围 说明
系统 status int 取值点我（ResultStatus） 请求处理的状态
系统 msg String 当status不为 200 时，针对status code的说明信息
系统 t string 记录的返回时间的服务器时间
系统 dateTime DateTime 记录的返回时间
系统 server string 服务器实例
系统 sign string 业务数据的数字签名，用于判断业务数据是否有变化
业务 data 不固定，随实际业务而定 返回的业务字段，这个是接口使用者关心的业务部分

ResultStatus

数字 枚举值定义（英文） 释义说明
0 Unknown Unknown
200 Succ 成功
201 Fail 失败
202 Exception 异常
203 Unauthorized 未授权
204 InvalidPath 非法路径
205 Unauthenticated 未认证
304 NotModified 未修改
400 Error 内部错误
405 DecryptFail 解密失败
406 DeserializeFail 反序列化错误