wiki:pcauto_4.5.2/interface

Version 35 (modified by liguokai, 11 years ago) (diff)

--

Table of Contents

  1. 1.基本约定
  2. 2.接口列表
    1. 2.1 获取用户评论回复列表
    2. 2.2 获取系统消息
    3. 2.3 团购活动
      1. 2.3.1 团购活动列表
      2. 2.3.2 发起团购
      3. 2.3.3 团购活动详情页

1.基本约定

接口通用参数
req_enc=utf-8(必须放url后面)
resp_enc=utf-8(必须放url后面)
common_session_id=xxxx(以cookies中的优先)

接口URL: 接口URL
必填参数：参数名=xxx(多种情况用括号解析)
非必填参数：参数名=xxx(多种情况用括号解析)
说明文档参数：添加某特定参数可以直接看接口文档
是否需要登录：是,否
返回格式：json,ssi,xml
缓存方式：接口缓存（接口中返回的响应头里面的 Cache-Control），对象缓存（）
缓存时间：缓存时间
返回结果：结果可能情况

2.接口列表

2.1 获取用户评论回复列表

已上线
请求url:http://mrobot.pcauto.com.cn/v3/bbs/getCommentReplyReminds?pageNo=1&pageSize=20&common_session_id=DA4C99E3FDF2FDE5324ECBF12E49FA01455967336934FC30&contentAll=true
说明:这个是旧接口，V4.5.2此接口返回数据新增字段topicUrlBase——原文章/图赏的链接地址，用于区分文章评论回复或者图赏评论回复。其他没有任何改动。

2.2 获取系统消息

已上线
接口URL：http://mrobot.pcauto.com.cn/v3/bbs/getSysNotice?pageNo=1&pageSize=20&common_session_id=DA4C99E3FDF2FDE5324ECBF12E49FA01455967336934FC30&status=-1
源接口：url:http://bip.pcauto.com.cn/intf/sysnotice.jsp?act=find&groupType=0&common_session_id=1EDAF266A5069CC86B3CCD35C67556B44CCA9329A316EE84&resp_enc=UTF-8&siteId=2&status=-1&pageNo=1&pageSize=20&req_enc=UTF-8pageNo=1&pageSize=20&common_session_id=DA4C99E3FDF2FDE5324ECBF12E49FA01455967336934FC30&contentAll=true
源接口文档位置：http://trac.pc.com.cn/iphone/wiki/pcauto_4.2.0/interface#a2.10获取系统消息接口清零系统消息
说明:之前的版本获取系统消息，客户端直接使用源接口；V4.5.2开始使用mrobot同事提供的接口
必填参数：
    status=-1(-1为已读和未读，0表示未读，1表示已读)
    common_session_id 登录session
非必要参数：
    pageNo=页码
    pageSize=一页条数，默认20，最大500
是否需要登录：是
返回格式：json
缓存方式：无
返回结果：
    {
    "pageCount": 100,
    "pageNo": 1,
    "pageSize": 6,
    "resultList": [
        {
            "accountId": 25180941,
            "content": "您所在的车友会 主题车友会_秋 发起了一个新的活动阳江游，请前往参加！",
            "createTime": 1416477607000,
            "groupSend": 0,
            "groupType": 0,
            "id": 114380466,
            "resultText": "",
            "senderId": 0,
            "siteId": 2,
            "status": 1,
            "type": {
                "description": "论坛的系统通知,内容由论坛自己填写",
                "groupType": 0,
                "id": 2004,
                "name": "系统通知",
                "siteId": 2,
                "templateId": 2004
            },
            "typeId": 2004
        }],
      total:200
      }

2.3 团购活动

