wiki:pcauto_4.2.0/interface

Version 7 (modified by maozhijun, 12 years ago) (diff)

--

Table of Contents

  1. 1.基本约定
  2. 2.接口列表
    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 收集推送token接口
    12. 2.12 获取他人信息接口
    13. 2.13 获取他人最新动态接口
    14. 2.14 获取他人帖子列表
    15. 2.15 获取他人评论列表
    16. 2.16 获取爱车列表
    17. 2.17 获取他人好友列表
    18. 2.18 关注好友
    19. 2.19 精准选车-车系列表接口

1.基本约定

接口默认的字符编码是UTF-8，接口需要实现对req_enc和resp_enc参数的支持

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

2.接口列表

2.1 头像以及昵称修改

修改昵称
接口URL:http://my.pcauto.com.cn/intf/syncNickName.jsp

必填参数：
act:save
nickName:昵称

提交方式：POST
是否需要登录：是
返回格式：json 
缓存方式：无
缓存时间：无
返回结果：{"code":0}表示成功, {"code":非0,"message":"提示"}

修改头像
接口URL:http://upc.pcauto.com.cn/upload_head.jsp

必填参数:
二进制图片数据

提交方式：POST
是否需要登录：是
返回格式：json 
缓存方式：无
缓存时间：无
返回结果： 成功：{retCode: 0} 失败：{retCode: xxx}

2.2 获取用户信息

接口URL:http://mrobot.pcauto.com.cn/v3/bbs/getUserInfo

必填参数:
无

提交方式：GET
是否需要登录：是
返回格式：json 
缓存方式：无
缓存时间：无

返回结果： 
{
"image":头像
"isVip":是否认证车主
"level":用户级别
"name":用户名
"nickname":用户昵称
"serialId":认证车系ID
"serialName":认证车系名
"userId":用户ID
}

2.3 验证码和发私信

验证码接口
接口URL:http://captcha.pcauto.com.cn/captcha/v.jpg
无参数
返回一张验证码图片

发私信接口
接口URL:http://bip.pcauto.com.cn/intf/message.jsp?act=create
必填参数：
accountId:发送给某个用户
content:消息内容
captcha:验证码

            /*
             * 发送限制 add by handy 2012.04.01
             * 1.post 2.验证码 3.黑名单
             * 4.邮箱绑定,该限制仅限於2012-01-01起注册的用户 edit by handy 2012.04.10
             * 5.发送频率 50次/ID/24H
             * 6.白名单最多一次发送50个用户，非白名单则每次只能发一个 7.添加关键词库过滤
             */

结果返回
{code:0,message:"提示"}

2.4 我的论坛接口

接口URL:http://mrobot.pcauto.com.cn/v3/bbs/myTopics/13128876?pageNo=1&pageSize=20&maxLength=20
接口是否已经完善:否
1.参数增加删选类型,主贴|回帖|精华
2,返回数据增加主|回帖标识,阅读数,主贴标题
3,如果是回帖则增加回复内容,主贴作者ID和呢称

2.5 我的收藏夹论坛列表

接口是否已经完善:否

2.6 我的评论

接口是否已经完善:否

2.7 我的好友列表

包括关注的好友和粉丝,用一个状态来标识

接口是否已经完善:否

2.8 收到的私信列表

接口URL:http://bip.pcauto.com.cn/intf/message.jsp
必填参数：
act=find
siteId=网站ID（1是电脑网，2是汽车网，3是游戏网，4是女性网，5是亲子网，6是家居网）
status=-1(-1为已读和未读，0表示未读，1表示已读)

非必要参数：
pageNo=页码
pageSize=一页条数，默认20，最大500

是否需要登录：是
返回格式：json 
支持跨域：是
支持回调：是
缓存方式：无
缓存时间：无

返回结果：
{
    total: 总的条数
    pageNo: 页码
    pageCount: 页数
    pageSize: 每页条数
    resultList:{
        id: 消息ID
        content: 消息内容
        createTime: 发送时间
        status: 阅读状态
        accountId: 用户ID
        senderId: 发送者ID
        replyId: 回复ID
        showStatus: 显示状态
    }
}

