wiki:intf

Version 24 (modified by wanganning, 13 years ago) (diff)

--

接口列表

intf/common

  • _topics.jsp 论坛主题列表接口

    参数

subsite=false;是否只查单个版块,默认为false。
当subsite=false时,支持以下参数:

noForums=;要过滤的版块ID,多个版块ID用半角逗号分隔。查询将过滤掉这些版块及这些版块的子版块
forums=;版块ID,多个版块ID用半角逗号分隔。查找的信息也会包含其子版块。
type=new;查询类型。目前支持new(2日内新帖),new_act(2日内活动帖),new_vote(2日内投票帖), hot_day(2日内热帖),hot_week(7日内热帖),hot_month(30日内热帖),hot_all(全部热帖), pick_day(2日内精华帖),pick_week(7日内精华帖),pick_month(30日内精华帖),pick_all(全部精华帖)
orderby=;查询类型为hot时,默认按回复数(replyCount)排序,要按点击数(view)排序就需要加此配置。查询类型为pick时,默认按发帖时间(createAt)排序,要按点击数(view)排序就需要加此配置。

当subsite=true时,支持以下参数:

forums=;只能接受一个版块ID,多个版块取第一个
top=3;置顶帖条数
days=2;从多少天前的数据开始查询,可填任意整数
type=new;可填new,hot,pick,top
extId=6;达人牛帖(暂未实现)
reply=-1;回复数大于等于多少,为-1时没有限制
replyMax=-1;回复数最大是少于多少,为-1时没有限制
topicType=;话题类别,默认为不填
topicTypeUTF8=;话题类别UTF8格式处理,默认为不填

count=10;列出条数
display=json;显示方式,支持json和ssi
maxLength=240;帖子内容最大长度,默认240个英文字符,相当于120个汉字.(目前只有json时生效)
faceWidth:需要返回头像时设定头像的宽度[[BR]] callback=;当display=json时使用的回调函数名称

说明

可以查看4种形式的主题列表,最新,顶置,最热,精华。根据subsite参数确定从哪个表查找
如果subsite=true,直接从bbs7_topic_xx表中读取数据
如果subsite=false,最新的主题从bbs7_new_topic里查找,最热的主题从bbs7_hot_topic,bbs7_hot_topic7,bbs7_hot_topic30,bbs7_hot_topic_all里查找,精华的主题从bbs7_pick里查找。

  • _topic.jsp 根据主题ID,获取主题信息

    参数

tid=; 要查询的主题ID
callback=; 回调函数名称

说明

返回数据类型为JSON

  • _users.jsp 获取用户数据
  • _topicRepliesJson.jsp 根据主题ID,按顺序分页显示回帖

    参数

tid=; 要查询的主题ID
len=200; 内容显示的字数,过滤掉UBB,默认200字符,如果负数则表示不截取,显示完整的(显示完整内容时会把ubb转换成html)
pageNo=1; 页数
pageSize=10; 每页显示数量
callback=; 回调函数名称

说明

返回数据类型为JSON

  • _forumNames.jsp 取版块名称
  • _contributionUsers.jsp 全站用户贡献值排行榜
  • _block_forums.jsp 给果派论坛首页使用

intf/special

  • _active_user.jsp 得到论坛的活跃好友ID
  • _searchHTML.jsp 通过关键字或标题搜索帖子内容,结果从快搜得到

    参数

searchWord=; 关键字
pageNo=1; 页数
pageSize=1; 每页显示数量
searchScope=1; 查找的范围,1为标题或内容,2为标题,3为内容

说明

如果从快速得到的结果为空,则返回最新的一条精华数据

  • _topics_activity.jsp 2010年某活动统计数据用的接口,接口中时间参数都固定,应该已不再使用
  • _autoForumAdmin.jsp 根据车系id返回对应版块下的版主、版副、嘉宾

intf/user

  • _topics.jsp 我的主题
  • _posts.jsp 我的回复
  • _picks.jsp 我的精华帖
  • _favForums.jsp 我收藏的版块
  • _favTopics.jsp 我收藏的帖子
  • _idTopics.jsp 根据ID获取主题对象列表

    参数

