wiki:pcauto_4.0.0/interface

Version 49 (modified by leijingtang, 13 years ago) (diff)

--

Table of Contents

  1. 1.基本约定
  2. 2.接口列表
  3. 需要登录的接口，cache-control=600 ；分开优先级低和主动请求两种，前者用cacheFirst，后者用noCache
    1. 2.1 左侧主菜单
    2. 2.2 默认订阅栏目
    3. 2.3 头条和车系聚合页
    4. 2.4 赞和踩
    5. 2.5 搜索栏目文章
    6. 2.6 新消息
    7. 2.7 您可能对以下内容感兴趣
    8. 2.8 收藏夹信息---文章
    9. 2.9 收藏夹信息---帖子
    10. 2.10 收藏夹信息---车型
    11. 2.11 添加收藏
    12. 2.11 删除收藏夹信息
    13. 2.12 获取我的订阅
    14. 2.13 我的消息---提醒
    15. 2.14 删除提醒
    16. 2.15 删除私信
    17. 2.16 我的消息---私信
    18. 2.18 获取个人私信
    19. 2.19 发送私信
    20. 2.20 我的帖子
    21. 2.22 增加订阅
    22. 2.23 删除订阅
    23. 2.24 车型库首页品牌列表
    24. 2.25 精准选车条件
    25. 2.26 车系页接口
    26. 2.28 车主点评列表
    27. 2.29 车型图片列表
    28. 2.30 论坛帖子列表
    29. 2.31 询底价页
    30. 2.32 经销商详情页
    31. 2.33 车型终端页
    32. 2.34 车型对比页
    33. 2.35 车主点评终端页
    34. 2.36 预约驾车页

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的最顶部，实现类似下面的代码：

        String queryString = request.getQueryString();
        String requestEncoding = getParam(queryString,"req_enc");
        String responseEncoding = getParam(queryString,"resp_enc");
        if(isNotBlank(requestEncoding)){
            request.setCharacterEncoding(requestEncoding);
        }
        if(isNotBlank(responseEncoding)){
            response.setCharacterEncoding(responseEncoding);
        }

4.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。

5.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号。

2.接口列表

需要登录的接口，cache-control=600 ；分开优先级低和主动请求两种，前者用cacheFirst，后者用noCache

2.1 左侧主菜单

    url:
       汽车网：待定
    作用:madmin的配置项
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：否                          
    请求参数：none
    返回参数：

[{
"title":"首页",  // 菜单标题
"controller":"PCInformationController",  // 根控制器的名字
"url":"http://www.baidu.com"   // 如果是如专栏之类的webview界面，会出这个链点；否则出空字符串
}]

2.2 默认订阅栏目

    url:
       汽车网：待定
    作用:获取默认订阅的栏目，cms的接口，不走mrobot代理
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：否               
    请求参数：none
    返回参数：

[{
"serialId":123,  // 车系id
"name":"福特福克斯",  // 车系名称
}]

2.3 头条和车系聚合页

    url:
       汽车网：类似http://mrobot.pcauto.com.cn/v2/cms/channels/1，http://mrobot.pcauto.com.cn/v4/cms/serials/车系id 。
    作用:获取头条数据，
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：否                       
    请求参数：
          pageSize  // 每页加载量，默认20条
          pageNo    // 页码
          serialIds   // 已经订阅的车系id，逗号分割；车系聚合接口不需要这个参数
    返回参数：
"pageNo":123,
"pageSize":20,
"total":300,   // 栏目内容总数，最多300条
"contents": [
{
"count": 93,     // 如果是文章则为评论数，如果是帖子则为楼层数，如果是图集则为图片张数
"id": 2965125,     // 文章、帖子或者图集id
"type":"",                // 类型，目前包含article, album和topic三个值
"img": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",   //导读图
"title": "[直播]成都车展探馆：奥迪RS5 Coupe亮相",      //内容标题
"chl":"所属栏目"    // 所属栏目，指3.6.0mrobot整理的栏目
"ups":123,    // 赞的数量
"downs":123    // 踩的数量
},
...
],
"focus":[
{
"img:":"http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",
"id":111111  // 同上
}
],
topContents:[],   // 规则按照http://mrobot.pcauto.com.cn/v2/cms/channels/1里的topArticles，车系聚合里没有这个字段
topFocus:[]         // 规则按照http://mrobot.pcauto.com.cn/v2/cms/channels/1里的topFocus，车系聚合里没有这个字段

