wiki:pcauto_club_2.0.0/api

Version 38 (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活动详情与报名人员名单接口
    12. 2.12活动报名接口
    13. 2.13车友会成员列表接口
    14. 2.14车友会成员管理接口
    15. 2.15车友会入会接口
    16. 2.16车友会留言列表接口
    17. 2.17创建留言与回复留言接口
    18. 2.18创建车友会接口
    19. 2.19修改车友会接口
    20. 2.20域名合法校验接口
    21. 2.21车友会名合法校验接口
    22. 2.22获取手机验证码接口
    23. 2.23中国车友会管理条例页面
    24. 2.24车友会签到接口
    25. 2.25编辑推荐论坛接口
    26. 2.26论坛新帖数与新帖标题接口
    27. 2.27论坛相关车友会接口
    28. 2.28同城车友会列表接口
    29. 2.29车友会排行榜接口
    30. 2.30 取消活动报名接口
    31. 2.31 获取城市列表
    32. 2.32 根据IP获取城市ID
    33. 2.33 入会审核接口
    34. 2.34 获取论坛最新帖子接口
    35. 2.34 获取用户已参加活动列表接口

1.基本约定

通用接口请求参数:
req_enc=utf-8  					请求参数编码
resp_enc=utf-8 					响应返回编码
common_session_id=xxxx 			用户登录凭证,如果接口需要登陆则生效
pageNo=1		 			请求页码(>=1),如果接口返回有分页处理则生效
pageSize=20	 				请求页长度,默认20,如果接口返回有分页处理则生效

通用接口返回参数:
total:18						返回记录总条数,如果接口返回有分页处理则生效
pageNo:1						返回页码(>=1),如果接口返回有分页处理则生效
pageSize:20					返回页长度,如果接口返回有分页处理则生效

测试接口前缀:http://dev18.pcauto.com.cn:8003
上线接口前缀:http://club.pcauto.com.cn

名词解释
接口URL:   接口URL
接口说明:	描述接口的应用场景
请求参数：参数名=xxx
是否登录：是|否,表示接口是否要登陆才能访问
是否分页:  是|否,表示返回的列表有分页处理
缓存时间：xx,设置Response Http Headers Cache-Control:max-age=xx(单位/秒)
返回结果：成功返回结果示例

全局接口返回格式：json

全局接口错误格式:
{
	code:1001			//错误代码,0:正常返回
	message: “您还没有登陆”		//错误提示
}

2.接口列表

2.1 车友会详情接口

整合到:2.4车友会搜索接口
根据车友会ID返回车友会详情

2.2车友会信息与已加入的车友会权限列表接口

接口URL:/club/getJoinedClubList.do
说明:获取车友会信息与已加入的车友会权限列表

请求参数：
uid:用户ID，如果不传，默认是当前登录用户ID

是否登录:是
缓存时间:无
是否分页:是

返回结果：
{"data":[
 {
 "clubId":车友会ID,
 "name":车友会名称,
 "logo":logo的URL,
 "introduce":简介,
 "brandId":品牌ID,
 "brandName":品牌名称,
 "seriesId":车系ID
 "seriesName":车系名称,
 "cityId":城市ID,
 "cityName":城市名称,
 "provinceId":省份ID,
 "provinceName":省份,
"rank":全国排名，为0时，表示暂时没有排名,
 "reginRank":区排名，为0时，表示暂时没有排名,
 "memberNum":会员总人数,
 "vipNum":认证总人数,
 "totalPetrol":总油值,
 "level":等级ID,
 "addressPhone":收货地址——联系号码,
 "addressUserName":收货地址——联系人,
 "addressProvinceId":收货地址——省份ID,
 "addressProvinceName":收货地址——省份名称,
 "addressCityId":收货地址——城市ID,
 "addressCityName":收货地址——城市名称,
 "addressDetail":收货地址——详细地址,
 "addressPostcode":收货地址——邮编,
 "adminType":成员角色，0->普通会员 1->副会长 2->会长,
"userName":用户名称
"userNikeName":用户昵称
"userPhone":用户电话
"userCar":用户爱车
"userProvince":用户所在省
"userCity":用户所在市
"userGener":用户性别，性别,0:男,1:女
}
]
}

2.3首页车友会列表接口

接口URL:/club/getClubByUIdOrRegionId.do
说明:如果用户已登陆并且有加入车友会则返回用户已加入的车友会列表,否则根据IP地址判断用户所在地,并返回所在地车友会列表

请求参数：
common_session_id (可选参数)
regionId:地区ID(可选参数)
两个参数二选一,common_session_id优先

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
    "userId": 用户ID[地区ID], 
    "data": [
             {
            "logo": 车友会会标
            "announcement": 公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce": 简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "brandName": 品牌名称,
            "regionRank": 地区排名, 
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数,
            "photoSum":照片数
            "activityName": 最新活动名称
           }
    ]
}

