| Version 23 (modified by hezhenwei1, 10 years ago) (diff) |
|---|
Table of Contents
家居杂志iPhone3.4.0接口文档
环境说明:
1.圈子
1.1精选帖子列表
mrobot:/selectedTopic.xsp
虚拟币系统:/selectedTopicIds.jsp
论坛系统:
论坛系统可参考: 根据帖子id批量获取帖子详情
说明
获取精选帖子列表数据,最多30条精选帖子,每页10条,最多3页。
帖子数据保存在论坛系统,但精选帖子的id保存在虚拟币系统,所以需要mrobot端先从虚拟币系统获取所有精选帖子的id,再根据分页页数带上对应的帖子id到论坛系统查询帖子数据。
缓存时间
无缓存
提交方式
GET
是否登录
否
数据来源
虚拟币系统
论坛系统
参数
mrobot:
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | 页数 |
| pageSize | 页面大小 | int | 10 | 是 | 每页大小 |
虚拟币系统:
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|
论坛系统:
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| topicIds | 帖子id | string | "" | 是 | 多个帖子的id,以逗号分隔 |
返回
mrobot:
{
"status":0,
"msg":"请求成功",
"pageNo": 1,
"pageSize": 10,
"total": 30,
"data":[{
"category": "原创",
"censor": 1,
"coverUrl": "http://img.pchouse.com.cn/images/upload/upc/tx/housebbs6/1511/25/c0/15666999_1448389297447_1024x1024house.jpg",
"createAt": "2015-11-25 02:21:41",
"floor": 1,
"imgUrls": [],
"lastPostAt": "2015-11-25 02:21:41",
"message": "",
"pick": 0,
"replyCount": 0,
"status": 0,
"title": "这灯好看吧",
"uid": 40858440,
"userFace": "http://i1.3conline.com/images/upload/upc/face/40/85/84/40/40858440_50x50",
"userName": "mb40858440",
"authorName": "mb40858440",
"forumId": 105,
"isContainImage": true,
"topicId": 1103978,
"topicUrl": "http://v26.pchouse.com.cn/topic-1103978.html",
"viewCount": 2,
"favorCount":3,
"collectCount":5,
"tag":[
{"id":"1", "name":"茶桌"},{"id":"2", "name":"衣柜"},...
]
},
...
]
}
虚拟币系统:
{
"status":0,
"msg":"请求成功",
"data":["1","2","3",...,"30"]
}
论坛系统:
[{
"category": "原创",
"censor": 1,
"coverUrl": "http://img.pchouse.com.cn/images/upload/upc/tx/housebbs6/1511/25/c0/15666999_1448389297447_1024x1024house.jpg",
"createAt": "2015-11-25 02:21:41",
"floor": 1,
"imgUrls": [],
"lastPostAt": "2015-11-25 02:21:41",
"message": "",
"pick": 0,
"replyCount": 0,
"status": 0,
"title": "这灯好看吧",
"uid": 40858440,
"userFace": "http://i1.3conline.com/images/upload/upc/face/40/85/84/40/40858440_50x50",
"userName": "mb40858440",
"authorName": "mb40858440",
"forumId": 105,
"isContainImage": true,
"topicId": 1103978,
"topicUrl": "http://v26.pchouse.com.cn/topic-1103978.html",
"viewCount": 2,
"favorCount":3,
"collectCount":5,
"tag":[
{"id":"1", "name":"茶桌"},{"id":"2", "name":"衣柜"},...
]
},
...
]
返回参数说明
mrobot:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| data | 精选帖子列表 | data列表中的参数 | 参考论坛系统中对应接口的参数说明 |
| favorCount | 点赞数 | collectCount | 收藏数 |
| tag | 帖子对应的标签列表 |
虚拟币系统:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| data | 精选帖子id列表 |
论坛系统:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| tag | 帖子对应的标签列表 | data列表中的参数 | 参考论坛系统中对应接口的参数说明 |
| favorCount | 点赞数 | collectCount | 收藏数 |
1.2帖子列表(发现、标签、个人主页)
mrobot:/discoveryTopic.xsp
论坛系统: http://bbs.pchouse.com.cn/rest/forums.jsp(修改)
说明
当只传了分页参数,论坛返回分页帖子列表。(发现帖子列表)
当传了分页参数和标签id,论坛返回该标签下分页帖子列表。(标签帖子列表)
当传了分页参数和用户id,论坛返回该用户下分页帖子列表。(个人主页帖子列表)
如果同时存在标签id和用户id,暂定返回错误信息:参数有误
分页默认一页20条
缓存时间
无缓存
提交方式
GET
是否登录
否
数据来源
论坛系统
参数
mrobot、论坛系统:
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | 页数 |
| pageSize | 页面大小 | int | 20 | 是 | 每页大小 |
| tagId | 标签id | int | 否 | 单个标签id | |
| uid | 用户id | int | 否 | 单个用户id |
返回
mrobot:
{
"status":0,
"msg":"请求成功",
"pageNo": 1,
"pageSize": 20,
"total": 163,
"data":[{
"category": "原创",
"censor": 1,
"coverUrl": "http://img.pchouse.com.cn/images/upload/upc/tx/housebbs6/1511/25/c0/15666999_1448389297447_1024x1024house.jpg",
"createAt": "2015-11-25 02:21:41",
"floor": 1,
"imgUrls": [],
"lastPostAt": "2015-11-25 02:21:41",
"message": "",
"pick": 0,
"replyCount": 0,
"status": 0,
"title": "这灯好看吧",
"uid": 40858440,
"userFace": "http://i1.3conline.com/images/upload/upc/face/40/85/84/40/40858440_50x50",
"userName": "mb40858440",
"authorName": "mb40858440",
"forumId": 105,
"isContainImage": true,
"topicId": 1103978,
"topicUrl": "http://v26.pchouse.com.cn/topic-1103978.html",
"viewCount": 2,
"favorCount":3,
"collectCount":5,
"tag":[
{"id":"1", "name":"茶桌"},{"id":"2", "name":"衣柜"},...
]
},
...
]
}
论坛系统:
[{
"category": "原创",
"censor": 1,
"coverUrl": "http://img.pchouse.com.cn/images/upload/upc/tx/housebbs6/1511/25/c0/15666999_1448389297447_1024x1024house.jpg",
"createAt": "2015-11-25 02:21:41",
"floor": 1,
"imgUrls": [],
"lastPostAt": "2015-11-25 02:21:41",
"message": "",
"pick": 0,
"replyCount": 0,
"status": 0,
"title": "这灯好看吧",
"uid": 40858440,
"userFace": "http://i1.3conline.com/images/upload/upc/face/40/85/84/40/40858440_50x50",
"userName": "mb40858440",
"authorName": "mb40858440",
"forumId": 105,
"isContainImage": true,
"topicId": 1103978,
"topicUrl": "http://v26.pchouse.com.cn/topic-1103978.html",
"viewCount": 2,
"favorCount":3,
"collectCount":5,
"tag":[
{"id":"1", "name":"茶桌"},{"id":"2", "name":"衣柜"},...
]
},...
]
返回参数说明
mrobot:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| data | 帖子列表 | data列表中的参数 | 参考论坛系统中对应接口的参数说明 |
| favorCount | 点赞数 | collectCount | 收藏数 |
论坛系统:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| data | 帖子列表 | data列表中的参数 | 参考论坛系统中对应接口的参数说明 |
| favorCount | 点赞数 | collectCount | 收藏数 |
1.3帖子终端页(修改)
mrobot: http://mrobot.pchouse.com.cn/v3/bbs/topics/1307314
论坛系统: http://bbs.pchouse.com.cn/rest/topics/1307314?picRule=2
制作地址:
说明
修改帖子终端页接口:主贴下的回帖不再需要分页,直接全部返回,也不需要只看楼主了
论坛出数据,mrobot组装为html代码
页面需要提供js方法给App端实现点赞和取消点赞的页面动效,以及收藏和取消收藏的页面动效
js方法
点赞和取消点赞的页面动效:
收藏和取消收藏的页面动效:
缓存时间
无缓存
提交方式
GET
是否登录
否
数据来源
论坛系统
参数
mrobot、论坛系统:
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| topicId | 帖子id | int | 是 | 帖子 id,直接加在url后面 | |
| picRule | 图片规则 | int | 0 | 否 | 移动网络的时候是0,wifi的时候是2,是否还有作用? |
返回
mrobot:
mrobot返回的html中的json
/*@_HTML_META_START_
{
//预留,暂时没有需要返回的
}
_HTML_META_END_@*/
论坛系统:
{
"curAllImage": [
"p1_1_http://imgm.pchouse.com.cn/images/upload/upc/tx/housebbs6/1605/18/c1/21658406_1463543973340_1024x1024house.jpg"
],
"postList": [
{
"agent": 1,
"author": {
"level": "建造工",
"name": "mb42379906",
"nickname": "鱼儿心情",
"userFace": "http://i1.3conline.com/images/upload/upc/face/42/37/99/06/42379906_50x50",
"userId": 42379906
},
"createAt": 1463543986000,
"floor": 1,
"message": " 被朋友带去一个好地儿,非常喜欢这里的装修风格,非常适合三五好友小聚,翻翻书,喝喝茶,以及美味可口的小糕点,惬意的午后时光……更有私人的藏酒柜,可以把好酒寄放在这里享受恒温恒湿的保管. ",
"postId": 12010038,
"status": 0
},...
],
"topic": {
"author": {
"level": "建造工",
"name": "mb42379906",
"nickname": "鱼儿心情",
"userFace": "http://i1.3conline.com/images/upload/upc/face/42/37/99/06/42379906_50x50",
"userId": 42379906
},
"bbsId": 105,
"createAt": 1463543986000,
"flag": "精",
"forumId": 107,
"forumName": "我用过",
"lastPostAt": 1463633944000,
"lastPoster": {
"name": "mb42379906",
"nickname": "鱼儿心情",
"userId": 42379906
},
"replyCount": 40,
"favorCount":3,
"collectCount":5,
"title": "朋友家庭聚会好去处...奢华中带有家的情调~",
"uri": "http://bbs.pchouse.com.cn/topic-1307174.html",
"view": 94,
"tag":[
{"id":"1", "name":"茶桌"},{"id":"2", "name":"衣柜"},...
]
},
"total": 41
}
返回参数说明
mrobot:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|
论坛系统:
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| favorCount | 点赞数 | collectCount | 收藏数 |
| tag | 标签列表 |
1.4热门标签
mrobot:/hotTag.xsp
虚拟币系统:
说明
获取编辑在后台维护的热门标签,一般来说会有且最多有7个
缓存时间
15分钟
提交方式
GET
是否登录
否
数据来源
虚拟币系统
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|
返回
{
"status":0,
"msg":"请求成功",
"data":[
{"1":"餐桌"},
{"2":"橱柜"},
...
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| data | 标签列表 |
1.5所有标签
mrobot:/allTag.xsp
虚拟币系统:
说明
获取编辑在后台维护的所有标签,分一级标签和二级标签。 如果是‘发现页’中点击‘更多标签’进入,需要排除‘发现页’中出现的标签。 如果是‘发帖页’中点击‘更多标签’进入,需要排除‘发帖页’中出现的标签。
缓存时间
15分钟
提交方式
GET
是否登录
否
数据来源
虚拟币系统
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| excludeType | 排除类型 | string | "" | 否 | 1:排除发现页中的热门标签,2:排除发帖页中的热门标签 |
返回
{
"status":0,
"msg":"请求成功",
"data":[
{
"superTagId":"1",
"superTagName":"文艺",
"subTagList":[
{
"tagId":"11",
"tagName":"绿叶"
},...
]
},...
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| superTagId | 一级标签id | superTagName | 一级标签名称 |
| tagId | 标签id | tagName | 标签名称 |
1.6发帖
论坛接口
论坛系统: http://bbs.pchouse.com.cn/rest/forums.jsp
说明
参数content格式修改:增加帖子所属的标签列表 格式:[tag]1,4,5,6,7[ /tag],注意:实际情况斜杠前面这里是没有空格的,只是为了避免变成trac的标签
1.7对帖子点赞/取消赞
论坛系统:topicSupport.jsp
说明
对帖子点赞/取消赞。需要登录。
缓存时间
0分钟
提交方式
POST
是否登录
是
数据来源
论坛系统
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| topicId | 帖子id | int | "" | 是 | |
| operType | 操作类型 | int | "" | 是 | 1:点赞,2:取消点赞 |
返回
{
"status":0,
"msg":"请求成功"
}
//其他情况可以补充
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| status | 状态 | msg | 信息 |
1.8用户是否已经对贴子点赞
mrobot地址: /isSupportTopic.xsp
论坛系统:/isSupportTopic.jsp
说明
获取该贴子是否已被用户点赞
缓存时间
0分钟
提交方式
GET
是否登录
是
数据来源
论坛后台
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| topicId | 帖子id | int | "" | 是 |
返回
{
"status":0,
"msg":"请求成功",
"hasSupport":"0"
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| hasSupport | 0:未点赞,1:已点赞 |
2.首页
2.1资讯首页接口(修改)
已有接口: 资讯首页
说明
推荐杂志字段latestPeriodical返回3篇推荐月刊,由cms后台维护 焦点滚动图字段focus已不需要,可以不用返回
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)