2.4 赞和踩

    url:
       汽车网：待定
    作用:对某个对象赞或者踩
    使用范围:汽车网app
    备注：该接口需要防止刷数据

    HTTP请求方式：post                         
    是否需要登录：否                          
    请求参数：
          id，文章、帖子或者图集id
          type，article、topic或者album
          action，up或者down，分别代表赞和踩
    返回参数：

{
"id":123             // 文章、帖子或者图集id
"type":"article",  // article、topic或者album
"resultCode":0,  // 0表示成功，其他是失败
"msg":"提示信息", // 提示信息
"ups":123,         // 赞的数量
"downs":123      // 踩的数量
}

2.5 搜索栏目文章

    url:
       沿用http://mrobot.pcauto.com.cn/v2/cms/channels/栏目id
    作用:点击文章终端的栏目按钮，出该车系的栏目文章
    使用范围:汽车网app
    备注：添加serialId，在原来的基础上过滤出属于该车系的文章

    HTTP请求方式：get                         
    是否需要登录：否                          
    请求参数：
          serialId，车系id，可选参数
    返回参数：
          参考3.6.0的栏目接口 http://mrobot.pcauto.com.cn/v2/cms/channels/2

2.6 新消息

    url:
       汽车网：待定
    作用:获取个人中心的新消息的数量(系统消息和短消息)
    使用范围：汽车网app
    备注：提醒包含一下几种
1.我发的帖子，别人回帖
2.我发的回帖，别人回复
3.我发的文章评论，别人回复

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：
             common_session_id:用户登陆后获得的认证id
    返回参数：
{
    "noticeCount": 0, // 提醒数
    "msgCount": 0  // 短消息数
}

2.7 您可能对以下内容感兴趣

    url:
       汽车网：待定
    作用:获取可能感兴趣内容
    使用范围：汽车网app
    备注：cms接口，由编辑运营，mrobot代理

    HTTP请求方式：get                         
    是否需要登录：否                          
    请求参数：
    返回参数：
{
  "favortie": [
      {
        "id": 123,
        "name": "鬼知道咩",
        "img":""
      }
    ]
}

2.8 收藏夹信息---文章

url:
       汽车网：待定
    作用:收藏夹信息---文章
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：
          common_session_id，
          pageNo，
          pageSize
    返回参数：
{
"pageNo":123,
"pageSize":20,
"total":300,   
"articleList": [
{
"id": 2965125,     // 文章id
"img": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",   //导读图
"title": "[直播]成都车展探馆：奥迪RS5 Coupe亮相",      //内容标题
"chl":"所属栏目"    // 所属栏目，参考2.3头条和车系聚合页
"ups":123,    // 赞的数量
"downs":123    // 踩的数量
},
...
]
}

2.9 收藏夹信息---帖子

url:
       汽车网：待定
    作用:收藏夹信息---帖子
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：
          common_session_id，
          pageNo，
          pageSize
    返回参数：
{
          "pageNo":1,
          "pageSize":20,
          "total":300,
          “topicList”:[//帖子
            	 {
			“id”:1234,  //收藏id
                        “topicId”：145，//帖子id
  	            	“name”:”宝马3系太好了”, //帖子标贴
                        "ups":123,
                        "downs":123,
                        "forumName":"啊啊啊"  //所属论坛
		},
             	{
			“id”:1234,  //收藏id
                        “topicId”：145，//帖子id
  	                “name”:”宝马3系太好了”, //帖子标贴
                        "ups":123,
                        "downs":123,
                        "forumName":"啊啊啊"  //所属论坛
            	 }
            ]
}

2.10 收藏夹信息---车型

