[v0.1.2]虎绿林API手册

@Ta 2015-11-14 6909点击
【2017年后】该API已废弃,请参考新API手册:https://hu60.cn/q.php/bbs.topic.82570.html
【2015-11-14】v0.1.2:为版块列表添加了更多参数
【2015-11-14】v0.1.1:添加了版块列表

--------

欢迎基于虎绿林API开发第三方应用程序。

API地址:
https://hu60.cn/wap/0wap/m.php/api.类别.json

目前的类别有:bbs、bbsview、chat、user

参数采用GET字符串形式传递,须进行urlcode编码,如:
https://hu60.cn/wap/0wap/m.php/api.chat.json?type=chat&name=%E5%85%AC%E5%85%B1%E8%81%8A%E5%A4%A9%E5%AE%A4

API输出格式:json
通过可选的json参数可调整json的格式。
例:https://hu60.cn/wap/0wap/m.php/api.chat.json?json=object,compact&type=chat&name=%E5%85%AC%E5%85%B1%E8%81%8A%E5%A4%A9%E5%AE%A4
json参数的各个选项以逗号分隔,有以下几种:
    readable:输出可读的json,用空格和回车分隔各对象
    compact:输出压缩的json,json各对象见无任何间隔
    mixed:输出的json既包含数组也包含对象
    object:将输出中的数组强制转换为对象
若未指定json参数,默认json=readable,mixed。
建议指定json=compact,便于解析器解析。很多解析器不能解析含有换行符的json。

API错误:若API出错,则返回包含error和errmsg字段的数据。其中error被设为true,errmsg是错误信息。例:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=unknowntype
返回以下数据:
{
    "error": true,
    "errmsg": "未知类型 'unknowntype'"
}
未出错时输出不会包含error字段。调用者应检测error字段,以发现错误。

以下按功能介绍各API(可选参数json=……不再介绍):
帖子列表:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=tzlist&bkid=0&order=hftime&offset=0&size=20&tznr=80
参数解读:
    type:必须,操作类型。
    bkid:可选,版块id。若未指定或为0,则获取全部帖子列表。
    order:可选,排序方法,可取值hftime(按最后回复时间排序)或fttime(按发帖时间排序)。均为倒序排列,既较新的排在前面。
    offset:可选,返回数据的开始位置,第一条的编号为0。若未指定,默认为0。
    size:可选,返回条数。若未指定,默认为15。不可大于1000。
tznr:可选,若指定,则返回指定字数的帖子内容,若为-1则返回帖子全文。

小提示:如何为帖子内容添加省略号
    比如要显示80字,多于80字则在末尾添加省略号,可以这样做:获取81字,如果有第81字,则添加省略号。

返回格式:
{
    "size": 返回条数,
    "count": "该版块总帖子数",
    "data": [
        {
            "id": "帖子id",
            "bkid": "所属版块id",
            "title": "标题",
"nr": "帖子部分内容",
            "uid": "发帖用户id",
            "uname": "发帖用户名",
            "fttime": "发帖时间戳",
            "hftime": "最新回复时间戳",
            "hfcount": "回复条数",
            "rdcount": "点击数"
        },
        {
            …第二条,同上…
        },
        ……
    ]
}

