1.基本约定
1.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
2.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。
{
"uri" : "/intf/albums-by-type.jsp",
"error-desc":"Need you follow uid.",
"user-notice":"给用户的提示放在这里"
}
3.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部,实现类似下面的代码:
String queryString = request.getQueryString();
String requestEncoding = getParam(queryString,"req_enc");
String responseEncoding = getParam(queryString,"resp_enc");
if(isNotBlank(requestEncoding)){
request.setCharacterEncoding(requestEncoding);
}
if(isNotBlank(responseEncoding)){
response.setCharacterEncoding(responseEncoding);
}
4.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。
5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。
2.接口列表
2.1 新消息
url: /newMsgCount
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{ "newMsgCount": 2000 }
newMsgCount:新消息的数量,当该数值超过五位数时,只返回99999。新消息是指汽车论坛的站内信,不包括认证失败的消息。
2.2/ 我的帖子
url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/post?personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d
论坛app:pcautobbs
电脑网app:命名前缀pconline
汽车网app:命名前缀pcauto
请求方式:get
是否需要登录:是
请求参数:
pageNo:页数 persionName:用户名 common_session_id:用户登陆后获得的认证id pageSize:每页条数
时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60
分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于
48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日”
例子:
{
"pageNo":1, //页码
"pageSize":20, //每页条数
"topicList":[ /
{/每条的数据
"createTime":123, //创建时间,见时间规则
"flag":"精", //是否为精,图等
"replyCount":6175,//回复数
"view":195872,//阅读数
"floor":812,//楼层数
"title":"三两下root好并精简你的三星I9100",//标题
"topicId":13597147, // 帖子id
"uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url
}
],
"total":12 //一共多少条
}
2.3 我的回复
url: http://mrobot.pcauto.com.cn/v4/individualcenter/reply? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d
论坛app:pcautobbs
例子:
请求方式:get
是否需要登录:是
请求参数:
时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60
分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于
48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日”
pageNo:页数 persionName:用户名 common_session_id:用户登陆后获得的认证id pageSize:每页条数
例子:
{
"pageNo":1, //页码
"pageSize":20, //每页条数
"topicList":[ /
{/每条的数据
"createTime":123, //创建时间,见时间规则
"floorIndex":812,//评论所属的楼层
"title":"三两下root好并精简你的三星I9100",//标题
"replyContent":"回复内容为9", //回复内容
"topicId":13597147, // 帖子id
"uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url
}
],
"total":12 //一共多少条
}
2.4 最新消息
url: http://mrobot.pcauto.com.cn/v4/individualcenter/news? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d
论坛app:pcautobbs
例子:
请求方式:get
是否需要登录:是
请求参数:
pageNo:页数 persionName:用户名 common_session_id:用户登陆后获得的认证id pageSize:每页条数
时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60
分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于
48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日”
{
"pageNo":1, //页码
"pageSize":20, //每页条数
"topicList":[ /
{/每条的数据
"createTime":123, //创建时间,见时间规则
“tag”:”postReplay” //包括''system”,”stationMail”,”postReplay” 三种类型
"content":"三两下root好并精简你的三星I9100", //内容,三者都有
"uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //url
“username”:”haha” //postReplay,stationMail 中的用户名
“useId”: 12314212 //postReplay,stationMail 中的用户id
“postTitle”: “给力三星I9100” //postReplay中的帖子标题
“floorIndex”: 3 //postReplay中的回帖的楼层数
"topicId":13597147, // postReplay帖子id
}
],
"total":12 //一共多少条
}
2.5 头像修改
url : url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/saveavatar"
论坛app:pcautobbs
请求方式:post
是否需要登录:需要
请求参数:
name:用户名
image:用户头像数据
common_session_id:会话id
2.6 /同步内容下载
url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/favorite/download?personname=%@&common_session_id=%d?
论坛app:pcautobbs
电脑网:命名前缀pconline
汽车网:命名前缀pcauto
例子:
请求方式:get
是否需要登录:是
请求参数:
persionName:用户名 common_session_id:用户登陆后获得的认证id
注:车型,车系为汽车网客户端独有,其他2个是三个都有
例子:
{
"chexing":{ //车型
“count”:12, //数组数量
“list”:[
{
“id”:1234, //车型id
“name”:”宝马”, //车型名字
“image”:http://mrobot.pcauto.com/baoma.jpg, //车型小图url
“price”:35.23 //车型价格
},
{
“id”:1234, //车型id
“name”:”宝马”, //车型名字
“image”:http://mrobot.pcauto.com/baoma.jpg, //车型小图url
“price”:35.23 //车型价格
}
]
},
“chexi”:{ //车系
“count”:12, //数组数量
“list”:[
{
“id”:1234, //车系id
“name”:”宝马3系”, //车系名字
“image”:http://mrobot.pcauto.com/baoma3.jpg, //车系小图url
“price”:35.23 //车系价格
},
{
“id”:1234, //车系id
“name”:”宝马”, //车系名字
“image”:http://mrobot.pcauto.com/baoma.jpg, //车系小图url
“price”:35.23 //车系价格
}
]
},
“luntan”:{ //论坛
“count”:12, //数组数量
“list”:[
{
“id”:1234, //论坛id
“name”:”宝马”, //论坛名字
},
{
“id”:1234, //论坛id
“name”:”宝马”, //论坛名字
}
]
},
“tiezi”:{ //帖子
“count”:12, //数组数量
“list”:[
{
“id”:1234, //帖子id
“name”:”宝马3系太好了”, //帖子标贴
},
{
“id”:1234, //帖子id
“name”:”宝马3系太好了”, //帖子标贴
}
]
}
}
2.7/ 同步内容上传
url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/favorite/update?personname=%@&common_session_id=%d?
论坛app:pcautobbs
电脑网:命名前缀pconline
汽车网:命名前缀pcauto
例子:
请求方式:post
是否需要登录:是
请求参数:
persionName:用户名 common_session_id:用户登陆后获得的认证id
注:车型,车系为汽车网客户端独有,其他2个是三个都有
例子:
{
"chexing":{ //车型
“addlist”:[123121,1111,2222,3333,566788], //新增车型id数组
“delete”:[12356,6666,5555,32145], //删除车型id数组
}
“chexi”:{ //车系
“addlist”:[123121,1111,2222,3333,566788], //新增车系id数组
“delete”:[12356,6666,5555,32145], //删除车系id数组
},
“luntan”:{ //论坛
“addlist”:[123121,1111,2222,3333,566788], //新增论坛id数组
“delete”:[12356,6666,5555,32145], //删除论坛id数组
},
“tiezi”:{ //帖子
“addlist”:[123121,1111,2222,3333,566788], //新增帖子id数组
“delete”:[12356,6666,5555,32145], //删除帖子id数组
}
}