url:
       汽车网：待定
    作用:收藏夹信息---车型
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：
          common_session_id，
          pageNo，
          pageSize
    返回参数：
{
          "pageNo":1,
          "pageSize":20,
          "total":300,
          “modelList”:[//车型
            	 {
			“id”:1234,  //爱车id
                        “modelId”：145，//车型id
  	 	 	“name”:”宝马”, //车型名字
			“image”:http://mrobot.pcauto.com/baoma.jpg,   //车型小图url
                        "price":"",
                        "serialName":"车系名称"
             	},
             	{
			“id”:1234,  //爱车id
                        “modelId”：145，//车型id
  	 	 	“name”:”宝马”, //车型名字
			“image”:http://mrobot.pcauto.com/baoma.jpg, //车型小图url
                        "price":"",
                        "serialName":"车系名称"
             	}
             ],
}

2.11 添加收藏

url:
       汽车网：待定
    作用:添加收藏
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：session;  type:1/2/3; ids=123,433,577
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.11 删除收藏夹信息

url:
       汽车网：待定
    作用:删除收藏夹信息
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：session;  type:1/2/3; ids=123,433,577
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.12 获取我的订阅

url:
       汽车网：待定
    作用:我的订阅
    使用范围:汽车网app
    备注：cache-control=600

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：session
    返回参数：
{
  "result": {
    "cars": [
      {
        "serialId": 123,
        "name": "鬼知道咩",
        "img":"",
       "price":"$12"
      }
    ]
  },
  "code": 1,
  "msg": ""
}

2.13 我的消息---提醒

url:
       汽车网：待定
    作用:我的消息---提醒
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：session
    返回参数：
{
  "result": {
    "remind": [
      {
        "id": 123123,
        "type": 1,
        //1回复帖子，2回复评论
        "topicid": 12312,
        "face": "",
        "userName": "xxx",
        "userid": 6546,
        "time": "2013-01-01 02:10",
        "last": "对方回复内容",
        "content": "这次的内容"
      }
    ]
  },
  "code": 1,
  "msg": ""
}
ps：这接口内容有3种
1.我发的帖子，别人回帖
2.我发的回帖，别人回复
3.我发的文章评论，别人回复

2.14 删除提醒

url:
       汽车网：待定
    作用:删除提醒
    使用范围:汽车网app

    HTTP请求方式：post
    是否需要登录：是                          
    请求参数：session，ids=1,2,3
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.15 删除私信

url:
       汽车网：待定
    作用:删除私信
    使用范围:汽车网app

    HTTP请求方式：post
    是否需要登录：是                          
    请求参数：session，ids=1,2,3
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.16 我的消息---私信

url:
       汽车网：待定
    作用:我的消息---私信
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：是                          
    请求参数：session
    返回参数：
{
  "result": {
    "message": [
      {
        "face": "",
        "username": "",
        "userid": 12312,
        "time": "2013-01-01 02:10",
        "content": "这次的内容"
      }
    ]
  },
  "code": 1,
  "msg": ""
}

2.18 获取个人私信

url:
       汽车网：待定
    作用:获取个人私信
    使用范围:汽车网app

    HTTP请求方式：get
    是否需要登录：是                          
    请求参数：session，id
    返回参数：
{
  "result": {
    "face": "",
    "username": "",
    "userid": 12312,
    "message": [
      {
        "time": "2013-01-01 02:10",
        "content": "这次的内容"
      }
    ]
  },
  "code": 1,
  "msg": ""
}

2.19 发送私信

url:
       汽车网：待定
    作用:发送私信
    使用范围:汽车网app

    HTTP请求方式：post
    是否需要登录：是                          
    请求参数：session，userid
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.20 我的帖子

url:
       汽车网：待定
    作用:我的帖子
    使用范围:汽车网app

    HTTP请求方式：get
    是否需要登录：是                          
    请求参数：session，id
    返回参数：
{
  "result": {
    "topics": [
      跟帖子列表的结构
    ]
  },
  "code": 1,
  "msg": ""
}

2.22 增加订阅

url:
       汽车网：待定
    作用:增加订阅
    使用范围:汽车网app

    HTTP请求方式：post
    是否需要登录：是                          
    请求参数：session，ids=1,2,3
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.23 删除订阅

url:
       汽车网：待定
    作用:删除订阅
    使用范围:汽车网app

    HTTP请求方式：post
    是否需要登录：是                          
    请求参数：session，ids=1,2,3
    返回参数：
{
  "result": {
  },
  "code": 1,
  "msg": ""
}

