主要调整与说明:

  1. 统一数据结构(返回和提交);
  2. 数据返回时,字段命名统一以小写开头;
  3. 日期格式统一以字符串形式传输(返回和提交);
  4. 参数业务意义如果是简单类型的列表,那么其分隔符可适用'-'、'&'任选其一;
  5. 原接口返回的对象的属性进行部分精简,针对性的保留重要的属性;

公共参数(提交时) 每次提交接口时,都请提交这些参数;业务参数请务必不要与这些参数重名;

参数名(QueryString中) 全名 取值范例 说明
model iPhone4,1 / iPhone5,2 / iPhone7,1 / x86_64 平台
ov Operation System Version 8.3 操作系统版本
cid ClientId Youloft_Android
av AppVersion 4.2.6
mac MAC地址 00:11:22:33:44:55
idfa IDFA iOS下所取得的唯一物理地址标识
did DeviceId b622c089e7e14d2c2fa8c9129dafbb51
chn ChannelId wnl_anzhi
cc country CN
lang language zh
bd Bundle com.youloft.calendar
city city code 101040100 城市代码
height Height 分辨率高度
width Width 分辨率宽度
sigh 上一次请求结果的签名

所以,每一次请求都应该形如:

    
                http://localhost:3279/api/GetTopContent?tkn=2163E40782CAAB07394D2950FFD51CE0&cid=Youloft_Android&av=4.2.6&mac=00:11:22:33:44:55&did=b622c089e7e14d2c2fa8c9129dafbb51&chn=wnl_anzhi&cc=CN&lang=zh&bd=com.youloft.calendar&t=1430366273
            
        

公共结构 和以前一致的,数据返回依然采用Json格式;

参数名 类型 取值范围 说明
status int 见以下说明 请求处理的状态
msg String 针对Status属性的说明信息
t long 记录的返回时间的时间戳
dateTime DateTime 记录的返回时间
server String 服务器实例
Data 不固定,随实际业务而定 返回的业务字段,这个才是业务开发人员关心的部分

Status

数字 枚举值 对应类别
200 Succ 成功
201 Fail 失败
202 Exception 异常
203 Unauthorized 未授权
204 InvalidPath 非法路径
304 NotModified 未修改
9999 Unknown Unknown