2.4车友会搜索接口

接口URL:/club/getClubByCityOrRegionId.do
说明:搜索,精确查找,根据id查找

请求参数：
cityId:城市ID
seriesId:车系ID
clubName:车友会名称
clubId:车友会ID

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
    "data": [
            {
	    "logo": 车友会会标
            "announcement": "内容含有敏感词，已屏蔽", 
            "memberSum": 公告, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce":简介
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "regionRank": 地区排名, 
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数, 
            "activityName": 最新活动名称
           }
    ]
}

2.5车友动态接口

接口URL:/topic/listTopicByClubId.do
说明:根据车友会ID,返回车友动态列表

请求参数：
clubId:车友会ID

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
    "clubId": clubId, 
    "data": [
             {
	     "pubTime": 发布时间, 
            "topicTitle": 帖子标题, 
            "forumName": 板块名称, 
            "isPick": 是否是精华, 
            "authorId": 作者ID, 
            "isHasImg": 是否有图片, 
            "image2": 第二张图, 
            "image1": 第一张图, 
            "forumId": 16160, 
            "authorName": 作者名称, 
            "contribution": 贡献油值, 
            "topicId": 帖子ID, 
            "authorPhoto": 作者头像, 
            "image3": 第三张图, 
            "isRecommend": 是否是推荐
           }
	]
}

2.6车友会相册列表接口

接口URL:/album/getAlbumByClubId.do
说明:根据车友会ID,返回相册列表

请求参数：
clubId:车友会ID

是否登录:否
缓存时间:无
是否分页:否

返回结果:
{
    "clubId": 车友会ID, 
    "clubName": 相册名称,
    "data": [
            {
            "photos":[
                {
                "urlSmall":"http://dev2.pconline.com.cn:9191/autoclub/1403/27/c0/1195694_1395912475624_160x120.jpg",
                "urlbig":"http://dev2.pconline.com.cn:9191/autoclub/1403/27/c0/1195694_1395912475624_700.jpg"
                }],
            "albumName":"默认相册",
            "albumId":171,
            "photoSize": 相片数
            }
    ]
}

2.7相册图片列表接口

接口URL:/album/getPhotoByAlbumId.do
说明:根据相册ID返回相片列表

请求参数：
albumId:相册ID

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
"albumId": 相册ID, 
"albumName": 相册名称, 
"data": [
     {
     "urlsmall":小图地址，
     "urlbig":大图地址
     }
      ]
}

2.8上传图片接口

接口URL:/album/uploadPic.do
说明:上传图片到车友会指定相册

请求参数：
albumId:相册ID
userId:用户id，从登录信息取
urls : 格式:名称@路径，多张图片以”,”分割(上传原图url)

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.9创建相册接口

接口URL:/album/updateSaveAlbum.do
说明:创建(修改)相册名称

请求参数：
clubId：车友会ID
userId：用户ID，从登录信息取
albumId:相册ID[若有ablumId，则为修改，为0，则为创建]
name；相册名称

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.10车友会活动列表接口

接口URL:/activity/listActivityByClubId.do
说明:根据车友会ID,返回该车友会活动列表

请求参数：
clubId:车友会ID
common_session_id(可选参数,如果已登陆)

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
"clubId": 
"clubName": 
"data":[
        {
        "activityId"://活动ID,整形
        "title"://活动标题,字符串
        "signupDate"://报名截至日期,整形
        "pic"://活动图片,字符串
        "place"://活动地点,字符串
        "isSignUp"://是否报名,布尔值
        "end"://活动结束日期,整形
        "begin"://活动开始日期,整形
        }
    ]
}