2.9 发出的私信列表

接口URL:http://bip.pcauto.com.cn/intf/message.jsp
必填参数：
act=findOut
siteId=网站ID（1是电脑网，2是汽车网，3是游戏网，4是女性网，5是亲子网，6是家居网）
status=-1(-1为已读和未读，0表示未读，1表示已读)

非必要参数：
pageNo=页码
pageSize=一页条数，默认20，最大500

是否需要登录：是
返回格式：json 
支持跨域：是
支持回调：是
缓存方式：无
缓存时间：无

返回结果：
{
    total: 总的条数
    pageNo: 页码
    pageCount: 页数
    pageSize: 每页条数
    resultList:{
        id: 消息ID
        content: 消息内容
        createTime: 发送时间
        accountId: 用户ID
        receiverIds: 发送者ID
        receiverId: 发送者ID
    }
}

2.10 获取系统消息接口

接口URL:http://bip.pcauto.com.cn/intf/sysnotice.jsp

必填参数：
act=find
siteId=网站ID（1是电脑网，2是汽车网，3是游戏网，4是女性网，5是亲子网，6是家居网）
status=-1(-1为已读和未读，0表示未读，1表示已读)

非必要参数：
typeIds=消息分类，开发人员提供
groupType=消息分组，默认全部，开发人员提供
status=0是未读，1是已读，默认-1是全部
startDate=开始时间
endDate=结束时间
beforeDay=在某个时间前
pageNo=页码
pageSize=一页条数，默认20，最大500
noTemplate=true不需要模板，false需要模板，默认是false

是否需要登录：是
返回格式：json 
支持跨域：是
支持回调：是
缓存方式：无
缓存时间：无

返回结果：
{
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.11 收集推送token接口

token数据放在passport2,赖子粼负责
接口URL:
接口是否已经完善:否

2.12 获取他人信息接口

接口URL:
接口是否已经完善:否

2.13 获取他人最新动态接口

返回html页面
接口URL:
接口是否已经完善:否

2.14 获取他人帖子列表

接口URL:
接口是否已经完善:否

2.15 获取他人评论列表

接口URL:
接口是否已经完善:否

2.16 获取爱车列表

接口URL:http://my.pcauto.com.cn/intf/getCars.jsp
参数
act{
=getCars 获取该用户所有爱车；
=getCarSeries获取该用户的添加的车型；
=getCarModels获取该用户的添加的车系；
}
accountId = (不传此参数，将获取登录ID，)；
pageNo = (次参数不传，则为默认为1，即第一页);
pageSize = (次参数不传，则为默认为20，最小为1，最大为100);
callback = (回调函数)
返回值：
失败:{"code":-1,"message":""}
成功:{
    "total":5,
    "pageNo":1,
    "pageCount":1,
    "pageSize":20,
    "resultList":[
        "createTime":"2013-11-28 08:24:21",
        "accountId":8749870,
        "carSeriesId":4580,
        "carModelId":0,
        "updateTime":"2013-11-28 08:24:21",
        "carPic":"http://img.pconline.com.cn/images/upload/upc/tx/auto5/1311/17/c2/28719139_1384678383261_270x202.jpg",
        "brandId":932,
        "buyPlaceId":0,
        "id":270094,
        "driveStatus":0,
        "buyPlace":null,
        "name":"残缺的F5",
        "brand":" 长城汽车 ",
        "carSeriesName":"哈弗H6"
    ]
}
注意：
用户须登录；
调用接口时需把common_session_id传过来；
因为act=getCars是旧接口，不能改动，所以没有做任何改变，没有分页，act=getCarSeries, act=getCarModels是新接口，可传分页参数，新旧接口返回json结构不一样。

2.17 获取他人好友列表

接口URL:
接口是否已经完善:否

2.18 关注好友

接口URL:
接口是否已经完善:否

2.19 精准选车-车系列表接口

接口URL:
接口是否已经完善:否