Skip to content

接口定义规范

tangtaiming edited this page Sep 5, 2016 · 3 revisions

【API接口规范】

  1. 返回的json,数据存放在data下。
  2. 同一个界面尽量一次请求获取,特殊的除外
  3. 相同含义的属性必须用相同的名称
  4. 时间统一采用string类型返回
  5. 接口说明及时更新到wiki,wiki说明包括:接口名称[请求方式]--开发人员,参数说明,接口地址、测试地址、返回结果示例、返回结果字段说明

【调用api说明】

首先必须要与服务器建立握手,握手请求协议参数为列表中的参数,握手成功后服务器会返回一个token,作为与服务器通信的密钥,以后每次调用服务器接口必须在http协议的请求头部设置次密钥。

1.握手接口【GET】--by tc

参数名称 参数值 参数类型 可否为空 备注说明
手机平台 flat int 1)android 2)ios 3)wp
系统版本 sys_vs String 如android4.4 ,android3.0等
当前版本 cur_vs String 版本从1.0开始
app版本 cur_code String 版本从1.0

接口地址

  1. 生产环境:https://xxxx/handshake

##返回结果 {"re":1,"msg":"success","token":"e4a6f67450af440aa6f67450af740aea"}

结果集说明

| 参数名称 | 参数类型| 备注说明| | -------------|:-------------:|:-------------: |:-------------:| -----:| | re | int| 状态码,[1:成功,-1:失败]| | msg | string| 服务器消息| | token| string| 密钥|