wiki:pconline_3.10.0/interface

Version 36 (modified by tianjie, 11 years ago) (diff)

--

Table of Contents

  1. 1.基本约定
  2. 2.接口列表
    1. 2.1 个人中心 - 系统消息列表
    2. 2.2 个人中心 - 清空/删除系统消息
    3. 2.3 个人中心 - 获取未读消息数接口
    4. 2.4 个人中心 - 重置未读消息数为0接口
    5. 2.5 首页 - 资讯列表
    6. 2.6 图赏 - 图片列表
    7. 2.7 图赏 - 获取图赏评论列表
    8. 2.8 图赏 - 图册评论
    9. 2.9 图论坛 - 帖子页接口

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 图赏 - 图片列表

 备注：进入图赏页，点击具体图册（需要返回评议数cmtCount)
 请求URL：http://mrobot.pconline.com.cn/v2/photo/albums?modelId=12348
 HTTP请求方式：get
 是否需要登录：否
 返回格式：json
 缓存方式：无
 缓存时间：0.25
 请求参数:{
        modelId:12348//图册ID
}
 返回参数：
{
    "num": 16,
    "photos": [
        {
            "desc": 图片描述,
            "id": 图片ID,
            "name": 图片名字,
            "thumb": 中图图片地址,
            "thumbUrl": 小图图片地址,
            "url": 大 图片地址，
            "cmtCount":评议数
        }
    ],
    "total": 16
}

2.7 图赏 - 获取图赏评论列表

 备注：获取图赏评论列表（新接口)
 请求URL：http://mrobot.pcauto.com.cn/v3/cmt/photo_topics/{图册ID}?reverse=0&pageNo=1&pageSize=20
 HTTP请求方式：get
 是否需要登录：否
 返回格式：json
 缓存方式：无
 缓存时间：无
 请求参数：
        modelId:图册ID
        reverse：排序方式：0  倒序； 1 正序
        pageNo：页码
        pageSize：每页行数

 返回参数：
{
    "comments": [
        {
            "1": {
                "client": 客户端标识,
                "content": 评论内容,
                "floor": 楼层,
                "id": 评论id,
                "name": "来自Android客户端网友",
                "time": 发布时间,
                "userId": 用户ID
            },
            "current": "1",
            "expand": 是否展开,
            "support": 顶的数量
        }
    ],
    "docUrl": "http://mrobot.pconline.com.cn/v3/cms/articles/0",
    "hot-comments": [],
    "pageCount": 1,
    "pageNo": 1
}

2.8 图赏 - 图册评论

 备注：图册评论
 请求URL：http://cmt.pcauto.com.cn/action/photo_topics/comment/create_utf8.jsp
 请求方式：post 
 是否需要登录：匿名不需要，非匿名需要。
 请求参数：
   id:评论id
   anonymous:是否匿名
   modelId:图册ID
   content:评论内容
   title:文章标题
   replyFloor2:回复的楼层，如果是发表评论则该参数可以不加 [[BR]]
   common_session_id:会话id，如果是匿名则该参数可以不加

返回参数:
{
    "commentId": 评论id,     
    "floor": 楼层,
    "showName": "广东省广州市网友",
    "brief": 回复内容,
    "status": 0,
    "createTime": 创建时间,
    "resultCode": 0,
    "resultMsg": "您的评论已经成功发表。注：评论在审核后才能出现在列表中,谢谢！",
    "userId": -1
}

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版本用于区分帖子页是否显示投票帖未登陆情况下的登陆按钮