2.24 车型库首页品牌列表

   url:
   备注：在原接口（http://mrobot.pcauto.com.cn/v2/price/brands/）基础上更改
   作用：获取车型库品牌列表
   使用范围：汽车网app
   http请求方式：get
   是否需要登录：否
   请求参数：无
   返回参数：
   在原接口基础上加上字段hot，hot字段结构如下：
   "hot":{
      "id":1,
      "logo":"",
      "name":""
   }

2.25 精准选车条件

   url:
   备注：在原条件接口（http://mrobot.pcauto.com.cn/v3/price/models/criterionv36/）基础上更改；使用xindex
   作用：获取选车条件
   使用范围：汽车网app
   http请求方式：get
   是否需要登录：否
   请求参数：无
   返回参数：
   1）在原接口返回数据加入变速箱条件
   2）所有条件加入“不限”选项

2.26 车系页接口

备注:  原车系页接口

   url:
   作用：获取车系详细数据
   使用范围：汽车网app
   http请求方式：get
   是否需要登录：否
   请求参数：sid   //车系ID
   返回参数：
   {
      “img”:”http://xxxx.jpg”,
      “imgCnt”:123,
      “brand”:”奥迪”,
      “bId”:1,
      “pRange”:”28.50-42.88万”,
      “sName”:”奥迪Q3”,
      “kind”:”中型车”,
      “sections”:[
         {
             “data”:[
                 {
                     “id”:1,
                     “minPrice”:”25.30”,
                     “vPrice”:”25.30-28.50”
                     “title”:””
                 }
             ],
             “title”:””,
             “status”:”在售/停售”,
         }
      ]
   }

2.28 车主点评列表

   url:待定
   作用：获取某车系下的车主点评列表，评分的ui咨询一下设计同事
   使用范围：汽车网app
   是否需要登录：否
   http请求方式：get
   请求参数：sid   //车系ID
   返回参数：
   {
      “list”:[
         {
            “id”:1,
            “sName”:”xxx”,
            “rank”:51,
            “score”:4.8,
            “price”:“”
         }
      ]
   }

2.29 车型图片列表

   url：待定
   作用：按照分类获取车系图片列表
   使用范围：汽车网app
   是否需要登录：否
   http请求方式：get
   请求参数：
      tId   //分类ID
      mId   //车型ID
      cId   //颜色ID
   返回参数：
   {
      “imgs”:[
         {
            bPath:”http://xxxx.jpg”,
            sPath:”http://xxxx.jpg”
         }
      ]
   }

2.30 论坛帖子列表

   url:[http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#point209 原帖子列表接口]在原来接口基础上进行修改[[BR]]
   作用：获取帖子列表
   使用范围：汽车网app
   是否需要登录：否
   http请求方式：get
   请求参数：照旧
   备注：按照4.0规定的算法排序http://trac.pc.com.cn/iphone/wiki/pcauto_4.0.0/dev_requirement/sorting_algorithm；添加了ups和downs两个参数

    返回参数：
{
......
    "pageNo":1,
    "pageSize":50,
    "topicList":[
        {
            "author":{
                "name":"yuking-ouyang",
                "nickname":"yuking-ouyang",
                "userId":23672097
            },
            "createAt":1347978864000,
            "flag":"精",
            "lastPoster":{
                "name":"qz30446664",
                "nickname":"qz30446664",
                "userId":30446664
            },
            "replyCount":87,
            "title":"8.6号新A6L30技术提车作业！！半夜的作品！！",
            "topicId":3322726,
            "uri":"http://bbs.pcauto.com.cn/topic-3322726.html",
            "view":104676，
            "ups":123,
            "downs":123
        },
    ],
......
}

2.31 询底价页

需求：重新设计询底价页
设计稿：待定
url：待定

2.32 经销商详情页

需求：重新设计经销商详情页
设计稿：待定
备注：促销信息怎么来？ url：待定

2.33 车型终端页

需求：重新设计车型终端页
设计稿：待定
url：待定

2.34 车型对比页

需求：更改为整个车型对比页都由HTML实现
设计稿：待定
url：待定

2.35 车主点评终端页

需求：新增页面
设计稿：待定
url：待定

2.36 预约驾车页

需求：新增页面
设计稿：待定
备注：咨询小虎，看提交到什么地方 url：待定