帖子内容:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=tz&tzid=21952&parse=2
参数解读:
    type:必须,操作类型。
    tzid:必须,帖子id。
    parse:可选,是否解析帖子内容。若为0,则返回原始数据;为2则返回ubb解析后的结果,为1则返回api解析后的结果(其中的特定链接被替换为 https://appevent/事件?参数 的形式,方便应用识别,具体替换规则见后文)。
返回格式:
{
    "tzid": "帖子id",
    "bkid": "所属版块id",
    "uid": "发帖用户id",
    "uname": "发帖用户名",
    "title": "标题",
    "nr": "内容",
    "fttime": "发帖时间",
    "hftime": "最新回复时间",
    "hfcount": "回复数",
    "rdcount": "点击数"
}

回复列表:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=hf&tzid=21952&parse=2&order=desc&offset=0&size=3
参数解读:
    type:必须,操作类型。
    tzid:必须,帖子id。
    parse:可选,是否解析帖子内容。若为0,则返回原始数据;为2则返回ubb解析后的结果,为1则返回api解析后的结果(其中的特定链接被替换为 https://appevent/事件?参数 的形式,方便应用识别,具体替换规则见后文)。
    order:可选,排序方法。有desc(倒序)和asc(顺序)两种。
    offset:可选,返回数据的开始位置,第一条的编号为0。若未指定,默认为0。
    size:可选,返回条数。若未指定,默认为15。不可大于1000。
返回格式:
{
    "tzid": 帖子id,
    "count": "回复总数",
    "offset": 开始位置,
    "size": 返回条数,
    "data": [
        {
            "tzid": "帖子]",
            "uid": "回复用户id",
            "uname": "回复用户名",
            "nr": "回复内容",
            "hftime": "回复时间"
        }
    ]
}

因老虎懒,以下API日后再详细解释,也可加Q905172616询问细节。

版块列表(bkinfo是可选参数,逗号分隔想获取的内容):
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=bklist&bkinfo=bzid,extra,count

分区列表:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=bklist&bkinfo=nobk

论坛搜索:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=search&words=搜索词&uname=用户名&offset=0&size=20&tznr=80
    搜索词可以为多个,用空格隔开;
    用户名和搜索词都是可选的,但是至少指定一个;
    仅指定用户名时即搜索指定用户的帖子;
    最大size为1000,
不指定tznr时不输出帖子内容(部分),
    可以通过附加参数&tzinfo=bkid,time,count来获得额外信息。

论坛搜索兼帖子列表:
https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=tzlist_search&bkid=0&order=hftime&words=搜索词&uname=用户名&offset=0&size=20&tznr=80
    若words或uname不为空,则进行论坛搜索(忽略bkid和order参数),否则显示帖子列表。

聊天室列表:
https://hu60.cn/wap/0wap/m.php/api.chat.php?type=chatlist

聊天室内容:
https://hu60.cn/wap/0wap/m.php/api.chat.php?type=chat&name=%E5%85%AC%E5%85%B1%E8%81%8A%E5%A4%A9%E5%AE%A4&offset=0&size=10&parse=0

用户ID转用户名:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=uid2name&uid=1

用户名转用户ID:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=name2uid&name=%E8%80%81%E8%99%8E%E4%BC%9A%E6%B8%B8%E6%B3%B3

获取指定uid用户信息:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=uinfo&uid=1&uinfo=tx,qm,lx,zc

登录(获取sid):
https://hu60.cn/wap/0wap/m.php/api.user.php?type=login&name=%E8%80%81%E8%99%8E%E4%BC%9A%E6%B8%B8%E6%B3%B3&pass=密码

新内信条数:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=newmsg&sid=用户sid

已读/未读/全部内信条数:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=msgstat&sid=用户sid

内信列表:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=msglist&sid=用户sid&read=all
参数:
    read有三种取值:0未读,1已读,all全部

内信内容:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=msgview&sid=用户sid&msgid=内信id&parse=0

用户信息:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=info&sid=用户sid

at消息条数:
https://hu60.cn/wap/0wap/m.php/api.user.php?type=atstat&sid=…

at消息内容(read=0未读,1已读):
https://hu60.cn/wap/0wap/m.php/api.user.php?type=atlist&read=1&offset=0&size=5&sid=…


--------

【获取用户额外信息】
所有返回结果中包含uid的API,都可以通过在URL中附加以下字段得到用户的额外信息:
    &uinfo=tx,zc,lx,qm
如:
    https://hu60.cn/wap/0wap/m.php/api.bbs.json?type=hf&tzid=21952&parse=2&order=desc&offset=0&size=3&uinfo=tx,zc,lx,qm
其中:
    tx:用户头像,返回'utoux'字段;
    zc:注册时间,返回'uzhuc'字段(可能为null,表示“该用户是很久以前注册的,那时没有记录注册时间”);
    lx:用户联系方式,返回'ulianx'字段;
    qm:个性签名,返回'uqianm'字段。
API调用者可以根据需要获取指定的字段,比如:
    uinfo=tx,zc
只获取头像和注册时间。

其他API尚未实现,有问题请联系QQ905172616。
回复列表(73)
添加新回复
回复需要登录

[聊天-此处没有老虎] 情醉中国风:百度鉴黄 Redmi K.O