2.11活动详情与报名人员名单接口

接口URL:/activity/getActivityById.do
说明:返回活动详情及活动报名人员名单

请求参数：
activityId:活动ID
common_session_id(可选参数,如果已登陆)

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
    "activityId": 活动ID, 
    "content":活动内容, 
    "createAt": 创建时间, 
    "title": 活动标题, 
    "signupDate": 报名截止时间, 
    "money": 活动费用, 
    "adminType": 用户类别, 
    "isSignUp"：是否报名,
    "place": 活动地点, 
    "createBy": 创建者, 
    "endDate": 活动结束时间, 
    "beginDate": 活动开始时间，
    "data":[
        {
        "name":用户名称
        "nickname":用户昵称
        "joinNum":参加人数
        "phone":联系电话
        }
    ]
}

2.12活动报名接口

接口URL:/activity/applyActivity.do
说明:活动报名

请求参数：
activityId:活动ID
userId：用户ID，从登录信息中取
name；真实姓名
phone：联系电话
joinNum：参加人数
lincensePlate；车牌号
descript：备注信息


是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.13车友会成员列表接口

接口URL:/member/getMemberByClubId.do
说明:获取车友会成员列表接口

请求参数：
clubId:车友会ID
isShowAdmin:1

是否登录:是
缓存时间:无
是否分页:是

返回结果：
{
    "clubId": 车友会ID, 
    "admins": [{管理员
            "name": 用户名称, 
            "userId": 用户ID, 
            "memberId": 用户ID, 
            "type": 用户类别[0：会员，1：副会长，2，会长]
            "photo": 用户头像地址 
        }], 
    "members": [{普通会员,分页在次生效
            "name": 用户名称, 
            "userId": 用户ID, 
            "memberId": 用户ID, 
            "type": 用户类别[0：会员，1：副会长，2，会长]
            "photo": 用户头像地址 
        }],
   "applys": [待审核人员
        {
            "name": "申请人名称",
            "userId": 申请人ID,
            "memberId": 用户ID, 
            "photo":申请人头像
      }]
}

2.14车友会成员管理接口

接口URL:/member/operation.do 
说明:车友会成员管理

请求参数：
clubId：车友会ID
userId：用户ID，从登录信息取
targetId：操作用户对象ID,如果=userid,并且type=4则表示退出该车友会
type:操作类型，1--转让会长，2--设置副会长，3--解除职务，4--移除车友会

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.15车友会入会接口

接口URL:/member/apply.do
说明:加入车友会

请求参数：
clubId;车友会ID
truename:真实姓名
gender：性别
provinceName:省
cityName:市
phone:联系电话
brand:品牌ID
serial:车系ID
brandName:品牌名称
serialName：车系名称

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{
status:-1>处理错误  0>成功  1>没有权限，没有登录  2>参数错误 3>不符合处理条件
desc:信息提示
}

2.16车友会留言列表接口

接口URL:/comment/listCommentByUserClubId.do
说明:获取车友会最新留言与我的留言

请求参数：
clubId：车友会ID
common_session_id(可选，如果传入，则为我的留言，不传入，则为车友会留言)

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
"data": [
	    "image1big":图片1大图,
            "image2small": 图片2小图,
            "image1small":图片1小图,
            "createAt": 发表留言时间,
            "image2big": 图片2,
            "userId": 用户ID,
            "userName": 用户姓名,
            "msg": 留言信息,
            "replays": [
                  {
	          "replayId":回复ID, 
                  "replayName": 回复人名称, 
                  "replayContent":回复内容, 
                  "createAt": 回复时间, 
                  "image1big": 图片1大图, 
                  "image2big": 图片2大图, 
                  "image1small": 图片1小图, 
                  "image2small": 图片2小图,
                  }
	      ]
	],
    "clubId": 车友会ID,
    "clubName": 车友会名称
}

2.17创建留言与回复留言接口

接口URL:/comment/addComment.do
说明:创建与回复留言

