nForum API

更新时间: 2013年3月11日

nForum API文档已经全迁移至github wiki,地址为https://github.com/xw2423/nForum/wiki/nForum-API

认证方式
Basic Auth

用户接口
/user/query/id.获取用户信息
/user/login.用户登录
/user/logout.用户退出

分区接口
/section.获取所有根分区信息
/section/name.获取分区信息

版面接口
/board/name.获取版面信息

文章接口
/article/board/id.获取文章信息
/threads/board/id.获取主题信息
/article/board/post.发表文章
/article/board/forward/id.转寄文章
/article/board/update/id.更新文章
/article/board/delete/id.删除文章

附件接口
/attachment/(board|box)/id_id) 获取附件信息
/attachment/board/add/id.上传附件
/attachment/board/delete/id.删除附件

信件接口
/mail/box.获取信箱信息
/mail/info.获取信箱的属性信息
/mail/box/num.获取信件信息
/mail/send.发信接口
/mail/box/forward/num.转寄信件
/mail/box/reply/num.回信接口
/mail/box/delete/num.删除信件

收藏夹接口
/favorite/level.获取收藏夹信息
/favorite/add/level.向某一级收藏夹添加版面_目录
/favorite/delete/level.删除某一级收藏夹下的版面_目录

搜索接口
/search/board.搜索版面或目录
/search/article.搜索一个或多个版面的文章
/search/threads.搜索一个或多个版面的主题

提醒接口
/refer/type.获取指定提醒类型列表
/refer/type/info.获取指定类型提醒的属性信息
/refer/type/setRead/index.设置指定提醒为已读
/refer/type/delete/index.删除指定提醒

widget接口
/widget/topten.获取十大热门话题信息
/widget/recommend.获取推荐文章信息
/widget/section-name.获取分区热门话题信息

元数据
User.用户
Article.文章
Board.版面
Section.分区
Attachment.附件
Mailbox.信箱
Mail.信件
Favorite.收藏夹
Pagination.分页
Refer.提醒
Widget.widget

更新日志
Changelog 2012-02-02
Changelog 2012-12-23

  1. 2011年5月28日10:38

    此帖必火。。。

  2. mymiss
    2011年6月4日10:40

    赞!

  3. 2011年7月21日02:57
  4. 2011年7月22日23:48

    @moqi 唔。。链接改好了。。。

  5. iamlinix
    2012年12月23日17:01

    大赞~~!!

  6. longfloat
    2013年7月14日22:11

    求问哈,这个API在用的时候是这样调用么,如果是调用学校论坛的话:
    http://username:password/api.byr.cn/……

  7. longfloat
    2013年7月14日22:11

    啊,打错了,http://username:password@api.byr.cn/……
    是这样么?

  8. 2013年7月18日19:05

    是使用http basic auth的验证方式,用户名密码是在http头里面。有关这种验证方式的调用请google一下。

请输入算式结果(看不清请点击图片)
(必须)