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 个人中心 - 系统消息列表
备注:此接口返回系统消息列表,只返回typeIds=4(系统通知)
typeIds取值:0:群发通知、3:测试消息、4:系统通知、1006:今日最超值、1007:电脑网试用中心、1008:产品库点评系统(系统通知)、1009:产品库点评系统(回复通知)、5001:下载中心
链接转换规则:
1)http://itbbs.pconline.com.cn/bbs/p${1}_${2}.html或http://itbbs.pconline.com.cn/rest/topics.jsp?topicId=${1}转换为pconlinebrowser://bbs-topic/{topicId}?from=itbbs
2)http://piebbs.pconline.com.cn/post-${1}_${2}.html或http://piebbs.pconline.com.cn/rest/topics.jsp?topicId=${1}转换为pconlinebrowser://bbs-topic/{topicId}?from=piebbs
3)其余类型链接,过滤a标签,保留a标签文本;例如:"<a href='http://my.pconline.com.cn'>http://my.pconline.com.cn</a>"转换为"http://my.pconline.com.cn"
mrobot接口:http://mrobot.pconline.com.cn/v3/itbbs/getSysMsg
mrobot请求参数:
pageNo=当前页码
pageSize=每页条数,默认20
后端接口:http://bip.pconline.com.cn/intf/sysnotice.jsp?act=find&siteId=1&status=-1&groupType=0&typeIds=4&pageNo=1&pageSize=20&req_enc=UTF-8&resp_enc=UTF-8&common_session_id=FBD7FE4028F688FA69169CD49CE0E6B8AB677768BDA669B2
HTTP请求方式:get
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
后端请求参数:
act=find获取消息列表
siteId=网站ID(1是电脑网,2是汽车网,3是游戏网,4是女性网,5是亲子网,6是家居网)
status=0是未读,1是已读,默认-1是全部
groupType=消息分组,默认全部,开发人员提供
typeIds=子类型id串,多个id用半角逗号分隔
pageNo=页码
pageSize=一页条数,默认20,最大500
req_enc=请求编码
resp_enc=响应编码
返回结果:
{
total: 总的条数
pageNo: 页码
pageCount: 页数
pageSize: 每页条数
resultList:{
id: 消息ID
type: { //消息类型
name: 消息类型名称
id: 消息分类ID
description: 描述
siteId: 网站ID
templateId: 模板ID
groupType: 分组ID
}
content: 模板内容
createTime: 发送消息时间戳
status: 状态
accountId: 接收消息人
siteId: 网站ID
typeId: 分类ID
senderId: 发送者ID
groupSend: 是否群发
groupType: 消息分组
resultText: 操作结果
}
2.2 个人中心 - 清空/删除系统消息
备注:此接口清空/删除系统消息,只清空/删除子类型typeIds=4(系统通知)
mrobot接口:不需要额外处理
后端接口:http://bip.pconline.com.cn/intf/sysnotice.jsp?act=deleteAll&siteId=1&groupType=0&typeIds=4
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
act=deleteAll删除系统消息
siteId=网站ID(1是电脑网,2是汽车网,3是游戏网,4是女性网,5是亲子网,6是家居网)
groupType=消息分组,默认全部,开发人员提供
typeIds=子类型id串,多个id用半角逗号分隔
返回结果:
失败:{"code":-1,"message":"非法请求"}
{"code":-1,"message":"缺少参数"}
成功:{"code":0}
2.3 个人中心 - 获取未读消息数接口
备注:整合系统消息模块;返回指定类型(typeIds=4:系统通知)的未读系统消息数功能
mrobot接口:http://mrobot.pconline.com.cn/v3/itbbs/getNewMsgCount
mrobot请求参数:accountId=登录用户账号id(新增参数,用于获取未读系统消息数)
未读系统消息数请使用sysMsgCount字段,而不是systemNoticeCount字段
后端接口:http://bip.pconline.com.cn/intf/sysnotice.jsp?act=getNum&siteId=1&typeIds=4&accountId=31356890
HTTP请求方式:post
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
后端请求参数:
必填参数:
act=getNum获取消息数
siteId=网站ID(1是电脑网,2是汽车网,3是游戏网,4是女性网,5是亲子网,6是家居网)
accountId=登录用户账号id
非必填参数:
status:0是未读,1是已读,-1是全部,默认是0
typeIds=子类型id串,多个id用半角逗号分隔
返回结果:
失败:{"code":-1,"message":"缺少参数"}
成功:消息条数
2.4 个人中心 - 重置未读消息数为0接口
备注:整合系统消息模块;重置指定类型(typeIds=4:系统通知)的未读系统消息数为0功能
客户端不再直接调用该接口,由mrobot读取消息后自动设置未读消息数为0
mrobot接口参数说明:groupType=0,系统消息、groupType=4,论坛回复消息、groupType=5,评论回复消息
mrobot接口:http://mrobot.pconline.com.cn/v3/itbbs/setNewMsgState
后端接口:http://bip.pconline.com.cn/intf/sysnotice.jsp?act=readAll&siteId=1&groupType=0&typeIds=4
HTTP请求方式:get
是否需要登录:是
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
必填参数:
act=readAll设置已读
siteId=网站ID(1是电脑网,2是汽车网,3是游戏网,4是女性网,5是亲子网,6是家居网)
非必填参数:
groupType:系统消息组类型,默认是4,论坛回复通知
typeIds=子类型id串,多个id用半角逗号分隔
返回结果:
失败:{"code":-1,"message":"非法请求"}
{"code":-1,"message":"缺少参数"}
成功:{"code":0}
2.5 首页 - 资讯列表
备注:此接口返回资讯消息列表,在返回字段里增加资讯类型
informationType = 0, //其他
informationType = 1, //文章
informationType = 2, //帖子
informationType = 3, //图集
informationType = 4, //新增直播类型
informationType = 5, //新增专题类型
informationType = 6 //新增聚超值类型
专题类型时,to-uri字段指定专题页网址,且必须包含“browser=commonWebView”参数
mrobot接口:http://mrobot.pconline.com.cn/v2/cms/channels/1?pageNo=1&pageSize=20
后端接口:无
HTTP请求方式:get
是否需要登录:否
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
pageNo=页码
pageSize=一页条数,默认20,最大500
返回参数:
{
"articleList": [ //备注:此处无专题类型
{
"bigImage": "http://img0.pconline.com.cn/pconline/1409/19/5460676_51_1k6tu9yn_thumb.jpg",
"cmtCount": 文章评论数,
"id": 文章id,
"image": 文章图片地址,
"pubDate": 发布时间,
"title": 标题,
"url": 文章详情地址,
"informationType": 资讯类型
}
],
"focus": [ //备注:此处无专题类型
{
"counter": "",
"id": 文章id,
"image": 文章图片地址,,
"pubDate": 发布时间,
"title": 标题,
"url": 文章详情地址,
"informationType": 资讯类型
}
],
"topArticle": [ //备注:只有这里有专题类型
{
"image": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1409/19/c2/38772308_1411119899458_width600.jpg",
"preView": "其他类型的资讯,用全屏webview打开,类似聚超值类型",
"pubDate": "2014-10-09",
"seq": 7,
"title": "LG G3移动版仅售3199元 Acer游戏本5K5历史新低",
"to-uri": "http://g.pconline.com.cn/best/list_288.html?isShowHeader=0&ad=7265",
"updateAt": 1412784000000,
"informationType": 0 //其他类型
},
{
"cmtCount": 26,
"image": "http://img.pconline.com.cn/images/upload/upc/tx/itbbs/1410/09/c4/39422400_1412824208134_1024x1024.jpg",
"preView": "64位双4G快时代!酷比魔方&联发科技4G战略发布会",
"pubDate": "2014-10-09",
"seq": 8,
"title": "快时代!酷比魔方&联发科技4G战略发布会 参与互动送平板",
"to-uri": "pconlinebrowser://information-article/322?template=live",
"updateAt": 1412784000000,
"informationType": 1 //文章类型
},
{
"floorCount": 9,
"image": "http://img.pconline.com.cn/images/upload/upc/tx/itbbs/1410/09/c3/39418150_1412820169882_1024x1024.jpg",
"preView": "HTC发布的奇特造型RE相机新品,你喜欢吗?",
"pubDate": "2014-10-09",
"seq": 5,
"title": "HTC发布的奇特造型RE相机新品,你喜欢吗?",
"to-uri": "pconlinebrowser://bbs-topic/51812318",
"updateAt": 1412784000000,
"informationType": 2 //论坛类型
},
{
"image": "http://img.pconline.com.cn/images/upload/upc/tx/itbbs/1410/09/c5/39426075_1412827383297_1024x1024.jpg",
"imgCount": 17,
"preView": "HTC Desire Eye手机和RE相机图赏\t",
"pubDate": "2014-10-09",
"seq": 6,
"title": "HTC Desire Eye手机和RE相机图赏\t",
"to-uri": "pconlinebrowser://album-photo/13404",
"updateAt": 1412784000000,
"informationType": 3 //图集类型
},
{
"cmtCount": 279,
"image": "http://img.pconline.com.cn/images/upload/upc/tx/itbbs/1410/08/c6/39379595_1412740065734_1024x1024.jpg",
"preView": "[图文直播]HTC自拍神器旗舰新品发布会",
"pubDate": "2014-10-09",
"seq": 12,
"title": "HTC自拍神器旗舰新品发布会回顾 Desire Eye手机及RE相机发布",
"to-uri": "pconlinebrowser://information-article/323?template=live",
"updateAt": 1412784000000,
"informationType": 4 //直播类型
},
{
"image": "http://img0.pcauto.com.cn/pcauto/1410/03/g_5242861_1412322026811_240x160.jpg",
"preView": "2014巴黎车展:12款重磅SUV/即将引进",
"pubDate": "2014-10-09",
"seq": 17,
"title": "2014巴黎车展:12款重磅SUV/即将引进",
"to-uri": "http://www1.pcauto.com.cn/app/cheshi/index.html?type=zt&fromapp=1&browser=commonWebView",
"updateAt": 1412784000000,
"informationType": 5 //专题类型
},
{
"image": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1409/19/c2/38772308_1411119899458_width600.jpg",
"preView": "今日聚超值",
"pubDate": "2014-10-09",
"seq": 7,
"title": "LG G3移动版仅售3199元 Acer游戏本5K5历史新低",
"to-uri": "http://g.pconline.com.cn/best/list_288.html?isShowHeader=0&ad=7265",
"updateAt": 1412784000000,
"informationType": 6 //聚超值类型
}
],
"topFocus": [ //备注:此处无专题类型
{
"cc-uri": "",
"image": "http://imgad0.pconline.com.cn/ivy/image/20149/25/14116394470770.jpg",
"seq": 3,
"title": "广告",
"to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=334508&id=pc.khd.zx.jdt.",
"updateAt": 1412824722772,
"vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=334508&id=pc.khd.zx.jdt.&media=js"
}
],
...
"total": 文章总数量
}
2.6 图赏 - 获取图赏评论列表
备注:获取图赏评论列表(同文章页获取评论列表接口)
请求URL:http://mrobot.pconline.com.cn/v3/cmt/new_topics/{图集评论id或文章评论id}
HTTP请求方式:get
是否需要登录:否
返回格式:json
缓存方式:无
缓存时间:0.25
请求参数:
articleId:图集id或文章id
reverse:升降序,按楼层排序,0降序,1升序
返回参数:
{
"total":评论总条数,
"pageNo":页码,
"pageCount":多少页,
"pageSize":每页多少条,
"title":文章标题,
"topicId":评论主题,
"data":[
评论数据集
{"id": 评论id,"nickName":昵称,"createTime":创建时间,"ip":ip,"floor":楼层,"content":评论内容,"face":图像,"status":评论状态,"replyRef":{引用的评论}},
{"id": 评论id,"nickName":昵称,"createTime":创建时间,"ip":ip,"floor":楼层,"content":评论内容,"face":图像,"status":评论状态,"replyRef":{引用的评论}},
...
]
}
2.7 图赏 - 获取评论总数
备注:获取图赏读评论总数(新接口)
请求URL:http://cmt.pconline.com.cn/action/topic/get_data.jsp
HTTP请求方式:get
是否需要登录:否
返回格式:json
缓存方式:无
缓存时间:无
请求参数:
url: 文章url
tId: 评论topic的id,url和tid两者有一即可,同时有也可以
arch: 评论归档设置,0没归档,1归档
callback: jsonp
返回参数:
{
"id":主题id,
"total":总评论数(不包含审核未通过的评论),
"floor":楼层数(包含审核未通过的评论),
"url43g":3g页面地址,
"url":评论列表页地址,
"turl":文章页面地址
}
2.8 图赏 - 发表评论
备注:图册评论(同文章页发表评论接口)
请求URL:http://cmt.pconline.com.cn/action/comment/create_utf8.jsp
请求方式:post
是否需要登录:匿名不需要,非匿名需要。
请求参数:
id:评论主题id
content :评论内容
captcha:验证码(性能测试可以不要)
url:要发表评论的文章链接地址
title:要发表评论的文章标题
replyFloor2:回复楼层,第几楼
windowname:跨域用,1为跨域,默认为0
anonymous:匿名,1为匿名
needCaptcha:需要验证码,可选参数,值为1时,表示验证码必选
partId: 分段落评论的段落Id,默认为0
创建评论时不需要传userId,passport系统会是识别用户的登录状态
返回: json或script格式(windowname=1时)数据
返回参数:
{
"commentId":评论id,
"floor":楼层,
"showName":用户名称,
"brief":评论内容,
"status":评论状态(一般是0,表示待审),
"createTime":发表时间,
"resultCode":评论是否成功,1或0表示成功,1代表先出后审,0代表先审后出。负数时,表示失败,失败原因,见resultMsg,
"resultMsg":提示信息,
"topicId":评论主题id,
"ip":ip
}
2.9 论坛 - 帖子页接口
备注:为了区分3.9之前的版本和3.10版本在帖子页是否显示登陆按钮,需要在接口中加入appVersion参数
mrobot根据该参数是否大于等于3.10.0,决定是否显示登陆按钮
请求URL:http://mrobot.pconline.com.cn/v2/itbbs/topics/15928887?pageNo=1&picRule=2&authorId=0&topicTemplate=3.6.0&app=pconlinebrowser&appVersion=3.10.0&size=18
http://mrobot.pconline.com.cn/v2/piebbs/topics/113177?pageNo=1&picRule=2&authorId=0&topicTemplate=3.6.0&app=pconlinebrowser&appVersion=3.10.0&size=18
请求方式:get
是否需要登录:否
请求参数:
appVersion:3.10版本用于区分帖子页是否显示投票帖未登陆情况下的登陆按钮
2.10 启动页面广告接口
请求URL:http://mrobot.pconline.com.cn/v3/ad
请求方式:get
是否需要登录:否
请求参数:
无
返回参数:
{
"auto.khd.zx.wzdl.": { //应用对应的广告名(电脑网固定为pc.khd.zx.qdtdh.)
"ad": {
"cc-uri": "", //点击计数,指这个广告被点了多少次
"cc3d-uri": "",
"img": "http://imgad0.pcauto.com.cn/ivy/image/201410/16/14134545654040.jpg", //启动页logo
"to-uri": "http://ivy.pcauto.com.cn/adpuba/click?adid=339455&id=auto.khd.zx.wzdl.", //一般跳转的目的链接,比如跳转到亚马逊的一个商品
"vc-uri": "http://ivy.pcauto.com.cn/adpuba/show?adid=339455&id=auto.khd.zx.wzdl.&media=js", //查看计数,指这个广告显示了多少次
"vc3d-uri": ""
},
"rule": {
"age": 10,
"delay": 0,
"interval": 120
}
},
"online.khd.zx.btxwz.": {
"ads": [
{
"cc-uri": "",
"cc3d-uri": "",
"text": "Note Edge 曲面侧屏席卷眼球",
"to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=346245&id=pc.khd.zx.btxfwz.",
"vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=346245&id=pc.khd.zx.btxfwz.&media=js",
"vc3d-uri": ""
}
]
},
"timestamp": { //时间戳
"t": 1414499843134
}
}