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:
汽车网:类似http://mrobot.pcauto.com.cn/v2/cms/channels/1,头条的话是1,车系聚合页是0。
作用:获取头条数据
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:
pageSize // 每页加载量,默认20条
pageNo // 页码
serialIds // 已经订阅的车系id,逗号分割
返回参数:
"pageNo":123,
"pageSize":20,
"total":300,
"contents": [
{
"count": 93, // 如果是文章则为评论数,如果是帖子则为楼层数,如果是图集则为图片张数
"id": 2965125, // 文章、帖子或者图集id
"type":"", // 类型,目前包含article, album和topic三个值
"img": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg", //导读图
"title": "[直播]成都车展探馆:奥迪RS5 Coupe亮相", //内容标题
"chl":"所属栏目" // 所属栏目
"ups":123, // 赞的数量
"downs":123 // 踩的数量
},
...
],
"focus":[
{
"img:":"http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",
"id":111111 // 同上
}
]
2.4 赞和踩
url:
汽车网:待定
作用:对某个对象赞或者踩
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:否
请求参数:
id,文章、帖子或者图集id
type,article、topic或者album
action,up或者down,分别代表赞和踩
返回参数:
{
"id":123 // 文章、帖子或者图集id
"type":"article", // article、topic或者album
"resultCode":0, // 0表示成功,其他是失败
"msg":"提示信息", // 提示信息
"ups":123, // 赞的数量
"downs":123 // 踩的数量
}
2.5 搜索行情文章
url:
汽车网:待定
作用:点击文章终端的车系按钮,出该车系的行情文章
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:
serialId或者serialName,车系id或者车系名字,根据快搜接口的要求而定
cityName,城市名字
返回参数:
参考3.6.0的栏目接口 http://mrobot.pcauto.com.cn/v2/cms/channels/2
2.6 新消息
url:
汽车网:待定
作用:获取个人中心的新消息的数量(系统消息和短消息)
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
返回参数:
{
"systemNoticeCount": 0, //系统消息数
"messageCount": 0, // 短消息数
"fansCount": 0 //新粉丝数
}
2.7 您可能对以下内容感兴趣
url:
汽车网:待定
作用:获取个人中心的可能感兴趣内容
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:
common_session_id:用户登陆后获得的认证id
返回参数:
{
"result": {
"favortie": [
{
"id": 123,
"name": "鬼知道咩",
"img":""
}
]
},
"code": 1,
"msg": ""
}
2.8 收藏夹信息---文章
url:
汽车网:待定
作用:收藏夹信息---文章
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"articles": [
跟文章列表结构
]
},
"code": 1,
"msg": ""
}
2.9 收藏夹信息---帖子
url:
汽车网:待定
作用:收藏夹信息---帖子
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"topics": [
跟帖子列表结构
]
},
"code": 1,
"msg": ""
}
2.10 收藏夹信息---车型
url:
汽车网:待定
作用:收藏夹信息---车型
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"cars": [
跟车型列表结构
]
},
"code": 1,
"msg": ""
}
2.11 删除收藏夹信息
url:
汽车网:待定
作用:删除收藏夹信息
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session; type:1/2/3; ids=123,433,577
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.12 获取我的订阅
url:
汽车网:待定
作用:我的订阅
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"cars": [
{
"serialId": 123,
"name": "鬼知道咩",
"img":"",
"price":"$12"
}
]
},
"code": 1,
"msg": ""
}
2.13 我的消息---提醒
url:
汽车网:待定
作用:我的消息---提醒
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"remind": [
{
"id": 123123,
"type": 1,
//1回复帖子,2回复评论
"topicid": 12312,
"face": "",
"userName": "xxx",
"userid": 6546,
"time": "2013-01-01 02:10",
"last": "对方回复内容",
"content": "这次的内容"
}
]
},
"code": 1,
"msg": ""
}
ps:这接口内容有3种
1.我发的帖子,别人回帖
2.我发的回帖,别人回复
3.我发的文章评论,别人回复
2.14 删除提醒
url:
汽车网:待定
作用:删除提醒
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.15 删除私信
url:
汽车网:待定
作用:删除私信
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.16 我的消息---私信
url:
汽车网:待定
作用:我的消息---私信
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session
返回参数:
{
"result": {
"message": [
{
"face": "",
"username": "",
"userid": 12312,
"time": "2013-01-01 02:10",
"content": "这次的内容"
}
]
},
"code": 1,
"msg": ""
}
2.17 回复评论
url:
汽车网:待定
作用:回复评论
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,id
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.18 获取个人私信
url:
汽车网:待定
作用:获取个人私信
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session,id
返回参数:
{
"result": {
"face": "",
"username": "",
"userid": 12312,
"message": [
{
"time": "2013-01-01 02:10",
"content": "这次的内容"
}
]
},
"code": 1,
"msg": ""
}
2.19 发送私信
url:
汽车网:待定
作用:发送私信
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,userid
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.20 我的帖子
url:
汽车网:待定
作用:我的帖子
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session,id
返回参数:
{
"result": {
"topics": [
跟帖子列表的结构
]
},
"code": 1,
"msg": ""
}
2.21 获取可订阅列表
url:
汽车网:待定
作用:获取可订阅列表
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
请求参数:session,
返回参数:
{
"result": {
"A": [
{
"name": "奥迪",
"series": [
{
"section": "奥迪3系",
"cars": [
{
"scr": "",
"name": "奥迪3系1型",
"id": 123
}
]
}
]
}
]
},
"code": 1,
"msg": ""
}
2.14 删除提醒
url:
汽车网:待定
作用:删除提醒
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.14 删除提醒
url:
汽车网:待定
作用:删除提醒
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.14 删除提醒
url:
汽车网:待定
作用:删除提醒
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}
2.14 删除提醒
url:
汽车网:待定
作用:删除提醒
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:session,ids=1,2,3
返回参数:
{
"result": {
},
"code": 1,
"msg": ""
}