wiki:pcauto_bbs_1.0.0/intfs

Version 31 (modified by yaoming, 13 years ago) (diff)

--

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.接口列表

2.1 新消息

    作用:获取汽车论坛站内信的数据
    使用范围:汽车网论坛app:pcautobbs
    备注:屏蔽车主认证失败的信息

    url: newMsgCount
    HTTP请求方式:get                         
    是否需要登录:否                          
    请求参数:none
    返回参数:
    { "newMsgCount": 2000 }
    newMsgCount:新消息的数量,当该数值超过五位数时,只返回99999。新消息是指汽车论坛的站内信,不包括认证失败的消息。

2.2 我的帖子

url:与客户端4.0共用接口,详细参考接口2.3: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.3我的帖子
作用:获取某用户发布的所有帖子 使用范围:电脑网app:命名前缀pconline、汽车网app:命名前缀pcauto

2.3 我的回复

url:  http://mrobot.pcauto.com.cn/v4/individualcenter/reply?common_session_id=%d?&pageno=%d&pagesize=%d 作用:获取某用户的所有回复
使用范围:汽车网论坛app:pcautobbs

请求方式:get  是否需要登录:是 请求参数:

pageNo:页数 common_session_id:用户登陆后获得的认证id pageSize:每页条数 例子: {

"pageNo":1, 页码 "pageSize":20, 每页条数 "topicList":[ /

{/每条的数据

"time":123, 格式是时间戳,创建或最终修改时间 "floorIndex":812,评论所属的楼层 "title":"三两下root好并精简你的三星I9100",标题

"replyContent":"回复内容为9", 回复内容

"topicId":13597147, 帖子id "replyCount":6175,回复数 "view":195872,阅读数

"floor":812,楼层数

"uri":" http://itbbs.pconline.com.cn/mobile/13597147.html" 帖子url

}

], "total":12 一共多少条

} }}}

2.4 最新消息

url: http://mrobot.pcauto.com.cn/v4/individualcenter/news?common_session_id=%d?&pageno=%d&pagesize=%d

作用:获取系统消息、站内信和别人对用户帖子的回复
使用范围:汽车网论坛app:pcautobbs

请求方式:get 
是否需要登录:是
请求参数: 
pageNo:页数     common_session_id:用户登陆后获得的认证id  pageSize:每页条数 


例子:
{
    "pageNo":1, //页码
    "pageSize":20, //每页条数
    "topicList":[  /
        {/每条的数据
            "time":123,   //格式是时间戳,创建或最终修改时间
            “tag”:”postReplay”   //包括''system”,”stationMail”,”postReplay” 三种类型
            "content":"三两下root好并精简你的三星I9100",   //内容,三者都有  ,字数有限制
   	    "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //postReplay独有url  
	    “username”:”haha”           //postReplay,stationMail 中的用户名
	    “useId”: 12314212          //postReplay,stationMail 中的用户id
            “postTitle”: “给力三星I9100”         //postReplay中的帖子标题
	    “floorIndex”: 3        //postReplay中的回帖的楼层数
            "topicId":13597147, // postReplay帖子id
	 }
    ],
    "total":12  //一共多少条
}

2.5 头像修改

url : url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/saveavatar"

作用:修改用户头像
使用范围:汽车网论坛app:pcautobbs

请求方式:post 
是否需要登录:需要
请求参数:
name:用户名 
image:用户头像数据
common_session_id:会话id

2.6 同步内容下载

url:与客户端4.0共用接口,详细参考接口2.6: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.6同步内容下载
作用:同步论坛收藏的内容
使用范围:电脑网app:命名前缀pconline、汽车网app:命名前缀pcauto

2.7 同步内容上传

url:与客户端4.0共用接口,详细参考接口2.7: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.7同步内容上传
作用:同步论坛收藏的内容
使用范围:电脑网app:命名前缀pconline、汽车网app:命名前缀pcauto

2.8 首页咨询

url:information

作用:获取首页焦点图数据和列表的内容
使用范围:汽车网论坛app:pcautobbs

Http请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
    "focus": [
        {
            "title": "媳妇当车模!英朗XT用车记",     //标题
            "image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327a.jpg",  //焦点图片链接
            "topicId": 13891367   //帖子ID
        },
        {
            "title": "欧洲小镇拍小美女",
            "image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",
            "topicId": 13891367
        }
    ],
    "topicList": [
	//每条数据
        {
            "author": {
                "name": "tanakarena",
                "nickname": "Vincent嘎妹",
                "userId": 664603
            },	//发帖人信息
            "createAt": 1311096173000,	//发帖时间
            "flag": "精",	//是否为精,图等
            "replyCount": 6243,	//该帖回复数
            "title": "三两下root好并精简你的三星I9100",	//帖标题
            "topicId": 13597147,	//帖子ID
            "viewCount": 197264,	//该帖阅读数
	"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg"	//图片链接
        },
        {
            "author": {
                "name": "e6",
                "nickname": "E6机器人",
                "userId": 9629195
            },
            "createAt": 1315237579000,
            "flag": "精",
            "replyCount": 19122,
            "title": "都市赛车6(Asphalt 6)更新v3.1.9  for I9100",
            "topicId": 13891367,
            "viewCount": 292624,
	"image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg"
        }
    ]
}

2.9 精选页分类

url:category

作用:获取精选页面的分类
使用范围:汽车网论坛app:pcautobbs

Http请求方式:get
是否需要登录:否
请求参数:none
返回参数:
{
	"category": [
	//分类数组每条数据
		{
			"id": 1,		//分类ID
			"name": "自驾游"	//分类名
		},
		{
			"id": 2,
			"name": "西藏之旅"
		}
	]
}

2.10 精选页分类列表

url:categoryContent

作用:按分类获取精选页的列表内容
使用范围:汽车网论坛app:pcautobbs

Http请求方式:get
是否需要登录:否
请求参数:
categoryId: 分类ID
pageNo: 页数
pageSize: 每页条数
返回参数:

{
    "pageNo": 1,	//当前页数
    "pageSize": 20,	//当前返回每页条数
    "total": 12,		//总共有多少条
    "topicList": [
        {
            "image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",	//封面图片
            “image2”: "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",   //封面图片2
            "title": "【西藏之旅3】广州分会马自达睿翼梦幻旅途",		//标题
            "topicId": 13597147,	//帖子ID
            "author": "白云敏少",	//作者
            "replyCount": 261,		//回复数
            "forumName": "广州分会"		//来源论坛
        },
        {
            "image": "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg",
            “image2”: "http://img0.pcauto.com.cn/pcauto/app/bbs/focus/1303/LL20130327.jpg", 
            "title": "【西藏之旅4】广州分会马自达睿翼梦幻旅途",
            "topicId": 13597148,
            "author": "白云敏少",
            "replyCount": 87,
            "forumName": "广州分会"
        }
    ]
}

2.11 帖子列表

url:与客户端4.0共用接口,详细参考接口2.9: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.9论坛的帖子列表重构
作用:获取某论坛下的帖子
使用范围:汽车网论坛app:pcautobbs

2.12 帖子终端页

url:与客户端4.0共用接口,详细参考接口2.10: http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf#a2.10帖子页
作用:帖子终端页
使用范围:汽车网论坛app:pcautobbs