2.3.1 团购活动列表

    请求mrobot接口：http://mrobot.pcauto.com.cn/v3/price/activityListv45/3?pageNo=1&pageSize=1
    应用端接口：http://dev3.pcauto.com.cn:9977/autoMall/interface/auto_mall_gct_list_json.jsp?regionId=3
    请求参数：
    areaId：城市ID（必须，默认值1）
    manufacturerId：车厂ID（可选）
    pageNo：页码（默认1）
    pageSize：每页条数（默认20）
    返回结果：
    {
    "data": [
        {
            "banner": "http://img.pconline.com.cn/images/upload/upc/tx/tuangou/1411/14/c0/34350_1415973025778_500x200.jpg",  //购车团主图500x200px
            "beginTime": "2014/11/14 00:00:00",   //开始时间
            "brandName": "凯迪拉克(进口)",        //车厂名称
            "endTime": "2014/12/12 23:59:59",     //结束时间
            "id": 349,                            //购车团ID
            "maxDiscount": 5,                     //最高优惠,单位万.
            "orderCount": 2,                      //活动报名人数
            "photo": "http://img.pconline.com.cn/images/upload/upc/tx/auto5/1403/18/c3/32200468_1395112948222_180x135.jpg",  //最大优惠车系主图,180x135像素 
            "priceTitle": "最高优惠",             //价格标题
            "serialGroupNames": "凯迪拉克SRX",    //车系名称串(最多5个)
            "title": "凯迪拉克厚惠无欺 万元优惠超值惊喜",   //购车团标题
            "url": "http://dev3.pcauto.com.cn:9977/gct/r3/g349/"  //购车团链接
        }
    ],
    "pageCount": 14,   //总页数
    "pageNo": 1,       //页码
    "pageSize": 1,     //页面条数
    "total": 14        //总条数
    }

2.3.2 发起团购

    请求方式：POST
    请求mrobot接口：http://mrobot.pcauto.com.cn/v3/search/mallPost
    应用端接口：http://dev3.pcauto.com.cn:9977/autoMall/gct/action/do_order.jsp
    请求参数格式：
    key：param
    value：
    {
      "userName": "huixuan",
      "regionId": 1,
      "isInitMsg": 1,
      "origin": 3,
      "phone": 13360009613,
      "carSerialId" : 4313,
      "referer" : "http://mrobot.pcauto.com.cn/autobuy/"
    }
    返回参数：
    ｛
        code：200，
        msg：报名成功
     ｝
204 - 表单必填参数不完整
205 - 活动结束，不能报名
206 - 活动未审核，不能报名
207 - 活动审核失败，不能报名
500 - 系统错误

注意: （关于referer值）购车APP填写固定值:http://mrobot.pcauto.com.cn/autobuy/   用于记录报名来源于购车app
          (关于carSerialId值）isInitMsg=1时为必须
参数说明如下表：
参数名称参数名类型说明是否必须
网友姓名userNameString 必须
网友城市regionIdLong 必须
网友电话phoneString 必须
网友IPipString 非必须
平台来源originint0未知,1:web,2:wap,3:IOS,4:Android,5:WP,6:杂志必须
是否三人行isInitMsgint0:购车团报名,1:三人行必须
APP应用IDappKeyString 非必须
来源渠道IDchIdString 非必须
设备IDdevIdString 非必须
车系IDcarSerialIdlongisInitMsg=1时为必须必须

2.3.3 团购活动详情页

    mrobot线上URI：  http://mrobot.pcauto.com.cn/v3/price/activityDetailv45/{id}?areaId=1&modelId=0&name=text&tel=13455455545&dId=364171E5-73FE-4907-9C3F-F5D47B355F2F&origin=${origin}
    示例： http://mrobot.pcauto.com.cn/v3/price/activityDetailv45/347?areaId=3&modelId=0&name=text&tel=13455455545&dId=C592AA63-9758-4594-B161-2B5780F89F40 &origin=1
    HTTP请求方式：GET 
    返回格式：html 
    请求参数：

    参数名	类型	必须	说明
    id	        number	YES	团购活动id
    areaId	number	YES	城市id
    modelId	number	NO	车型id，没有情况下传0
    dId	        number	YES	设备id
    name	string	NO	用户的名字
    tel	string	NO	用户的电话号码
 跳转协议：
   点击电话的协议：pcaction://webview_tel/电话号码（如有分机，“转”要改为“,”）
   点击提交信息按钮协议：pcaction://tuan-detail-click-result?name=xx&tel=xx&code=xxx

    name：用户的姓名
    tel：用户的电话号码
    code：提交后返回的状态码

    code的规则：
    200 - 报名成功
    204 - 表单必填参数不完整
    205 - 活动结束，不能报名
    206 - 活动未审核，不能报名
    207 - 活动审核失败，不能报名
    500 - 系统错误