ids=; 要查询的主题ID,多个主题ID用半角逗号分隔
callback=; 回调函数

说明

返回数据类型为JSON

  • _extIds.jsp 参数

userId:要查询的用户id[[BR]] extId:bbs6中的extId种类[[BR]] dateTrom,dateTo:yyyy-MM-dd格式日期[[BR]] pageNo,pageSize:分页参数[[BR]] callback:回调函数名[[BR]]

说明

用于查询兼容bbs6里用户的扩展贴,json格式

  • _setVip.jsp

intf

  • _autosave.jsp 自动保存接口(可能仅供本应用调用,已不再使用)
  • _entry.jsp 本接口取消
  • _exscore-member.jsp 用于获得N天内的灌水或精华英雄榜
  • _forum.jsp 查询版块的主题帖

    参数

fid=; 版块ID
count=10; 返回数量
display=table; 返回主题的页面格式,可选table或ul
pickStr=false; 是否查询版块精华帖

说明

返回的页面格式可以是table或ul

  • _forum_index_auto.jsp 生成汽车论坛的论坛地图页
  • _forum-today-post.jsp 游戏网首页接口:id、贴数、板块名称、板块logo
  • _forum-yesterday-post.jsp 得到某天的所有版块帖子的统计
  • _hotForums.jsp 显示论坛板块发帖量排行榜
  • _hotForums2.jsp 显示论坛板块发帖量排行榜
  • _myPosts.jsp 生成嵌入外部页面的我的发帖列表
  • _photos.jsp 获取指定帖子内的图片

    参数

tid=; 主题ID
pid=; 帖子ID
getPos=next/prev; 当没找到时按顺序还是倒序找下一个帖子

说明

获取指定帖子内的图片,没找到时按参数继续找下一贴,以json格式返回

  • _pickForums.jsp 显示论坛板块本周精华帖排行榜
  • _replies_count_json.jsp 获取主题回帖数

    参数

tid=; 主题ID

说明

主题ID可以接受数组形式的参数,以json形式返回

  • _score-member.jsp 获得N天内的灌水或精华英雄榜
  • _score-member2.jsp 获得N天内的灌水或精华英雄榜
  • _sumPosts.jsp 获取全站的帖子总数和主题总数
  • _tocensor.jsp 把tocensor表的数据发送到审核平台
  • _topic.jsp 根据主题ID,获取主题信息

    参数

tid=; 要查询的主题ID
callback=; 回调函数名称

说明

返回数据类型为JSON

  • _topicReplies.jsp 论坛主题和其下回复页面

    参数

tag=bbs_topicReplies; 用于替换的标记名称
count=10; 列出回复条数
topic=; 主题ID,不能为空
cl=150; 帖子内容显示字数
display=js; 可选js或json
callback=; 回调函数,仅返回类型为json时有效

说明

列出主题下的最新count条回帖,按楼层数逆序排列

  • _topics.jsp

    参数

subsite=false;是否只查单个版块,默认为false
noForums=;要过滤的版块ID,多个版块ID用半角逗号分隔。查询将过滤掉这些版块及这些版块的子版块
forums=;版块ID,多个版块ID用半角逗号分隔。查找的信息也会包含其子版块
type=new;查询类型。可填new,hot,pick
display=ssi;显示方式,支持js,json和ssi
css=false; 是否使用CSS架构。true表示使用,这时会以DIV方式输出代码
count=10;列出条数
messageLength=;帖子内容最大长度,默认没有限制.(目前只有json时生效)
days=2;从多少天前的数据开始查询,可填任意整数
callback=;当display=json时使用的回调函数名称

说明

可以查看3种形式的主题列表,最新,最热,精华。根据subsite参数确定从哪个表查找。如果subsite=true,直接从bbs7_topic_xx表中读取数据。如果subsite=false,最新的主题从bbs7_new_topic里查找,最热的主题从bbs7_hot_topic,bbs7_hot_topic7,bbs7_hot_topic30,bbs7_hot_topic_all里查找,精华的主题从bbs7_pick里查找。

  • _topics_id.jsp

    参数

