| Version 70 (modified by leijingtang, 12 years ago) (diff) |
|---|
Table of Contents
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的最顶部,实现类似下面的代码:
注意:需要用getQueryString(),不能用getParameter()
String queryString = request.getQueryString();
String reqEnc = getQueryValue(queryString,"req_enc=");
if(reqEnc!=null){
request.setCharacterEncoding(reqEnc);
}
String respEnc = getQueryValue(queryString,"resp_enc=");
if(respEnc!=null){
//out.println(respEnc);
response.setCharacterEncoding(respEnc);
}
String getQueryValue(String queryString,String key){
if(queryString==null || queryString.length()==0)return null;
int reqIdx = queryString.indexOf(key);//req_enc=utf-8&resp_enc=gbk
if(reqIdx!=-1){
reqIdx = reqIdx+key.length();
int endIdx = reqIdx;
for (;
endIdx < queryString.length() && queryString.charAt(endIdx)!='&';
endIdx++) {
}
if(endIdx>reqIdx){
return queryString.substring(reqIdx,endIdx);
}
}
return null;
}
4.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。
5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。
6.需要登录的接口,cache-control=600 ;分开优先级低和主动请求两种,前者用cacheFirst,后者用noCache
2.接口列表
2.1 车系相关文章列表
url:
http://mrobot.pcauto.com.cn/v3/price/getNewsListBySerialId/3524?pageNo=1&pageSize=20
http://mrobot.pcauto.com.cn/v3/price/getProfileListBySerialId/3524?pageNo=1&pageSize=20
http://mrobot.pcauto.com.cn/v3/price/getGuideListBySerialId/3524?pageNo=1&pageSize=20
http://mrobot.pcauto.com.cn/v3/price/getArticlePriceListBySerialId/3524?pageNo=1&pageSize=20&areaId=1
新增最新资讯栏目:
http://mrobot.pcauto.com.cn/v3/price/getNewestInfoListBySerialId/9010?pageNo=1&pageSize=20
作用:获取某个车系下的文章列表,在原来的基础上添加顶踩数
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
[
{
"channel":"汽车报价",
"commentNum":"0",
"id":"3590182",
"image":"http://img.pconline.com.cn/images/upload/upc/tx/auto5/1210/01/c0/14229062_14229062_1349107127921_500.jpg",
"pubDate":"2013-12-16 00:15:39",
"title":"奥迪A4L广州优惠4万元 让利幅度已收紧",
"ups":123,
"downs":123
}
]
2.2 伪造顶踩数
http://mrobot.pcauto.com.cn/v2/cms/channels/1?pageNo=1&pageSize=20&serialIds=2143,3404&v=4.0.0 http://mrobot.pcauto.com.cn/v2/cms/channels/55555?pageNo=1&pageSize=20&areaId=1&v=4.0.0 http://mrobot.pcauto.com.cn/v2/cms/channels/2?pageNo=1&pageSize=20&v=4.0.0 http://mrobot.pcauto.com.cn/v2/cms/serialMixedData/2143?pageNo=1&pro=%E5%B9%BF%E4%B8%9C%E7%9C%81&city=%E5%B9%BF%E5%B7%9E%E5%B8%82&v=4.0.0 http://mrobot.pcauto.com.cn/v3/bbs/hot?pageNo=1&pageSize=20 http://mrobot.pcauto.com.cn/v3/bbs/newForums/17369?pageNo=1&pageSize=19&orderby=postat http://mrobot.pcauto.com.cn/v3/price/getNewsListBySerialId/3524?pageNo=1&pageSize=20 http://mrobot.pcauto.com.cn/v3/price/getProfileListBySerialId/3524?pageNo=1&pageSize=20 http://mrobot.pcauto.com.cn/v3/price/getGuideListBySerialId/3524?pageNo=1&pageSize=20 http://mrobot.pcauto.com.cn/v3/price/getArticlePriceListBySerialId/3524?pageNo=1&pageSize=20&areaId=1 http://mrobot.pcauto.com.cn/v3/price/getNewestInfoListBySerialId/9010?pageNo=1&pageSize=20 新增两个需要x13的接口: http://mdata.pcauto.com.cn/pcauto/user/ups-downs.jsp?id=3072346&type=1&action=1 http://mrobot.pcauto.com.cn/v3/cmt/getUpsDowns?params=%7B%22params%22:%5B%7B%22id%22:3722420,%22type%22:1%7D%5D,%22flag%22:1%7D 对以上接口的顶踩数分别乘以13
2.3 推荐图集
url:http://mrobot.pcauto.com.cn/v2/photo/recommendAlbums
作用:滚动到图集最后一张图后显示推荐图集
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
[
{
"id":130583, // 图集id
"image":"http://i3.3conline.com/images/piclib/201305/23/batch/1/176477/1369277363528pbshbw5puy_medium.jpg", // 图集封面图,尺寸待定
"title":"图集标题"
}
]
2.4 左侧栏菜单
url:todo
作用:获取左侧栏菜单,在原来的基础上添加广告数据;如果是广告数据则添加对应的计数字段,否则不变。
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
[
{
"id":1,
"img":"http://www1.pcauto.com.cn/mobile/ceshi/home.png",
"title":"首页",
"view":"information-home/",
"url":"",
"vc-uri":"",
"cc-uri":"",
"vc3d-uri":"",
"cc3d-uri":""
}
]
2.5 推荐订阅
url:todo
作用:获取推荐订阅,由编辑在cms里维护
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
{
"serialList": [
{
"id": 3895,
"name": "途观"
}
]
}
2.6 热门车系
url:todo
作用:获取热门车系,在原来的基础上添加广告数据;如果是广告数据则添加对应的计数字段,否则不变。
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
{
"manufacturers":[
{
"id":3895,
"name":"途观",
"priceRange":"18.98~31.58万",
"kind":"中型SUV",
"photo":"http://img0.pcauto.com.cn/pcauto/1311/25/3461900_tuguan.jpg"
}
]
}
2.7 默认订阅车系
url:todo
作用:获取默认订阅车系,在原来的基础上添加广告数据;如果是广告数据则添加对应的计数字段,否则不变。
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
{
"serialList":[
{
"serialId": 3404,
"serialName": "福克斯",
"price": "9.98-16.99万",
"image":"http://img.pconline.com.cn/images/upload/upc/tx/auto5/1307/24/c16/23702964_1374654889218_270x202.jpg"
"vc-uri":"",
"cc-uri":"",
"vc3d-uri":"",
"cc3d-uri":""
}
]
}
2.8 新增广告
url:http://mrobot.pcauto.com.cn/v3/ad
作用:获取广告,在原来的基础上添加以下广告
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
车型页中栏:
{
"auto.khd.zx.cxyzl.":{
"ads": [
{
"cc-uri": "",
"cc3d-uri": "",
"text": "长安福特新福克斯为你加油",
"to-uri": "http://ivy.pcauto.com.cn/adpuba/click?adid=301792&id=auto.khd.zx.btxwz.",
"vc-uri": "http://ivy.pcauto.com.cn/adpuba/show?adid=301792&id=auto.khd.zx.btxwz.&media=js",
"vc3d-uri": ""
}
]
}
}
推荐图集:
"auto.khd.zx.tjtj.": {
"ad": {
"img": "http://i0.sinaimg.cn/IT/h/2008-03-04/ad1b75b3bffd8eed902663650ef17695.JPG",
"to-uri": "http://flv.pcvideo.com.cn/pconline/videocenter/interior/2013/01/30/A31EB18313043006.mp4",
"vc-uri": "http://127.0.0.1:8080/click.jsp?type=vc",
"cc-uri": "http://127.0.0.1:8080/click.jsp?type=cc",
"vc3d-uri": "http://192.168.20.6?a=3d",
"cc3d-uri": "http://192.168.20.68?a=3d"
}
}
启动图动画
“auto.khd.zx.qdtdh"
{
"rule":{
"delay":1,
"interval":10,
"age":10
},
"ad":{
"img":"http://219.136.245.79/demo/ad/banner.png",
"vc-uri":"http://127.0.0.1:8080/click.jsp?type=vc",
"cc-uri":"http://127.0.0.1:8080/click.jsp?type=cc",
"vc3d-uri":"http://192.168.20.6?a=3d",
"cc3d-uri":"http://192.168.20.68?a=3d"
}
}
2.9 车系聚合页
url:http://mrobot.pcauto.com.cn/v2/cms/serialMixedData/8670
作用:在原来的基础上添加topData数据,topData里的数据都是广告,数据应该从广告系统中出
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:
{
{
"count":45,
"downs":1,
"channelName":"奥迪Q3论坛", // 所属栏目名或者论坛名
"to-uri":"pcautobrowser://bbs-topic/3704620",
"image":"http://imgm.pconline.com.cn/images/upload/upc/tx/bbs6/1303/29/c1/19345623_1364542751740_240x160.jpg",
"pubDate":"2013-03-29 16:25:49",
"score":189520.53616888454,
"title":"Q3 最完美装饰,大量图片,希望版主能给精 精 精!!!",
"ups":1,
"seq":1 // 指示该条目在客户端中显示的位置
},
}
2.10 帖子列表
url:http://mrobot.pcauto.com.cn/v3/bbs/newForums/19139?pageNo=1&pageSize=19&orderby=postat
作用:获取帖子列表,在原来的基础上添加置顶数据。置顶数据包含全站置顶和本版置顶。
置顶数据不给出所有置顶帖,只是分别从两者随机抽取一条数据出到接口,该数据flag字段的值恒为“荐”。
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
设计稿:
返回参数:略
2.11 车型终端页
url:http://mrobot.pcauto.com.cn/v3/price/modelsv40/20202?areaId=1&app=pcautobrowser&isCompared=0&v=4.1.0
作用:开发4.0时漏了选择城市的功能,针对4.1版本补充回来
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:在原有参数的基础上添加v=4.1.0
设计稿:待定
备注:除此之外,车型终端添加一个文字广告,位置就在选择城市按钮的上方。
实现方法参考文章页的标题下文字广告,该位置的广告id待定:
<div class='ivyTxt' onclick='if(event) event.stopPropagation();'>
<div class='ad_btxwz' style='display:none;'></div>
</div>
2.12 找车搜索关键字
url:http://mrobot.pcauto.com.cn/v3/price/modelsForSearch
作用:动态获取搜索关键字,由编辑在cms里维护
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
"modelList": [
{
"id": 123,
"name": "蒙迪欧"
}
]
}
2.13 评论推广
url:http://mrobot.pcauto.com.cn/v3/bbs/commentExtend
作用:获取评论的推广内容,由编辑在cms里维护
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
"data": [
{
"image": "http://xxxxxx",
"to-uri": "pcautobrowser://information-article/id"
}
]
}
2.14 个人中心推广
url:http://mrobot.pcauto.com.cn/v3/bbs/personalExtend
作用:获取个人中心的推广内容,由编辑在cms里维护
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
"data": [
{
"title": "我是文字链",
"to-uri": "pcautobrowser://information-article/id"
}
]
}
2.15 获取提醒内容
url:http://mrobot.pcauto.com.cn/v3/bbs/getTopicReplyReminds?pageSize=20&pageNo=1
http://mrobot.pcauto.com.cn/v3/bbs/getCommentReplyReminds?pageSize=20&pageNo=1
作用:我的消息---提醒,分别获取回帖和文章评论回复列表。获取回帖在原来的基础上添加reply-to-userName和reply-to-userId两个字段,详细请看返回参数。文章评论回复不变。原来的基础指:[[BR]]
http://mrobot.pcauto.com.cn/v3/bbs/getReminds?pageSize=20&pageNo=1
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:是
设计稿:
请求参数:
common_session_id:用户登陆后获得的认证id
pageNo:页数
pageSize:每页显示多少条
说明:本接口和获取新消息的接口 http://trac.pc.com.cn/iphone/wiki/pcauto_4.0.0/interface#a2.6新消息 有相关联系,
调用获取回帖成功会清零这个接口的forumReplyCount字段,
调用获取评论回复成功会清零这个接口的commentReplyCount字段
返回参数:
{
"pageNo":1,
"pageSize":20,
"total":200,
"resultList": [
{
"id": 123123, //1和2时,为帖子id,为3时是文章id
"type": 1,//1回复主贴,2回复回帖,3回复文章评论
"face": "",//头像
"userName": "xxx",//昵称
"userId": 6546,
"replyToUserName":"xxx", // type为1时该字段有效。当用户A在我的主帖里回复了用户B,该字段返回用户B的昵称
"replyToUserId":123, //该字段返回的时id,其他同"reply-to-userName"
"noticeId":123,消息id(删除消息需用此字段)
"createAt": 1382582506000,
"toReply": "引用内容",
"content": "回复内容",
"topicId":123, // 如果这条回复是评论,则这是对应评论列表的主题id;如果是回复帖子,为0
"topicUrl":"" , // 如果这条回复是评论,则这是对应评论列表的主题url;如果是回复帖子,为空字符串
"title":"", // 帖子或者文章标题
"floorId":123 , // 该回复的楼层id,评论和帖子都用这个字段
"floor":123 // 该回复的楼层数,评论和帖子都用这个字段
}
]
}
ps:这接口内容有3种
1.我发的帖子,别人回帖
2.我发的回帖,别人回复
3.我发的文章评论,别人回复
2.16 首页资讯列表
url:http://mrobot.pcauto.com.cn/v2/cms/channels/1?pageNo=1&serialIds=3404,2143&v=4.0.0
作用:获取首页栏目的资讯列表,焦点图增加到6个。
使用范围:汽车网app
HTTP请求方式:get
是否需要登录:否
请求参数:none
返回参数:略
2.17 批量收藏论坛
url:
http://bbs.pcauto.com.cn/batchFavForums.ajax?fids=15001,15002
作用:批量收藏论坛
使用范围:汽车网app
HTTP请求方式:post
是否需要登录:是
请求参数:fids:论坛id
返回参数:略
2.18 论坛相关接口
url:
最新帖:http://mrobot.pcauto.com.cn/v3/bbs/newForums/19585?pageNo=1&pageSize=19&orderby=postat
最热帖:http://mrobot.pcauto.com.cn/v3/bbs/newForums/19585?pageNo=1&pageSize=19&orderby=replyat
精华帖:http://mrobot.pcauto.com.cn/v3/bbs/newForums/19585?pageNo=1&pageSize=19&filter=pick
3.开发时间、负责人、进度和实现方式
| 批次 | 页面 | 涉及MROBOT接口 | 是否需要 HTML切图 | 需配合的接口负责人 及进度 | 接口开发 预计时间 | 接口进度(百分比) | 接口实际 完成时间 | 实现方式 |
|---|---|---|---|---|---|---|---|---|
| 第一批 | 首页 | 2.1 车系相关文章列表 | - | - | - | 已上线 | - | - |
| 第一批 | 首页 | 2.11 车型终端页 | - | - | - | 已上线 | - | - |
| 第一批 | 首页 | 2.9 车系聚合页 | - | - | - | 已上线 | - | - |
| 第二批 | 首页 | 2.5 推荐订阅 | - | - | - | - | - | - |
| 第二批 | 首页 | 2.8 新增广告 | - | - | - | 已上线 | - | - |
| 第二批 | 首页 | 2.12 找车搜索关键字 | - | - | - | 已上线 | - | - |
| 第二批 | 首页 | 2.14 个人中心推广 | - | - | - | 已上线 | - | - |
| 第二批 | 首页 | 2.13 评论推广 | - | - | - | 已上线 | - | - |
| 第二批 | 首页 | 2.15 获取提醒内容 | - | - | - | 已上线 | - | - |
| 第三批 | 首页 | 2.2 伪造顶踩数 | - | - | - | 已上线 | - | - |
| 第三批 | 首页 | 2.3 推荐图集 | - | - | - | 已上线 | - | - |
| 第三批 | 首页 | 2.10 帖子列表 | - | - | - | 已上线 | - | - |
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)