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:
汽车网:待定
作用:获取头条数据
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
[{
"title":"首页", // 菜单标题
"controller":"PCInformationController", // 根控制器的名字
"url":"http://www.baidu.com" // 如果是如专栏之类的webview界面,会出这个链点;否则出空字符串
}]
2.2 默认订阅栏目
url:
汽车网:待定
作用:获取默认订阅的栏目
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
[{
"serialId":123, // 车系id
"serialName":"福特福克斯", // 车系名称
}]
2.3 头条
url:
汽车网:待定
作用:获取头条数据
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:
pageSize // 每页加载量,默认20条
pageNo // 页码
serialIds // 已经订阅的车系id
deviceId // 设备标识符
返回参数:
"pageNo":123,
"pageSize":20,
"total":300,
"contentList": [
{
"infoCount": 93, // 如果是文章则为评论数,如果是帖子则为楼层数,如果是图集则为图片张数
"contentId": 2965125, // 文章、帖子或者图集id
"objectId":2965125, // 聚合了文章、帖子和图集的对象id,赞/踩用到的数据,不确定三个类型能否聚合在一起
"type":"", // 类型,目前包含article, album和topic三个值
"image": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg", //导读图
"title": "[直播]成都车展探馆:奥迪RS5 Coupe亮相", //内容标题
"channel":"所属栏目" // 所属栏目
"judged":1 // 1表示该设备已经赞踩过该对象,0表示还没有
},
...
],
"focusList":[
{
"image:":"http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",
"contentId":111111 // 同上
"objecetId": 111111 // 同上
}
]
2.4 车系聚合页
url:
汽车网:待定
作用:获取头条数据
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:
pageSize // 每页加载量,默认20条
pageNo // 页码
返回参数:
"pageNo":123,
"pageSize":20,
"total":300,
"contentList": [
{
"infoCount": 93, // 如果是文章则为评论数,如果是帖子则为楼层数,如果是图集则为图片张数
"contentId": 2965125, // 文章、帖子或者图集id
"objectId":2965125, // 聚合了文章、帖子和图集的对象id,赞/踩用到的数据,不确定三个类型能否聚合在一起
"type":"", // 类型,目前包含article, album和topic三个值
"image": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg", //导读图
"title": "[直播]成都车展探馆:奥迪RS5 Coupe亮相", //内容标题
"channel":"所属栏目" // 所属栏目
},
...
],
"focusList":[
{
"image:":"http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",
"contentId":111111 // 同上
"objecetId": 111111 // 同上
}
]
2.5 赞和踩
url:
汽车网:待定
作用:对某个对象赞或者踩
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:否
请求参数:
objectId,对象id
deviceId,设备标识符
action,up或者down,分别代表赞和踩
返回参数:
{
"resultCode":0 // 0表示成功,其他是失败
"message":"提示信息" // 提示信息
}
2.6 搜索行情文章
url:
汽车网:待定
作用:点击文章终端的车系按钮,出该车系的行情文章
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:
serialId或者serialName,车系id或者车系名字,根据快搜接口的要求而定
cityName,城市名字
返回参数:
参考3.6.0的栏目接口 http://mrobot.pcauto.com.cn/v2/cms/channels/2
2.7 新消息
url:
汽车网:待定
作用:获取个人中心的新消息的数量(系统消息和短消息)
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
返回参数:
{
"systemNoticeCount": 0, //系统消息数
"messageCount": 0, // 短消息数
"fansCount": 0 //新粉丝数
}