ids=; 主题ID,多个主题ID用半角逗号分隔
count=10; 返回数量
display=; 默认显示主题所有相关信息。若display参数值不为空,则只返回参数值的信息,多个值用半角逗号分隔。例如:display=title,replyCount 则只返回主题的title和replyCount,其余不返回。
cl=250; 主题帖子内容的显示长度

说明

返回数据类型为JSON,可指定返回的字段

  • _topics2.jsp 论坛主题列表javascript接口

    参数

forum=;版块ID。查找的信息也会包含其子版块
type=new;查询类型。可填new,hot,pick
count=10;列出条数
callback=;当display=json时使用的回调函数名称

说明

可以查看3种形式的主题列表,最新,最热,精华。从topic冗余表查找

  • _topics-css.jsp 论坛主题列表javascript接口

    参数

tag=bbs_topics; 用于替换的标记名称
forum=;版块ID。查找的信息也会包含其子版块
type=new;查询类型。可填new,hot,pick
display=js;显示方式,支持js,json和ssi
count=10;列出条数
callback=;当display=json时使用的回调函数名称

说明

可以查看3种形式的主题列表,最新,最热,精华。从topic冗余表查找

  • _userExtTopics.jsp
  • _userTopics.jsp

action/user

  • active.jsp 论坛激活用户接口

    参数

uid:用户ID
username:用户名
nickname:昵称
appCode:应用代码(暂时无用)

说明

调用机器IP需要在后台配置ScoreClientMachine范围内;如果根据用户ID找不到该用户,则新建一个用户,并激活。

  • actived.jsp 论坛检查用户是否激活接口

    参数

uid:用户ID数组(用户“,”分隔)

说明

调用机器IP需要在配置ScoreClientMachine范围内;传入用户ID数组,输出未激活的用户ID。

  • admin_forums.jsp 论坛获取用户管理角色接口

    参数

uid:用户ID

说明

用于在帖子页头衔上面显示。

  • check_favorite.jsp 论坛判断当前登录用户是否收藏了该帖子接口

    参数

tid:主题ID

说明

如果是收藏了,则返回0,否则返回-1;需要用post方式提交。

  • contribution_update.jsp 论坛调用户贡献接口

    参数

uid:用户ID
contribution:需要增加的贡献值
reason:原因

说明

需要用post方式提交,调整完之后会发送一条系统消息给用户。

  • delete_post.jsp 论坛清除用户发帖接口

    参数

uid:用户ID
reason:原因

说明

必须使用post方式提交。

  • exscore_update.jsp 论坛调用户扩展积分接口

    参数

uid:用户ID
exscore:需要增加的积分值
reason:原因
type:扩展积分

说明

需要用post方式提交,调整完之后会发送一条系统消息给用户。

  • favorite.jsp 论坛用户收藏接口

    参数

fid:板块ID
tid:主题ID

说明

当前登录用户收藏包括板块或主题,收藏成功后会发动态到个人中心,必须使用post方式提交。

  • favorite_delete.jsp 论坛删除当前登录用户收藏接口

    参数

fid:板块ID
tid:主题ID

说明

支持批量删除,id用户“,”分隔。

  • favorite_forums.jsp 论坛获取当前登录用户收藏板块接口

    参数

pageNo:第一页,默认第一页
pageSize:每页显示多少条,默认10条

说明

返回json数组格式。

  • favorite_topics.jsp 论坛获取当前登录用户收藏主题接口

    参数

pageNo:第一页,默认第一页
pageSize:每页显示多少条,默认10条

说明

返回json数组格式。

  • lock.jsp 论坛锁用户接口

    参数

fid:锁单个板块ID
uid:锁单个用户ID
fids:批量锁板块ID
uids:批量锁用户ID
reason:原因
expiration:锁至日期(如果时间大于2050年则只设到2050年,防止时间太大造成mysql数据库无法正常识别)
type:如果是all,则锁全站,否则锁板块

