wiki:pcauto_club_2.0.0/api

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

--

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:正常返回
	msg: “您还没有登陆”		//错误提示
}

2.接口列表

2.1 车友会详情接口

接口URL:
说明:

请求参数:

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

返回结果:

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

接口URL:
说明:

请求参数:

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

返回结果:

2.3首页车友会列表接口

接口URL:
说明:

请求参数:

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

返回结果:

2.4车友会搜索接口

接口URL:
说明:

请求参数:

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

返回结果:

2.5车友动态接口

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

请求参数:
clubId;车友会ID

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

返回结果:
{

}

2.6车友会相册列表接口

接口URL:
说明:

请求参数:

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

返回结果:

2.7相册图片列表接口

接口URL:
说明:

请求参数:

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

返回结果:

2.8上传图片接口

接口URL:
说明:

请求参数:

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

返回结果:

2.9创建相册接口

接口URL:
说明:

请求参数:

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

返回结果:

2.10车友会活动列表接口

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

请求参数:
clubId:车友会ID
userId:用户ID(可选)

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

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

2.11活动详情页面

接口URL:
说明:

请求参数:

是否登录:
缓存时间:

返回结果:

2.12报名人员页面

接口URL:
说明:

请求参数:

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

返回结果:

2.13活动报名接口

接口URL:
说明:

请求参数:

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

返回结果:

2.14车友会成员列表接口

接口URL:
说明:

请求参数:

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

返回结果:

2.15车友会成员管理接口

接口URL:
说明:

请求参数:

是否登录:
缓存时间:

返回结果:

2.16车友会入退会接口

接口URL:
说明:

请求参数:

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

返回结果:

2.17车友会留言列表接口

接口URL:
说明:

请求参数:

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

返回结果:

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

接口URL:
说明:

请求参数:

是否登录:
缓存时间:

返回结果:

2.19创建车友会接口

接口URL:
说明:

请求参数:

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

返回结果:

2.20修改车友会接口

接口URL:
说明:

请求参数:

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

返回结果:

2.21域名合法校验接口

接口URL:
说明:

请求参数:

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

返回结果:

2.22车友会名合法校验接口

接口URL:
说明:

请求参数:

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

返回结果:

2.23获取手机验证码接口

接口URL:
说明:

请求参数:

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

返回结果:

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

接口URL:
说明:

请求参数:

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

返回结果:

2.25车友会签到接口

接口URL:
说明:

请求参数:

是否登录:
缓存时间:

返回结果:

2.26编辑推荐论坛接口

接口URL:
说明:

请求参数:

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

返回结果:

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

接口URL:
说明:

请求参数:

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

返回结果:

2.28论坛相关车友会接口

接口URL:
说明:

请求参数:

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

返回结果:

2.29同城车友会列表接口

接口URL:
说明:

请求参数:

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

返回结果:

2.30车友会排行榜接口

接口URL:
说明:

请求参数:

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

返回结果:

Attachments