请求参数：
clubId:车友会ID
content:回复内容
replyId:回复留言的ID(可选)
imgUrl1 :上传图片1(可选)
imgUrl2 : 上传图片2(可选)

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.18创建车友会接口

接口URL:/club/createClub.do
说明:创建车友会接口

请求参数：
clubName：车友会名称
clubUrl:车友会自定义域名(域名后面一截就行)
provinceId：省ID
provinceName：省名称
cityId：城市ID
cityName：城市名称
brandId：品牌ID
brandName：品牌名称
seriesId：车系ID
seriesName：车系名称
introduce：简介
realName:姓名
gender：性别
birthday：出生日期
clubAddressCityId：城市ID
clubAddressCityName：城市名称
clubAddressProvinceId：省ID
clubAddressProvinceName：省
postCode:邮编
address：地址
phone：联系电话
code：验证码
agree：是否同意

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.19修改车友会接口

接口URL:/club/editClub.do
说明:修改车友会资料

请求参数：
clubId:车友会ID
userId：用户Id，从登录信息取
editType：1》会标修改，2》宣言修改，3》公告修改
content：修改内容（url/宣言/公告）

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.20域名合法校验接口

接口URL:/club/checkClubUrl.do
说明:检查车友会域名是否可用

请求参数：
clubUrl：自定义域名

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.21车友会名合法校验接口

接口URL:/club/checkClubName.do
说明:检查车友会名称是否可用

请求参数：
name：车友会名称

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.22获取手机验证码接口

接口URL:/club/checkClubPhone.do
说明:根据手机号码获取手机验证码

请求参数：
phone：电话

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.23中国车友会管理条例页面

接口页面:http://www.pcauto.com.cn/forum/club/rule/

2.24车友会签到接口

接口URL:/checkIn.do
说明:用户签到车友会

请求参数：
clubId:车友会ID
agent:1
userId:用户ID，从登录信息取

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{
status:0,
desc:{
continuousCheckIns:连续签到次数，
totalCheckIns:总签到次数,
petrol:签到加分值
}
}
失败返回:
{
status:非0,
desc:"错误信息"
}

2.25编辑推荐论坛接口

测试接口URL:http://v15.pcauto.com.cn/intf/hotForums.do
正式接口URL:http://bbs.pcauto.com.cn/intf/hotForums.do
说明:获取编辑推荐,获取指定论坛新帖标题和今日新帖总数

请求参数：
forumIds:论坛ID，多个以“,”分隔(可选参数,如不传则标识编辑推荐)

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
"data":[
{
"forumId":"论坛ID",
"lastTopicName":"最新标题",
"logo":"论坛logo",
"name":"论坛名称",
"todaypostcount":今日回复贴总数
}
]
}

2.26论坛新帖数与新帖标题接口

合并到接口:2.25

2.27论坛相关车友会接口

接口URL:/club/countClubByForumId.do
说明:根据论坛ID返回论坛相关车友会数量

请求参数：
forumId:论坛ID

是否登录:否
缓存时间:无
是否分页:否

返回:
{total：车友会个数}

--------------------------------------------

接口URL:/club/listClubByForumId.do
说明:根据论坛ID返回论坛相关车友会

请求参数：
forumId:论坛ID

是否登录:否
缓存时间:无
是否分页:是

返回结果：
{
    "data": [
            {
            "logo": 车友会会标, 
            "announcement":公告, 
            "memberSum": 成员数, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce":简介, 
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId": 车友会ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "regionRank": 地区排名, 
            "activitySum": 活动数, 
            "name": 车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数, 
            "activityName": 最新活动名称
            }
	]
}

2.28同城车友会列表接口

接口URL:/club/getClubByUIdOrRegionId.do
说明:根据城市ID返回车友会列表

请求参数：
regionId:地区ID

是否登录:否
缓存时间:无
是否分页:否

返回结果：
参照接口2.3

2.29车友会排行榜接口

接口URL:/club/listTopClubWeekly.do
说明:top10认证人数,全国油值排行榜