说明

支持批量锁用户;非管理员角色,默认会发系统消息给用户;需要使用post方式提交。

  • lock_all.jsp 论坛锁用户接口

    参数

uid:锁单个用户ID
reason:原因
expiration:锁至日期(如果时间大于2050年则只设到2050年,防止时间太大造成mysql数据库无法正常识别)

说明

把单个用户锁全站;需要使用post方式提交;调用机器IP需要在后台配置ScoreClientMachine范围内。。

  • medal_update.jsp 论坛更新用户勋章接口

    参数

uid:锁单个用户ID
reason:原因
medalId:勋章ID

说明

如果传入的勋章ID不在用户已有勋章范围内,则新增;如果用户已有的勋章ID不在传入勋章范围内,则删除该勋章。

  • propstr_update.jsp 论坛更新用户自定义头衔接口

    参数

uid:用户ID
reason:原因
propstr:自定义头衔

说明



  • recent_forums.jsp 论坛获取当前登录用户最近浏览板块接口

    参数 说明

根据cookie--"visitedfid"找到用户最近浏览的板块,返回json数组格式

  • score_update.jsp 论坛调用户积分接口

    参数

uid:用户ID
reason:原因
score:需要增加的积分值[BR]]

说明

需要用post方式提交,调整完之后会发送一条系统消息给用户

  • sign_disable.jsp 论坛屏蔽用户签名接口

    参数

uid:用户ID
username:用户名
uids:多个用户ID[BR]] fid:板块ID(用于判断权限)
reason:原因

说明

支持批量处理用户签名;需要用post方式提交;屏蔽完之后会发送系统消息

  • sign_enable.jsp 论坛激活用户签名接口

    参数

uid:用户ID
username:用户名
uids:多个用户ID[BR]] fid:板块ID(用于判断权限)
reason:原因

说明

支持批量处理用户签名;需要用post方式提交;激活完之后会发送系统消息

  • unlock.jsp 论坛用户解锁接口

    参数

lockId:锁ID
reason:原因

说明

根据锁ID解锁用户;解锁完之后完之后会发送系统消息

  • unlock_all.jsp 论坛用户解锁(全站)接口

    参数

uid:用户ID
reason:原因

说明

把单个用户全站解锁;需要使用post方式提交;调用机器IP需要在后台配置ScoreClientMachine范围内。

  • unlockByUserId.jsp 论坛用户解锁接口

    参数

uids:用户ID
reason:原因

说明

按用户id对用户全站被锁的模块都解锁;支持批量方式;需要post方式提交;解锁完之后完之后会发送系统消息

  • update.jsp 论坛修改用户信息接口

    参数

nickname:昵称
sign:个性签名
hintMessage:是否暗示消息(?)
propNum:用户所在城市ID
propStr:扩展字段

说明

修改当前登录用户个性签名(自动激活)、扩展字段(如果是汽车网则包括地区ID)、昵称、hintMessage;需要用post方式提交

  • update_contact.jsp 论坛修改用户联系方式接口

    参数

uid:用户ID
contact:联系方式
reason:原因

说明

家居网专有(以后可以废弃,改用controller方式)

  • updateProp.jsp 论坛修改用户信息接口

    参数

propNum:用户所在城市ID
propStr:拥有车型ID;车型名,如没有车型的填写车系ID;车系名
type: 为0时,更新两个,当为1时,更新propStr,当为2时,更新propNum

说明

修改当前登录用户个性签名(自动激活)、扩展字段(如果是汽车网则包括地区ID)、昵称、hintMessage;需要用post方式提交

  • user_json.jsp 论坛获取单个用户信息接口

    参数

id:用户ID
name:账号
callback: 回调函数

说明

返回json,信息包括用户ID、账号、昵称、注册时间、积分、所在角色组名

  • user_setting_json.jsp 论坛获取单个用户信息接口

    参数

uid:用户ID
name:账号
callback: 回调函数

说明

包括用户所有信息,如果不是审核员,还会返回用户管理角色列表。