wiki:intf

Version 33 (modified by lifeng, 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 获取用户数据

参数 pageType：为user时，返回发帖数排行用户JSON;为lastpost时，返回最后发帖的用户JSON
days：多少天的数据
pageSize：每页显示多少条（默认50）
userIds：用户ID
faceWidth：用户头像宽度
type：“week”为本周贴数，“pick”为全部精华帖,需要返回头像
callback：回调函数
说明 返货json数据格式，包括用户ID、用户名、昵称、用户个人中心url地址、头像宽度、发主题数、回帖数；接口缓存10小时

  • _topicRepliesJson.jsp 根据主题ID，按顺序分页显示回帖

    参数

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

说明

返回数据类型为JSON

  • _forumNames.jsp 取版块名称
  • _contributionUsers.jsp 论坛获取全站用户贡献值排行榜接口

参数 aa：显示数据的个数，默认值是10
type：输出地格式默认是ssi,还有json可选
callback：回调函数
说明 输出结果包括用户ID、用户名、昵称、用户个人中心url地址；用ssi或者json列出；接口缓存10小时

  • _block_forums.jsp 给果派论坛首页使用

intf/special

  • _active_user.jsp 得到论坛的活跃好友ID

参数 size：从数据库里拿出的活跃好友个数
returnsize：返回的个数
callback：回调函数
说明 先从bbs7_user 按lastpostat排序(7天内)，取前size个,最后随机返回returnsize个用户的ID；接口缓存10小时

  • _searchHTML.jsp 通过关键字或标题搜索帖子内容,结果从快搜得到

    参数

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

说明

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

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

参数 sids：车系ID，多个ID半角逗号分隔(需要在后台板块车系对应插件配置中配置对应关系)
callback：回调函数
说明 返回json格式；接口缓存10小时

  • _searchHTML.jsp 通过关键字或标题搜索帖子内容,结果从快搜得到

intf/user

  • _topics.jsp 我的主题

参数 userId：用户ID
pageSize：每页显示多少条（默认50）
pageNo：第几页
maxLength：帖子内容显示最大长度
callback：回调函数
说明 返回json格式；结果会过滤已删除及未审核;接口缓存10小时

  • _posts.jsp 我的回复

参数 userId：用户ID
pageSize：每页显示多少条（默认50）
pageNo：第几页
callback：回调函数
说明 返回json格式；结果会过滤已删除及未审核;接口缓存10小时

  • _picks.jsp 我的精华帖

参数 userId：用户ID
pageSize：每页显示多少条（默认50）
pageNo：第几页
callback：回调函数
说明 返回json格式；结果会过滤已删除及未审核;接口缓存10小时

  • _favForums.jsp 我收藏的版块

参数 userId：用户ID
pageSize：每页显示多少条（默认50）
pageNo：第几页
callback：回调函数
说明 返回json格式；没有接口缓存

  • _favTopics.jsp 我收藏的帖子

参数 userId：用户ID
pageSize：每页显示多少条（默认50）
pageNo：第几页
callback：回调函数
说明 返回json格式；没有接口缓存

  • _idTopics.jsp 根据ID获取主题对象列表

    参数

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

说明

返回数据类型为JSON

  • _extIds.jsp

    参数

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

说明

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

  • _setVip.jsp

参数 uid：用户ID
action：操作(checkVip:检查车主认证状态)[[BR]] status：状态(1：通过认证；-1：被驳回；2：提交申请成功；-2：被取消资格)
reason：原因
说明 返回JSON格式；需要使用post方式提交；调用机器IP需要在后台配置ScoreClientMachine范围内。

intf

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

参数 type：类别(1,2,3,4,5,6分别表示为score1,score2,score3,score4,score5,score6)
count：多少条（默认10）
display：返回格式
说明 返回js/JSON/ssi格式；接口缓存10小时

  • _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 生成嵌入外部页面的我的发帖列表

参数 memberId：用户id
tag：要用来显示内容的element id,这个参数为空则直接用document.write
target：是回帖（topics）还是主帖（replies），默认显示主帖。
maxSize：列出帖子最大数目,默认10条,不可以长于50条.
maxLength：帖子内容最大长度,默认240个英文字符,相当于120个汉字.
noCss：有这个参数代表不需要生成css.
说明 本页面生成一段javascript，用于生成嵌入外部页面的我的发帖列表。调用方式是<script src="${ROOT}/_myPosts.jsp"></script>；接口缓存10小时

  • _photos.jsp 获取指定帖子内的图片

    参数

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

说明

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

  • _pickForums.jsp 显示论坛板块本周精华帖排行榜 参数

forums,noForums=; 要包含/排除的版块
topicType=; 帖子话题
type=f1/f2; 按1级或2级版块分组
display=; js/json/ssi
count=; 取前几位的版块

说明

查询版块一周精华数排行,没有区分pick和expick

  • _replies_count_json.jsp 获取主题回帖数

    参数

tid=; 主题ID

说明

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

  • _score-member.jsp 获得N天内的灌水或精华英雄榜

参数 type：类别(pick为精华；water为灌水)
count：多少条（默认10）
days：统计多少天之内的（当天的不计）
display：返回格式
说明 返回js/JSON/ssi格式；接口缓存10小时

  • _score-member2.jsp 获得N天内的灌水或精华英雄榜

参数 type：类别(pick为精华；water为灌水)
count：多少条（默认10）
days：统计多少天之内的（当天的不计）
display：返回格式
说明 返回JSON格式；没有接口缓存

  • _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 论坛用户发扩展主题数接口

参数 uid：用户ID
extId：帖子的扩展ID(1:盖楼帖 2:为活动贴 3:交易帖 4:链接帖 5:一帖多发虚拟帖 6:达人牛帖)
dateFrom：开始日期
dateTo：结束日期
ck：回调函数
说明 查询用户在一个时间段内的发扩展主题数，未包括已删除的；接口缓存10小时

  • _userTopics.jsp 论坛用户发主题数接口

参数 uid：用户ID
postCount：最少回帖数
dateFrom：开始日期
dateTo：结束日期
ck：回调函数
说明 查询用户在一个时间段内的发扩展主题数，未包括已删除的；接口缓存10小时

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: 回调函数

说明

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

rest

  • forums.jsp 论坛列表页和发主题接口

    参数

forumId：板块ID
title：主题标题
type：主题类型
message：内容
pageNo：第几页
pageSize：每页显示多少条

说明

POST:发帖;GET:列表页
注:销售配合开始： 2012-11-28至2012-12-04、2012-12-13至2012-12-20 在forum16655版块置顶帖子3431731。

  • topics.jsp 论坛帖子页和发回帖接口

    参数

topicId：主题ID
title：主题标题
reason：删帖原因
message：内容
pageNo：第几页
pageSize：每页显示多少条

说明

POST:回帖;GET:帖子页;DELETE:删主题;PUT:更新主题。

  • topics-posts.jsp 论坛回帖修改和删除接口

    参数

topicId：主题ID
postId：回帖ID
reason：删帖原因
message：内容

说明

DELETE:删帖;PUT:更新。

  • topics-hot.jsp 论坛热榜接口

    参数

range：范围，"week"表示查一周热帖排行；"month"表示查一个月热帖排行；不传则查一天热帖排行
count：获取多少条数据

说明

返回JSON数组格式。

  • topline/tree.jsp 论坛获取直接子版块信息接口

    参数

root：板块ID
callback：回调函数

说明



util

  • 119.jsp
    功能

动态修改spring容器中bean的属性
参数 bean : spring bean id属性

  • adminrole.jsp
    功能

根据用户ID或版块ID来查找管理员角色

  • ai_findpxurl.jsp
    功能

通过topicId查看pickax的url

  • ai_topic_post.jsp
    功能

根据topicId来查看主题状态和该主题下的post状态

  • ai_topic_type_change.jsp
    功能

修改主题的话题类型

  • censor.jsp
    功能

此接口接收的是信息队列发送过来审核平台的信息

  • d_topic.jsp
    功能

此页面用于过滤要删除的主题

  • d.jsp 功能

此页面用于过滤要删除的帖子

  • file.jsp 功能 此接口供各个服务器上的定时任务，获取计数器数据文件
    参数 method : ls(列出文件名)|get(获取计数器数据文件)|rm(删除服务器上的计数器数据文件)
  • import_photo_post.jsp 功能

图片分离补录功能
参数

topicId : 主题id
postId : 帖子id

  • ks_autobbs.jsp 功能

汽车网快搜

  • ks_babybbs.jsp 功能

亲子网快搜

  • ks_bbs.jsp
    功能

电脑网快搜

  • ks_gamesbbs.jsp
    功能

游戏网快搜

  • ks_ladybbs.jsp
    功能

女性网快搜

  • logsetting.jsp 功能

设置EnvFilter的log level

  • mc.jsp 功能

查看或清除mc缓存
参数

action: delete|update|view(默认值)

key: mc缓存key

  • monitor.jsp 功能

查看应用运行效率的利器

  • monitor2.jsp 功能

查看应用运行效率的利器

  • move_forum_topics.jsp 功能

将某个版块的主题移动到指定目标版块

  • online.jsp 功能

获取在线用户的uid列表
参数 cb: 回调函数
ids: 用户id列表，用逗号分隔

返回

在线用户数组

  • poster.jsp 功能

灌水机接口

参数

uid 用户ID
method 有2种方式，发帖与发主题，reply为发帖，默认为发主题
content 帖子内容
tid 主题ID
fid 版块ID
type 主题类别,String 不验证是否当前版块存在,但最好是存在的,否则没法通过类别过滤
title 标题

发表回帖需要uid,method=reply,content,tid
发表主题需要uid,content,fid,type,title
uid,tid,fid用find方法,如论坛没有,则抛出错误

返回

json数据,status=0时，发帖成功

  • px.jsp

功能

向快聚接口发送主题

  • sync.jsp 功能

清除各种常驻内存配置对象的jsp，需要从服务器端发出请求才行
合法服务器的列表在appname = System, appkey = servers应用配置项中

  • test_ip.jsp

功能 本jsp用于测试调用方的服务器ip

  • text.jsp

功能 根据logid查询回帖内容

参数 logid: post备份日志id

date: post_text_history_分表后缀

返回

回帖内容

  • untop_deleted_top.jsp

功能

取消所有全站置项

  • upload.jsp 功能 用flash上传图片
  • user_score.jsp 功能

查看用户积分，贡献等信息

参数

callback:回调函数[[BR]]

ids:用户id列表，用逗号分隔[[BR]]

返回 json格式数组

  • visited_forum_list.jsp 功能 列举指定的版块的信息 参数 type : 返回的数据的格式(html|json)

fids : 版块id列表，用'D'分隔

返回

json格式数组