请求参数：
type:0:上周新增认证人数排行,1:上周新增油值排行

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
    "data": [
            {
	    "logo": 车友会会标
            "announcement": "内容含有敏感词，已屏蔽", 
            "memberSum": 公告, 
            "cityName": 市, 
            "commentSum": 留言数, 
            "introduce":简介
            "provinceName": 省, 
            "topicSum": 帖子数, 
            "totalPetrol": 总油值, 
            "clubId":用户ID, 
            "level": 等级ID, 
            "seriesName": 车系名称, 
            "regionRank": 地区排名, 
            "activitySum": 活动数, 
            "name":车友会名称, 
            "levelName": 等级名称, 
            "albumSum": 相册数, 
            "activityName": 最新活动名称
             weekPetrol：上周新增油值（当type为1是有值）
             weekVipNum：上周新增认证人数（当type为0是有值）
            }
      ]
}

2.30 取消活动报名接口

接口URL:/activity/cancelActivity.do   
说明:取消活动报名

请求参数：
activityId:活动ID

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{code:0}

2.31 获取城市列表

接口URL:http://my.pcauto.com.cn/intf/jsonArea.jsp 
说明:获取城市列表

请求参数：
areaId；省ID(可选)
cityId；市ID(可选)

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
"areas":[
{
"citys":[
    {
    "cityName":"东城区",
    "cityCode":110101
    }],
"areaName":"北京市",
"areaCode":110000
}]
}

2.32 根据IP获取城市ID

接口URL:http://my.pcauto.com.cn/intf/getAreaIdByIp.jsp
说明:根据IP获取城市ID

请求参数：

是否登录:否
缓存时间:无
是否分页:否

返回结果：
{
areaName:省名称
areaCode:省编码
cityName:城市名称,
cityCode:城市编码,
ip:ip地址
}

2.33 入会审核接口

接口URL:/member/audit.do
说明:管理员对申请加入车友会的成员进行审核

请求参数：
clubId;车友会ID
action:1:通过,-1:拒绝
applicationId:申请人ID

是否登录:是
缓存时间:无
是否分页:否

返回结果：
{
status:-1>处理错误  0>成功  1>没有权限，没有登录  2>参数错误 3>不符合处理条件
desc:信息提示
}

2.34 获取论坛最新帖子接口

测试接口URL:http://v15.pcauto.com.cn/intf/common/_block_forums.jsp
正式接口URL:http://bbs.pcauto.com.cn/intf/common/_block_forums.jsp
说明:管理员对申请加入车友会的成员进行审核

请求参数：
fids：板块ID，多个“，”分隔
callback:json 必须

是否登录:是
缓存时间:无
是否分页:否

返回结果：
[
    {
        "count": 今天提交贴, 
        "forumId": 板块ID, 
        "forumName": "板块名称", 
        "icon": "板块图标", 
        "lastTopicAuthor": {
            "authorId": 最后回复作者ID, 
            "name": "最后回复作者名称", 
            "nickname": "最后作者昵称",
            "url": "头像"
        }, 
        "lastTopicCreateAt": "最后回复时间", 
        "lastTopicId": 最后回复ID, 
        "lastTopicTitle": "最后发表主题", 
        "lastTopicUrl": "最后发表主题链接", 
        "posts": 提交总数, 
        "todayNewtic": 今日新帖, 
        "topics": 主题帖总数, 
        "url": "板块URl"
    }
]

2.34 获取用户已参加活动列表接口

接口URL:/activity/listActivityByUserId.do
说明:根据用户ID返回该用户已经参加的活动列表

请求参数：
userId:用户ID

是否登录:否
缓存时间:无
是否分页:是

{
    "userId": 用户ID,
    "pageNo": 当前页数, 
    "pageSize": 分页代销, 
　 "clubName": "车友会名称",
　 "total": 活动总数, 
    "data": [
        {
            "clubId": 车友会ID,
            "clubName": "车友会名称",
	    "activityId": 活动ID, 
            "title": "活动标题",
            "signupDate": "报名截止时间", 
            "pic": "活动封面图", 
            "place": "活动地址", 
            "isSignUp": 是否报名，true/false, 
            "endDate": "活动结束时间", 
            "beginDate": "活动开始时间"
        }
    ]
}

Attachments