Changes between Initial Version and Version 1 of pcauto_club_3.0.0/api

Timestamp:

10/14/2014 10:02:08 AM (12 years ago)

Author:

xieweijie

Comment:

--

pcauto_club_3.0.0/api

@@ +1 @@
+所有接口文档 http://trac.pc.com.cn/iphone/wiki/pcauto_club_2.0.0/api
+=== 2.4车友会搜索接口 ===
+{{{
+接口URL:/club/getClubByCityOrRegionId.do
+说明:搜索,精确查找,根据id查找，根据主题查找
+
+请求参数：
+provinceId:省id
+cityId:城市ID（无则无须传cityid）
+brandId:品牌id
+seriesId:车系ID
+clubName:车友会名称
+clubId:车友会ID
+userId:用户ID(可选)
+tagId：主题id
+
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回结果：
+"data": [
+             {
+            "logo": 车友会会标
+        “clubBackgroundImg”://顶部背景图片url
+        “levelupTip”:升级提示，0-》不可升级，1-》可升级
+        “applyCount”：待审核人数，
+        “presidentName”：会长昵称
+            "announcement": 公告, 
+            "memberSum": 成员数, 
+            "cityName": 市, 
+            "commentSum": 留言数, 
+            "introduce": 简介, 
+            "provinceName": 省, 
+            "topicSum": 帖子数, 
+            "totalPetrol": 总油值, 
+            "clubId":用户ID,
+            "clubStatus":车友会状态（是否被锁之类）
+            "clubUrl":车友会域名,
+            "level": 等级ID, 
+            "seriesName": 车系名称, 
+            "brandName": 品牌名称,
+            "regionRank": 品牌排名, 
+            "rank":全国排名，
+            "activitySum": 活动数, 
+            "name":车友会名称, 
+            "levelName": 等级名称, 
+            "albumSum": 相册数,
+            "photoSum":照片数
+            "activityName": 最新活动名称
+            "memberId":会员ID,如果有
+            "adminType":成员角色//说明参考2.2
+            "isCheck":true/false 是否签到
+            "forumId":论坛id，用于发帖
+           }
+    ]
+}}}
+
+=== 2.44可选车友会顶部背景图列表 ===
+{{{
+说明:可选车友会顶部背景图列表
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回结果：
+"data": [
+             {
+                “id”:背景id
+                “title”:背景文字
+                “img”:背景图片url
+           },
+           {
+                “id”:背景id
+                “title”:背景文字
+                “img”:背景图片url
+           }
+    ]
+}}}
+
+=== 2.19修改车友会接口===
+{{{
+接口URL:/club/editClub.do
+说明:修改车友会资料
+
+请求参数：
+clubId:车友会ID
+userId：用户Id，从登录信息取
+editType：1》会标修改，2》宣言修改，3》公告修改 4》顶部背景
+content：修改内容（url/宣言/公告/顶部背景，传url）
+
+是否登录:是
+缓存时间:无
+是否分页:否
+
+返回结果：
+{code:0}
+}}}
+
+=== 5.1兑换列表 ===
+{{{
+说明:用于app兑换列表显示
+
+请求参数:
+
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回
+"data": [
+             {
+                “id”:兑换礼品id//看后台设计是否有用
+        “img”:图片url
+        “name”：礼品名称
+        “cost”：兑换所需金币
+        “status”：//0-》马上兑换 1-》缺货
+           },
+            {
+                “id”:兑换礼品id//看后台设计是否有用
+        “img”:图片url
+        “name”：礼品名称
+        “cost”：兑换所需金币
+        “status”：//0-》马上兑换 1-》缺货
+           }
+    ]
+}}}
+
+=== 5.2用户兑换信息 ===
+{{{
+说明：用户金币、兑换信息返回
+
+请求参数：
+登陆信息从session拿，不需要传
+
+是否登录:是
+缓存时间:无
+是否分页:无
+
+返回
+"data": {
+          “userId”:用户id
+          “exchangeCount”:兑换记录总数
+          “goldCount”：金币总数
+          “userName”：用户昵称
+          “userImg”：用户头像
+    }
+}}}
+
+=== 5.3申请兑换 ===
+{{{
+说明：申请兑换提交信息
+
+请求方式：POST
+请求参数：
+giftId:礼品Id
+realName：真实姓名
+provinceId:省id
+cityId:市id，无则不传
+address：地址
+postCode：邮编
+phoneNum：手机号码
+
+是否登录:是
+缓存时间:无
+是否分页:无
+
+返回
+}}}
+
+=== 5.4兑换记录 ===
+{{{
+说明：兑换记录列表
+
+请求参数：
+session获取用户id
+
+是否登录:是
+缓存时间:无
+是否分页:是
+
+返回
+"data": [
+             {
+                “id”:兑换记录id
+                “img”:图片url
+                “name”：礼品名称
+                “cost”：兑换所需金币
+                “time”：兑换时间，返回时间戳
+                “status”：//0-》待发货 1-》已发货，看后台有多少状态，商量返回
+           }，
+       {
+                “id”:兑换记录id
+                “img”:图片url
+                “name”：礼品名称
+                “cost”：兑换所需金币
+                “time”：兑换时间，返回时间戳
+                “status”：//0-》待发货 1-》已发货，看后台有多少状态，商量返回
+           }
+    ]
+}}}
+
+=== 4.7收到的回复（帖子、动态） ===
+{{{
+说明：收到的回复（帖子、动态）
+
+请求参数：
+登陆信息通过session拿
+
+是否登录:是
+缓存时间:无
+是否分页:有
+
+返回
+"data": [
+             {
+        “replyType”：类型，0帖子 1动态
+        “targetId”:点击进入详情用的id
+        “replyId”:回复id,
+        “replyContent”:
+        “replyUserId”:
+        “replyUserName”:
+        “replyUserImg”:
+        “toReplyId”:被回复id
+        “toReplyContent”:
+        “time”:
+          }，
+        {
+        “replyType”：类型，0帖子 1动态
+        “targetId”:点击进入详情用的id
+        “replyId”:回复id,
+        “replyContent”:
+        “replyUserId”:
+        “replyUserName”:
+        “replyUserImg”:
+        “toReplyId”:被回复id
+        “toReplyContent”:
+        “time”:
+          }，
+    ]
+帖子回复和动态回复要求对应返回字段一致
+}}}
+
+=== 2.45主题列表 ===
+{{{
+说明：获取搜索用主题列表
+
+请求参数：
+
+是否登录:否
+缓存时间:无
+是否分页:无
+
+返回
+"data": [
+             {
+                “clubTagId”:主题id
+                “clubTagName”:主题名字
+             }，
+        {
+                “clubTagId”:主题id
+                “clubTagName”:主题名字
+             }，
+    ]
+}}}
+
+=== 2.18创建车友会接口 ===
+{{{
+接口URL:/club/createClub.do
+说明:创建车友会接口
+
+请求参数：
+clubName：车友会名称
+clubUrl:车友会自定义域名(域名后面一截就行)
+provinceId：省ID
+provinceName：省名称
+cityId：城市ID
+cityName：城市名称
+brandId：品牌ID
+brandName：品牌名称
+seriesId：车系ID
+seriesName：车系名称
+introduce：简介
+realName:姓名
+gender：性别(0:男,1:女)
+birthday：出生日期
+clubAddressCityId：城市ID
+clubAddressCityName：城市名称
+clubAddressProvinceId：省ID
+clubAddressProvinceName：省
+postCode:邮编
+address：地址
+phone：联系电话
+qqGroup:Q群号
+code：验证码
+agree：是否同意
+
+是否登录:是
+缓存时间:无
+是否分页:否
+
+返回结果：
+{code:0}
+}}}
+
+=== 6.1 附近的人 ===
+{{{
+说明：附近的人列表
+
+请求参数
+longitude 经度
+latitude 纬度
+
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回
+"data": [
+             {
+                “userId”:用户id
+                “userName”:用户昵称
+                “userImg”:用户头像
+                “sex”：性别
+                “distance”：距离
+                “serialName”：认证车系
+          }，
+         {
+                “userId”:用户id
+                “userName”:用户昵称
+                “userImg”:用户头像
+                “sex”：性别
+                “distance”：距离
+                “serialName”：认证车系
+          }，
+    ]
+}}}
+
+=== 6.2更新用户位置信息 ===
+{{{
+说明：更新用户所在位置
+
+请求方法:POST
+请求参数
+longitude 经度
+latitude 纬度
+session拿userid信息
+}}}
+
+=== 2.29车友会排行榜接口 ===
+{{{
+接口URL:/club/listTopClubWeekly.do
+说明:top10认证人数,全国油值排行榜
+
+请求参数：
+type:0:上周新增认证人数排行,1:上周新增油值排行 2全国排名 3车系排名 4地区排名
+userId:用户id(可选)
+showType:是否需要返回后面数组，用于首页排行榜是否有变化显示，0则返回下面所有信息，1则只返回排名变化（前两个字段），默认0
+
+是否登录:否
+缓存时间:无
+是否分页:否
+
+返回结果：
+{
+    “countryRank”：全国排名
+    “contryRankAsc”:全国排名上升多少，下降则为负数
+    “seriesRank”：车系排名
+    “seriesRankAsc”:车系排名上升多少，下降则为负数
+    “regionRank”：地区排名
+    “regionRankAsc”:地区排名上升多少，下降则为负数
+    以上信息假设user对应无加入车友会则不返回
+    "data": [
+            {
+        "logo": 车友会会标
+        “clubBackgroundImg”://顶部背景图片url
+        “levelupTip”:升级提示，0-》不可升级，1-》可升级
+        “applyCount”：待审核人数，
+        “presidentName”：会长昵称
+            "clubStatus":车友会状态
+            "announcement": "内容含有敏感词，已屏蔽", 
+            "memberSum": 公告, 
+            "cityName": 市, 
+            "commentSum": 留言数, 
+            "introduce":简介
+            "provinceName": 省, 
+            "topicSum": 帖子数, 
+            "totalPetrol": 总油值, 
+            "clubId":用户ID, 
+            "level": 等级ID, 
+            "seriesName": 车系名称, 
+            "regionRank": 品牌排名, 
+            "rank":全国排名，
+            "activitySum": 活动数, 
+            "name":车友会名称, 
+            "levelName": 等级名称, 
+            "albumSum": 相册数, 
+            "activityName": 最新活动名称
+             weekPetrol：上周新增油值（当type为1是有值）
+             weekVipNum：上周新增认证人数（当type为0是有值）
+            “adminType”:成员角色//说明参考2.2
+            "isCheck": true/false 是否签到
+            }
+      ]
+//前20
+ "clubIndexData": [
+            {
+            "logo": 车友会会标
+            "clubStatus":车友会状态
+            "announcement": "内容含有敏感词，已屏蔽", 
+            "memberSum": 公告, 
+            "cityName": 市, 
+            "commentSum": 留言数, 
+            "introduce":简介
+            "provinceName": 省, 
+            "topicSum": 帖子数, 
+            "totalPetrol": 总油值, 
+            "clubId":用户ID, 
+            "level": 等级ID, 
+            "seriesName": 车系名称, 
+            "regionRank": 品牌排名, 
+            "rank":全国排名，
+            "activitySum": 活动数, 
+            "name":车友会名称, 
+            "levelName": 等级名称, 
+            "albumSum": 相册数, 
+            "activityName": 最新活动名称
+             weekPetrol：上周新增油值（当type为1是有值）
+             weekVipNum：上周新增认证人数（当type为0是有值）
+            “adminType”:成员角色//说明参考2.2
+            "isCheck": true/false 是否签到
+            }
+      ]
+//user所加入车友会前后两个，自己，后面两个
+}
+}}}
+
+=== 7.1 任务列表 ===
+{{{
+请求参数
+session拿用户参数
+
+是否登录:是
+缓存时间:无
+是否分页:否
+
+返回
+{
+“disposableMission”:[
+{
+        “missionId”：任务id，或任务类型，每个任务一个
+        “missionName”:”任务名称”
+        “gold”：“加金币数”
+        “limitCount”：上限数//无则返回0
+        “currentCount”：当前数//无则返回0，例如发了多少帖子
+        “status”：有无领取奖励的状态,
+        “dis”:描述
+        “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式
+}//一次性任务
+“commonMission”:[
+{
+        “missionId”：任务id，或任务类型，每个任务一个
+        “missionName”:”任务名称”
+        “gold”：“加金币数”
+        “limitCount”：上限数//无则返回0
+        “currentCount”：当前数//无则返回0，例如发了多少帖子
+        “status”：有无领取奖励的状态
+        “dis”:描述
+        “action”:点击触发,如app内跳转pcautoclub://XXX或直接网址http://xxxx，参考焦点图action处理方式
+}//普通任务
+]
+}
+}}}
+
+=== 7.2领取奖励 ===
+{{{
+说明：点击领取奖励
+
+请求方法：POST
+请求参数
+任务missionId
+session获取用户信息
+
+返回
+}}}
+
+=== 4.2 发动态 ===
+{{{
+请求url:/dyna/createCommentDyna.do,
+    HTTP请求方式:POST,
+    是否需要登录:true,
+    返回格式:json,
+    返缓存方式:无,
+    缓存时间:无,
+    请求参数:
+        clubId 车友会ID（可选）
+        provinceId 发动态省地区id（必选）
+        cityId 发动态市地区id（无则不传）
+        content 留言内容
+        images:[
+               {
+                    url:"http://xxxxx",
+                    width:100 //宽
+                    height:200 //高
+               },
+               {
+                    url:"http://xxxxx",
+                    width:100 //宽
+                    height:200 //高
+               }
+         ]//图片
+    说明:
+    图片上传指令 command:53003 53004 53016 53017 53018 53019 53020
+    返回结果:{
+        code:0                  //错误代码,0:正常返回 1:操作失败 1001:权限类错误 1002:数据类错误 1003:用户无登陆
+        message: “您还没有登陆”               //错误提示
+}
+}}}
+
+=== 8.1 同城优惠列表 ===
+{{{
+说明：获取同城优惠列表
+
+请求参数
+provinceId 发动态省地区id（必选）
+cityId 发动态市地区id（无则不传）
+
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回
+{
+data:[
+        {
+        “topicId”：帖子id
+        “img”:帖子图片
+        “startTime”优惠开始时间
+        “endTime”优惠结束时间
+        “title”：帖子标题
+        }，
+        {
+        “topicId”：帖子id
+        “img”:帖子图片
+        “startTime”优惠开始时间
+        “endTime”优惠结束时间
+        “title”：帖子标题
+        }
+]
+}
+}}}
+
+=== 8.2同城首页信息 ===
+{{{
+说明：同城首页信息，包括同城车友会（<3个），同城优惠（<5个）
+请求参数
+provinceId 发动态省地区id（必选）
+cityId 发动态市地区id（无则不传）
+
+是否登录:否
+缓存时间:无
+是否分页:否
+
+返回
+{
+“sameCityClubCount”:同城车友会总数
+“sameCityPreferentialCount”:同城优惠总数
+“sameCityClubData”:[
+        {
+            "logo": 车友会会标
+            “clubBackgroundImg”://顶部背景图片url
+            “levelupTip”:升级提示，0-》不可升级，1-》可升级
+            “applyCount”：待审核人数，
+            “presidentName”：会长昵称
+            "announcement": 公告, 
+            "memberSum": 成员数, 
+            "cityName": 市, 
+            "commentSum": 留言数, 
+            "introduce": 简介, 
+            "provinceName": 省, 
+            "topicSum": 帖子数, 
+            "totalPetrol": 总油值, 
+            "clubId":用户ID,
+            "clubStatus":车友会状态（是否被锁之类）
+            "clubUrl":车友会域名,
+            "level": 等级ID, 
+            "seriesName": 车系名称, 
+            "brandName": 品牌名称,
+            "regionRank": 品牌排名, 
+            "rank":全国排名，
+            "activitySum": 活动数, 
+            "name":车友会名称, 
+            "levelName": 等级名称, 
+            "albumSum": 相册数,
+            "photoSum":照片数
+            "activityName": 最新活动名称
+            "memberId":会员ID,如果有
+            "adminType":成员角色//说明参考2.2
+            "isCheck":true/false 是否签到
+            "forumId":论坛id，用于发帖
+           }
+]//前三个
+“preferentialData”:[
+        {
+        “topicId”：帖子id
+        “img”:帖子图片
+        “time”帖子创建时间
+        “title”：帖子标题
+}
+]//前5条
+}
+}}}
+
+=== 8.3同城动态 ===
+{{{
+说明:根据地区ID,返回车友动态列表
+请求参数：
+provinceId 发动态省地区id（必选）
+cityId 发动态市地区id（无则不传）
+是否登录:否
+缓存时间:无
+是否分页:是
+
+返回结果：
+{
+    "data": [
+             {
+             "postCount":回复数
+             "pubTime": 发布时间, 
+            "authorId": 作者ID, 
+            "forumId": 16160, 
+            "authorName": 作者名称, 
+            "nickname":作者昵称,
+            "contribution": 贡献油值, 
+            "dynaInfoId",动态ID
+            "authorPhoto": 作者头像, 
+            "isRecommend": 是否是推荐,
+            “content”:动态内容
+            "images":[
+                {
+                        “url”:http://xxxx.jpg,
+                        //真实宽度
+                        “width”:960,
+                        //真实高度
+                        “height”:1000,
+                        //质量参数,默认为0，10月上线
+                        "qua":80
+                },
+                {
+                        “url”:http://xxxx.jpg,
+                        //真实宽度
+                        “width”:960,
+                        //真实高度
+                        “height”:1000,
+                        //质量参数,默认为0，10月上线
+                        "qua":80
+                }
+                ]
+           }
+        ]
+}
+}}}
+
+=== 8.4我的二维码 ===
+{{{
+我的二维码（参考车友会二维码）
+扫描结果
+http://用户主页?action=pcautoclub://user-center/用户id
+}}}
+
+=== 8.5经纬度获取城市 ===
+{{{
+说明：根据经纬度获取城市
+
+请求参数
+longitude 经度
+latitude 纬度
+
+返回
+ {
+     areaCode:省id
+     areaName:省名字
+     cityCode:城市ID//如无城市，则id为0
+     cityName:城市名字//无则为空字符串
+ }
+}}}
+
+=== 8.6论坛首页 ===
+{{{
+说明：论坛首页-猜你喜欢（客户端4.5新增接口，由于车友会现实样式不同，需要增加thumbImg字段，显示缩略图，是否在客户端接口上加字段还是新开接口，后台同事自行确认）
+
+开发完成，连代理192.168.22.242 8888即能拿到数据或者页面
+    请求url:http://mrobot.pcauto.com.cn/v3/bbs/guessYouLike
+    HTTP请求方式:GET
+    是否需要登录:false
+    返回格式:json
+    缓存方式:接口缓存
+    缓存时间:60分钟
+    请求参数:第一次进到论坛首页的时候，既没有cookie，也没有visitedFid， 就使用热门论坛的，这个逻辑交给app客户端处理，由客户端调用热门论坛的接口获取数据拼接visitedFid
+    cookie
+    visitedFid：访问过的版块id以D分隔，非必须参数
+    请求后端url：http://bbs.pcauto.com.cn/intf/guessYouLike.do?smallImg=true&bbsImgOnly=true&type=json&imgCount=3&viewCount=true
+    说明:
+    visitedFid          访问过的版块id以D分隔，非必须参数
+    type                输出格式,默认js,可以为json
+    var                 当输出为js时,保存数据的变量名,默认为topiclist1
+    containCoverOnly    是否只出含封面图的精华,默认false
+    bbsImgOnly          是否只出汽车论坛上传的图片,默认false
+    smallImg            是否把图片转为120x80格式,默认false
+    imgCount            每个帖子出的图片数量,默认2
+    viewCount           值为true，表示出浏览数量
+    返回结果:(最多60个)
+[
+    {
+        "datatime": "2014-04-25 11:04",
+        "datatimemillis": 1398395080000,
+        "desc": "买车过程太痛苦了！不想回忆了！[无语]开始看过很多车，雅阁，CC，君越，胜达，3系，C级，还有蒙迪欧。蒙迪欧第一眼就爱上了，外形控的不二选择！高科技配置很多！完...",
+        "forum": "奥迪A4L论坛",
+        "forumId": 14034,
+        "forumlink": "http://v15.pcauto.com.cn/forum-14359.html",
+        "replycount": 100,
+        "topic": "40TFSI个运作业来了！谁说没媳妇合影就不能火！！！！！",
+        "topicId": 4720505,
+        "topicimg": [],
+        "topiclink": "http://v15.pcauto.com.cn/topic-4720505.html",
+        "userId": 30421242,
+        "userface": "http://i1.3conline.com/images/upload/upc/face/30/42/12/42/30421242_100x100",
+        "userlink": "http://v21.pcauto.com.cn/30421242",
+        "username": “qz30421242”,
+        "thumbImg": 缩略图
+    },
+    {
+        "datatime": "2014-04-09 23:51",
+        "datatimemillis": 1397058682000,
+        "desc": "      跟拍奥迪与嫩模今日独家奉上精美图集～名车名模，快说，你对哪个心动了呀？      啦啦啦，上图啦，看美女啦！      [图]先来张内饰，甜甜圈是不是特别的显眼...",
+        "forum": "奥迪A4L论坛",
+        "forumId": 14034,
+        "forumlink": "http://v15.pcauto.com.cn/forum-14359.html",
+        "replycount": 39,
+        "topic": "【名模名车】奥迪或嫰模，你要哪个？多图杀猫～",
+        "topicId": 4639676,
+        "topicimg": [],
+        "topiclink": "http://v15.pcauto.com.cn/topic-4639676.html",
+        "userId": 8803955,
+        "userface": "http://i1.3conline.com/images/upload/upc/face/88/03/95/5/8803955_100x100",
+        "userlink": "http://v21.pcauto.com.cn/8803955",
+        "username": “爱恨不平行”,
+        "thumbImg": 缩略图
+    }
+]
+}}}
+
+=== 8.7wap页面 ===
+{{{
+任务：
+手机绑定帐号
+申请成为认证车主
+有一个帖子被设置为精华帖
+发表1个主题帖
+
+其他：
+常见问题（创建车友会）
+}}}