wiki:piebbs_intf

Version 7 (modified by huangping, 10 years ago) (diff)

--

最数码论坛相关接口

注:(PS:可以参考 电脑网APP、亲子网APP进行开发)
1.+为本次新增接口,*为本次有改动的接口。
2.接口公共字段说明:status表示状态,message表示操作结果说明。其中status字段值的含义如下:

STATUS_ERROR = -1; 错误
STATUS_SUCCESS = 0;
成功
STATUS_NO_RIGHT = 1; 没有权限
STATUS_PARAM_WRONG = 2;
参数错误
STATUS_CONTENT_OVERFLOW = 3; 内容超出长度
STATUS_EXISTS = 4;
数据已经存在
STATUS_NOT_FOUND = 5; 数据查找不到
STATUS_NO_LOGIN = 6;
没有登录
STATUS_USER_LOCK = 7; 用户被锁
STATUS_IP_LOCK = 8;
IP被锁

最数码开发环境地址:  http://dev33.pconline.com.cn/admin.do
最数码测试环境:  http://v15.pconline.com.cn/admin.do
最数码线上环境:  http://piebbs.pconline.com.cn/admin.do


最数码版块列表页接口
 http://xxx.pconline.com.cn/rest/forums/22
请求方式:HTTP GET
说明:最后数字是板块ID
缓存:
参数:

pageNo: 当前页 默认1
pageSize:一页显示几条数据,默认25
filter:帖子类型(传递filter=type表示需要所有类型)(filter=pick表示需要精华帖)
fval:版块分类(如讨论,晒物,经验,交易)
orderby :按照什么排序(默认是降序)
最新回复时间:replyat
最新发表时间:postat
maxLength:标题最大字符串数目
showTop:是否展示置顶帖(boolean),置顶帖单独出,不算在总数中,因为置顶帖不超过10个,显示置顶帖的条件是第一页(pageNo=1)并且fval为空并且showTop为true
isCensorFirst :非必须,看需求是否需要,是否先审后出(true/false),如果为true并且帖子未审,则title为”该帖子正在审核中”、message为”该帖子正在审核中”

返回(json格式): {

forum: {

bbs: 2,
forumId: 22,
name: "今日聚超值讨论区",
parentId: 2,
uuid: "123aerhn%32gt45"

},
pageNo: 1,
pageSize: 1,
topTopicList:

{

author: {

name: "geniusyys",
nickname: "荒木",
userFace: "XXX",
userId: 20839026

},
createAt: 1405518128000,
floor: 21,
formatCreateAt: "2014-07-16 21:42",
image: "",
lastPostAt: 1413442722000,
message: "交易区禁止",
replyCount: 20,
title: "禁止发多个交易帖子,新东西请在主贴更新",
topicId: 104776,
uri: "XXX",
view: 821

}

],
topicList: [

{

author: {

name: "fit10",
nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",
userFace: "XXXX",
userId: 826717

},
createAt: 1463033025000,
floor: 1,
formatCreateAt: "2016-05-12 14:03",
image: "",
lastPostAt: 1463033025000,

lastPoster: {

lastPostAt: "2015-01-22 15:56",
name: "qz23180228",
nickname: "qz23180228",
userId: 23180228

},
isContainImage: false,

message: "按时到啥时候发奖金",
replyCount: 0,
title: "今天是好日子",
topicId: 122451,
uri: "XXXX",
view: 4

}

],
total: 23550

} 结果说明:

topTopicList 这是置顶帖列表
topicList 这是主题表列表
isContainImage 是否包含图片true或者false

如果是精华帖会多出 isPick:true , flag : ”精”这个字段

如果帖子是本站置顶,则会多出isForumTop :true字段

如果符合帖子审核通过、作者状态正常并且帖子有图片就会出imgUrls 大小400x的三张图片

如果帖子作者不存在或者帖子作者被锁,则message内容为“用户被封,内容屏蔽”

如果帖子作者不为空,则会显示作者相关信息

author: {name: "", nickname: "", userFace: , userId: },

如果最后回复作者不为空,则会出最后回复作者信息

lastPoster: {name: "", nickname: "", userFace: , userId: },

最数码发主帖接口
 http://xxx.pconline.com.cn/rest/forums/22
请求方式:HTTP POST
说明:最后数字是板块ID
缓存:
参数:

title: 标题
message:帖子内容
type:帖子类型
sendMsg: 是否发送消息(false/true)
agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子)或者按照亲子网电脑网那样传递user-agent参数

返回(json格式):
{

Location:url,
status:0

}
参数说明:

Status为0的时候说明发帖成功,否则发帖不成功

最数码发回帖接口
 http://xxx.pconline.com.cn/rest/topics/122461
请求方式:HTTP POST
说明:最后数字是帖子ID
缓存:
参数:

message:回帖内容
replyToId:回复ID
sendMsg: 是否发送消息(false/true)
agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子)或者按照亲子网电脑网那样传递user-agent参数

返回(json格式):
{

Location:url,
status:0

}

参数说明:

Status为0的时候说明发回帖成功,否则发回帖不成功

最数码获取帖子内容信息接口(包括了回帖内容)
 http://xxx.pconline.com.cn/rest/topics/122461
请求方式:HTTP GET
说明:最后数字是帖子ID
缓存:
参数:

