1.基本约定
接口通用参数
req_enc=utf-8(必须放url后面)
resp_enc=utf-8(必须放url后面)
common_session_id=xxxx(以cookies中的优先)
接口URL: 接口URL
必填参数:参数名=xxx(多种情况用括号解析)
非必填参数:参数名=xxx(多种情况用括号解析)
说明文档参数:添加某特定参数可以直接看接口文档
是否需要登录:是,否
返回格式:json,ssi,xml
缓存方式:接口缓存,对象缓存
缓存时间:缓存时间
返回结果:结果可能情况
2.接口列表
2.1 判断是否已收藏文章接口
备注:此接口判断已登陆用户是否已收藏指定文章;直接使用Web端接口
mrobot url:暂无
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=isCollect&siteId=1&articleId=5105797
HTTP请求方式:get
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
act:请求动作,isCollect为判断是否已收藏
siteId:主网站id,电脑网为1
articleId:文章id
1、已收藏
{
"code":1,
"message":"该文章已被该用户收藏"
}
2、未收藏
{
"code":2,
"message":"该文章未被该用户收藏"
}
2.2 添加文章收藏接口
备注:此接口添加文章收藏到已登录用户中;直播文章无收藏功能;使用mrobot中转接口
mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionUpload
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=addArtCollect&siteId=1&articleId=5105797
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
json={"article":{"addList":["5134076"]}}
1、正常返回
{
"addArticleInfo": [
{
"code": 0,
"message": "31356890用户收藏文章成功!"
}
]
}
2、异常返回
{
"addArticleInfo": [
{
"code": 1,
"message": "该文章已被该用户收藏"
}
]
}
2.3 批量添加文章收藏接口
备注:此接口批量添加文章收藏到已登录用户中;直播文章无收藏功能;使用mrobot中转接口
mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionUpload
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=addArtCollect&siteId=1&articleId=5105797
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
json={"article":{"addList":["5134076","5123996"]}}
1、正常返回
{
"addArticleInfo": [
{
"code": 0,
"message": "31356890用户收藏文章成功!"
},
{
"code": 0,
"message": "31356890用户收藏文章成功!"
}
]
}
2、异常返回
{
"addArticleInfo": [
{
"code": 1,
"message": "该文章已被该用户收藏"
},
{
"code": 1,
"message": "该文章已被该用户收藏"
}
]
}
2.5 取消文章收藏接口
备注:此接口取消已登录用户的文章收藏;直播文章无收藏功能;使用mrobot中转接口
mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionUpload
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=delMyCollection&siteId=1&articleId=5105797
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
json={"article":{"deleteList":["5134076"]}}
1、正常返回
{
"deleteArticleInfo": [
{
"code": 0,
"message": "删除收藏文章成功!"
}
]
}
2、异常返回
{
"deleteArticleInfo": [
{
"code": 1,
"message": "删除收藏文章失败!"
}
]
}
2.6 批量取消文章收藏接口
备注:此接口批量取消已登录用户的文章收藏;直播文章无收藏功能;使用mrobot中转接口
mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionUpload
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=delMyCollection&siteId=1&articleId=5105797
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
json={"article":{"deleteList":["5134076","5123996"]}}
1、正常返回
{
"deleteArticleInfo": [
{
"code": 0,
"message": "删除收藏文章成功!"
},
{
"code": 0,
"message": "删除收藏文章成功!"
}
]
}
2、异常返回
{
"deleteArticleInfo": [
{
"code": 1,
"message": "删除收藏文章失败!"
},
{
"code": 1,
"message": "删除收藏文章失败!"
}
]
}
2.7 已收藏文章列表接口
备注:此接口返回已登录用户已收藏的文章列表;使用mrobot中转接口
mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionDownload/31356890?pageNo=1&pageSize=20
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=getMyCollection&siteId=1&pageNo=1&pageSize=20
HTTP请求方式:get
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
备注:mrobot接口中的用户id,必须跟cookie中的用户是同一用户。不然会出现非法请求,导致论坛接口返回错误状态,取不到正确的数据
请求参数:
act:请求动作,getMyCollection为获取已收藏文章列表
pageNo:当前请求页码
pageSize:每页返回条数
返回参数说明:
原接口数据保持不变,增加已收藏文章的返回信息
articleCount:已收藏文章数量
articlePageCount:已收藏文章的页数,根据articleCount和pageSize计算得到
articleList:根据pageNo和pageSize返回的已收藏文章列表
文章列表字段:
id:收藏id
name:文章标题
articleId:文章id
imageUrl:文章的配图,若该文章没有图片,则为空
返回结果:
{
"forumCount": 11,
"forumList": [{
"forumId": 668543,
"id": 2903021,
"name": "iPhone综合讨论区"
}, {
"forumId": 769246,
"id": 2891611,
"name": "我要踢爆"
}],
"forumPageCount": 1,
"pieForumCount": 2,
"pieForumList": [{
"forumId": 76,
"id": 15438,
"name": "最吹水肥皂区"
}, {
"forumId": 48,
"id": 14400,
"name": "最数码二手闲置交易"
}],
"pieForumPageCount": 1,
"pieTopicCount": 4,
"pieTopicList": [{
"id": 15663,
"name": "从机械胶卷到数码CMOS,十年单反路--最后还有重武器“出仓”",
"topicId": 76565
}, {
"id": 15662,
"name": "好屌的自行车",
"topicId": 102316
}],
"pieTopicPageCount": 1,
"topicCount": 33,
"topicList": [{
"id": 2904262,
"name": "那些年,80后一起用过的电脑",
"topicId": 51599565
}, {
"id": 2869645,
"name": "各位高手能帮我看看这是什么牌子的电源吗",
"topicId": 51445926
}],
"topicPageCount": 2,
"articleCount": 2,
"articleList": [{
"id": 2904262,
"name": "500万画点!西铁城推出超高分辨率EVF",
"articleId": 5045678,
"imageUrl": "http://img0.pconline.com.cn/pconline/1407/04/5045678_1_thumb.jpg"
}, {
"id": 2869645,
"name": "免费WIFI无限畅玩 荣耀6专属WLAN初体验",
"articleId": 5027277,
"imageUrl": "http://img0.pconline.com.cn/pconline/1407/01/5027277_100.jpg"
}],
"articlePageCount": 1,
"pageCount": 2,
"pageNo": 1,
"pageSize": 20,
"total": 52
}
2.8 文章顶、踩接口
备注:此接口对该文章进行顶、踩操作;直播文章无顶踩功能;直接使用Web端接口
mrobot url:暂无
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=addArtAgree&siteId=1&articleId=5105797&isAgree=1
HTTP请求方式:get
是否需要登录:否
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
act:请求动作,addArtAgree为顶、踩文章
siteId:主网站id,电脑网为1
articleId:文章id
isAgree:顶或踩:1表示顶;2表示踩
1、顶、踩文章正常返回
{
"code":0,
"message":"用户赞、踩文章成功"
}
2.1、已顶过的文章再进行顶踩操作返回
{
"code":1,
"message":"该文章已被该用户赞过"
}
2.2、已踩过的文章再进行顶踩操作返回
{
"code":2,
"message":"该文章已被该用户踩过"
}
2.9 获取文章顶踩数据接口
备注:此接口获取文章顶踩数据;直播文章无该功能;直接使用Web端接口
mrobot url:暂无
Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=getArticleCount&siteId=1&articleId=5105797
HTTP请求方式:get
是否需要登录:否
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
act:请求动作,getArticleCount为获取文章顶踩数据
siteId:主网站id,电脑网为1
articleId:文章id
1、正常返回
{
"id":848544,
"createTime":1405479564000,
"siteId":1,
"articleId":5105797,
"collectCount":0,
"addCollect":0,
"agreeCount":6,
"addAgree":0,
"againstCount":0,
"addAgainst":0
}
2.10 文章页、直播页接口增加元数据字段
备注:
文章页接口在页面的元数据区域增加作者名称(author)、发布时间字段(pubDate,格式为“2014-08-01”);元数据区域以@_HTML_META_START_开头,_HTML_META_END_@结尾
直播页接口在页面的元数据区域增加作者名称(author)、作者头像(authorPic)、访问人数(visitCount)、发布时间字段(pubDate,格式为“2014-08-01 16:25:00”);元数据区域以@_HTML_META_START_开头,_HTML_META_END_@结尾
修改原因:文章评论页和直播页显示时需要使用
mrobot url:
文章页:http://mrobot.pconline.com.cn/v3/cms/articles/5136896?articleTemplate=3.6.0&size=20&picRule=2&app=pconlinebrowser&template=(null)&channelId=0&serialId=0
直播页:http://mrobot.pconline.com.cn/v3/cms/articles/270?articleTemplate=3.9.0&size=20&picRule=2&app=pconlinebrowser&template=live&channelId=10&serialId=0&date=1406003000.669044
注意:articleTemplate字段用于区分接口,articleTemplate=3.6.0返回旧的直播页;articleTemplate=3.9.0返回新的直播页。
HTTP请求方式:get
是否需要登录:否
返回格式:html
缓存方式:无
缓存时间:无
请求参数:
2.11 文章页底部产品概述跳转产品详情协议规定
修改原因:3.9.0增加文章页底部产品概述跳转产品详情自定义事件统计
文章页接口:文章页:http://mrobot.pconline.com.cn/v3/cms/articles/5136896?articleTemplate=3.6.0&size=20&picRule=2&app=pconlinebrowser&template=(null)&channelId=0&serialId=0
产品概述跳转产品详情协议:pconlinebrowser://product-detail/532790?from=articleProductSummary
其他链接跳转产品详情协议:pconlinebrowser://product-detail/532790
8月19需求变动
2.12 我发表的主贴、我发表的回帖整合itbbs和piebbs帖子数据
修改原因:3.8.0版本未整合itbbs和piebbs帖子数据,3.9.0版本进行整合
主贴接口:http://mrobot.pconline.com.cn/v3/itbbs/myTopics/32732404?appVersion=3.9.0&pageNo=1&pageSize=20
回帖接口:http://mrobot.pconline.com.cn/v3/itbbs/myTopics/32732404?appVersion=3.9.0&pageNo=1&filter=post&pageSize=20
注意:appVersion字段用于区分接口,appVersion=3.9.0时,整合itbbs和piebbs数据;否则不整合piebbs数据
返回格式:json
返回数据:
增加from字段;from=itbbs时表示该帖子属于itbbs,from=piebbs时表示该帖子属于piebbs
其余字段与旧版本相同;mrobot处理适当的排序和分页计算
2.13 我的论坛消息接口处理最数码论坛帖子数据
修改原因:3.8.0版本时,该接口没有出最数码论坛消息,但现在的线上接口却出了最数码帖子数据,导致3.8客户端跳转帖子页失败
我的论坛消息接口:http://mrobot.pconline.com.cn/v3/itbbs/getTopicReplyReminds?appVersion=3.9.0&pageNo=1&pageSize=20
注意:appVersion字段用于区分接口,appVersion=3.9.0时,保留最数码论坛消息;否则过滤最数码论坛消息
返回格式:json
返回数据:
增加from字段;from=itbbs时表示该帖子属于itbbs,from=piebbs时表示该帖子属于piebbs
其余字段与旧版本相同;mrobot处理适当的排序和分页计算