pageNo:第几页
authorId:作者ID(有传递表示只看作者回复的内容)
desc:是否按楼层倒序,不传递表示按楼层升序
agent:来源 (1代表ios移动端帖子)(2代表Android移动端帖子)或者按照亲子网电脑网那样传递user-agent参数
isCensorFirst :非必须,看需求是否需要,是否先审后出(true/false),如果为true并且帖子未审,则title为”该帖子正在审核中”、message为”该帖子正在审核中”

返回(json格式):
{

"curAllImage":[

"p1_1_XXX",
"p1_2_XXX"

],
pageNo: 1,
pageSize: 10,
postList: [

{

agent: 0,
author: {

level: "最数码龙头",
name: "fit10",
nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",
userFace: "XXX",
userId: 826717

},
createAt: 1467353045000,
floor: 1,
message: "这个就是内容",
postId: 1873171,
status: 0

},
{

agent: 0,
author: {

level: "最数码龙头",
name: "fit10",
nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",
userFace: "XXX",
userId: 826717

},
createAt: 1467353630000,
floor: 2,
message: "我来回复看看",
postId: 1873172,
status: 0

}

],
topic: {

author: {

level: "最数码龙头",
name: "fit10",
nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",
userFace: "XXX",
userId: 826717

}, bbsId: 66,
createAt: 1467353045000,
favoriteCount: 0,
forumId: 66,
forumName: "网络检测",
forumUuid: "",
lastPostAt: 1467353630000,
lastPoster: {

name: "fit10",
nickname: "太平洋电脑网论坛帖子仅代表作者本人意见",
userId: 826717

},
replyCount: 1,
title: "第一次发帖",
uri: "XXX",
view: 5

},
total: 2

}

参数说明:

curAllImage :帖子图片
postList: 表示的回帖内容
topic: 表示主题内容

如果帖子作者被锁,则message内容为“用户被封,内容屏蔽”

如果isCensorFirst 为true并且回帖未审,则message为 “该帖子正在审核中,请稍后查看!”

如果帖子是Html帖子,则message 为 “抱歉,暂不支持HTML贴:(”

最数码获取我的收藏帖子信息接口
 http://xxx.pconline.com.cn/intf/user/_favTopics.jsp
请求方式:GET
说明:获取用户收藏的帖子
缓存:
参数:

userId: 用户ID
pageNo:当前第几页
pageSize:一页显示几条数据(不传递默认5)
fid : 版块ID
onlyShowForum : 是否只展示fid版块(false/true)
callback :回调函数,非必须

返回(json格式):
{

list: [

{

authorName: "liuyijiabailie",
authorNickName: "liuyijiabailie",
authorUrl: "XXX",
createAt: "15-01-15 21:43",
favoriteCount: 1,
favoriteId: 20012,
forumName: "今日聚超值讨论区",
forumUrl: "XXX",
image: "XXX",
isContainImage: true,
isNew: false,
lastPostAt: "15-01-22 15:01",
lastPosterNickname: "liuyijiabailie",
lastPosterUrl: "XXX",
replyCount: 4,
title: "博朗340S与WF1S",
topicId: 121668,
url: "XXX",
viewCount: 138

},

],
listCount: 2

}

参数说明:

最数码获取我的帖子信息接口
 http://xxx.pconline.com.cn/intf/user/_topics.jsp
请求方式:
说明:获取用户自己的帖子的帖子
缓存:缓存15分钟
参数:

userId: 用户ID
pageNo:当前第几页
pageSize:一页显示几条数据
fid : 版块ID
orderBy : 根据什么排序(例如createAt)
isAsc : 是否升序,false/true
maxLength:帖子内容显示最大长度
callback :回调函数,非必须

返回(json格式):
{

list: [

{

censored: 0,
fid: 22,
floor: 1,
forumName: "今日聚超值讨论区",
forumUrl: "XXX",
image: "",
isContainImage: false,
isNew: false,
lastPostAt: "16-05-12 14:03",
message: "按时到啥时候发奖金",
pick: 0,
pid: 1873161,
replyCount: 0,
title: "今天是好日子",
topicCreateAt: 1463033025000,
topicId: 122451,
url: "XXX",
userName: "太平洋电脑网论坛帖子仅代表作者本人意见",
userUrl: "XXX",
viewCount: 1

},

],
listCount: 10

}

参数说明:

censored; 审核状态 0 未审 1 已审
pick ; 精华类型 (0代表不是精华) (1代表精华1)( 2代表精华2)

最数码对帖子进行收藏接口
 http://xxx.pconline.com.cn/favorite.ajax
请求方式:POST
说明:对帖子进行收藏,需要登录
缓存:
参数:

fid: 对版块进行收藏,只传递版块ID
tid:对帖子进行收藏,只需要传递帖子ID
两个ID只需要根据需求传递一个就可以

返回(json格式):
{

status:0,
desc:"指定的主题已经添加到收藏夹"

}

参数说明:

status; 状态码,非0就是不成功
desc ; 结果描述

最数码检查是否已经收藏帖子或者版块接口
 http://xxx.pconline.com.cn/checkFavorite.ajax
请求方式:POST
说明:检查是否已经收藏帖子或者版块,需要登录
缓存:
参数:

tid:对帖子进行收藏,只需要传递帖子ID

返回(json格式):
{

status:0,
desc:"已经收藏"

}

参数说明:

status; 状态码,非0就是不成功
desc ; 结果描述