饭否 API

概念

用户验证
如需要验证用户,验证方式为 HTTP Basic 验证。
» 返回目录
用户 id
用户 id 在个人网址中,例如:http://fanfou.com/fanfou 蓝色的部分即为用户 id。
» 返回目录
使用 API 的简单途径
如果你的系统中有 cURL,就可以通过非常简单的方式使用这些API了。
示例:
  • 显示随便看看的消息
    curl http://api.fanfou.com/statuses/public_timeline.rss
  • 显示用户消息
    curl -u loginname:password http://api.fanfou.com/statuses/user_timeline.rss
  • 显示用户和好友的信息
    curl -u loginname:password http://api.fanfou.com/statuses/friends_timeline.rss
  • 发布消息
    curl -u loginname:password -d status="消息内容" http://api.fanfou.com/statuses/update.xml
» 返回目录
现有的 API 应用
API 应用 (随时更新)
你有新奇好玩的 API 应用?请与我们联系,email 是 api@fanfou.com,信中写上插件的简介、名称以及网址。
» 返回目录

消息方法

显示用户的消息
路径: http://api.fanfou.com/statuses/user_timeline.[json|xml|rss]
参数:
  • id (可选) - 用户 id,没有此参数时需验证用户。
    示例: http://api.fanfou.com/statuses/user_timeline.rss?id=fanfou
    	或 http://api.fanfou.com/statuses/user_timeline/fanfou.rss
  • count (可选) - 消息数,范围 1-20,默认为 20。
    示例: http://api.fanfou.com/statuses/user_timeline.rss?count=10
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用。
    示例: http://api.fanfou.com/statuses/user_timeline.rss?callback=getStatuses
» 返回目录
显示用户和好友的消息
路径: http://api.fanfou.com/statuses/friends_timeline.[json|xml|rss]
参数:
  • id (可选) - 用户 id,没有此参数时需验证用户。有此参数时返回的是此用户和好友的所有消息,没有此参数时返回的是当前用户的首页中的最新消息
    示例: http://api.fanfou.com/statuses/friends_timeline.rss?id=fanfou
    	或 http://api.fanfou.com/statuses/friends_timeline/fanfou.rss
  • count (可选) - 消息数,范围 1-20,默认为 20。
    示例: http://api.fanfou.com/statuses/friends_timeline.rss?count=10
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/statuses/friends_timeline.rss?callback=getStatuses
» 返回目录
显示随便看看的消息
路径: http://api.fanfou.com/statuses/public_timeline.[json|xml|rss]
参数:
  • count (可选) - 消息数,范围 1-20,默认为 20。
    示例: http://api.fanfou.com/statuses/public_timeline.rss?count=10
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/statuses/public_timeline.rss?callback=getStatuses
» 返回目录
显示指定消息
路径: http://api.fanfou.com/statuses/show.[json|xml]
参数:
  • id (必须) - 消息的id。
    示例: http://api.fanfou.com/statuses/show.xml?id=6IAZmgy1TzA
    	或 http://api.fanfou.com/statuses/show/6IAZmgy1TzA.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/statuses/show.xml?callback=getStatuses
» 返回目录
发布消息
路径: http://api.fanfou.com/statuses/update.[json|xml]
参数:
  • status (必需) - 消息内容,使用 POST 方式提交
  • source (可选) - 消息来源,使用 POST 方式提交,如果与饭否的数据库匹配,网页上将以此格式显示: …………(消息内容) 通过 ***(对应的 API 应用名称,需通过饭否的验证)。
» 返回目录
删除消息
路径: http://api.fanfou.com/statuses/destroy.[json|xml]
参数:
  • id (必须) - 消息的id。
    示例: http://api.fanfou.com/statuses/destroy.xml?id=6IAZmgy1TzA
    	或 http://api.fanfou.com/statuses/destroy/6IAZmgy1TzA.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/statuses/destroy.xml?callback=getStatuses
» 返回目录

用户方法

显示好友列表
路径: http://api.fanfou.com/users/friends.[json|xml]
参数:
  • id (可选) - 用户 id,没有此参数时需验证用户。
    示例: http://api.fanfou.com/users/friends.xml?id=fanfou
    	或 http://api.fanfou.com/users/friends/fanfou.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/users/friends.xml?callback=getStatuses
» 返回目录
显示关注者列表
路径: http://api.fanfou.com/users/followers.[json|xml]
参数:
  • id (可选) - 用户 id,没有此参数时需验证用户。
    示例: http://api.fanfou.com/users/followers.xml?id=fanfou
    	或 http://api.fanfou.com/users/followers/fanfou.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/users/followers.xml?callback=getStatuses
» 返回目录
显示用户信息
路径: http://api.fanfou.com/users/show.[json|xml]
参数:
  • id (可选) - 用户 id,没有此参数时需验证用户。
    示例: http://api.fanfou.com/users/show.xml?id=fanfou
    	或 http://api.fanfou.com/users/show/fanfou.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/users/show.xml?callback=getStatuses
» 返回目录
添加好友
路径: http://api.fanfou.com/friendships/create.[json|xml]
参数:
  • id (必须) - 用户 id
    示例: http://api.fanfou.com/friendships/create.xml?id=fanfou
    	或 http://api.fanfou.com/friendships/create/fanfou.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/friendships/create.xml?callback=getStatuses
» 返回目录
删除好友
路径: http://api.fanfou.com/friendships/destroy.[json|xml]
参数:
  • id (必须) - 用户 id
    示例: http://api.fanfou.com/friendships/destroy.xml?id=fanfou
    	或 http://api.fanfou.com/friendships/destroy/fanfou.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/friendships/destroy.xml?callback=getStatuses
» 返回目录

私信方法

显示用户收到的私信
路径: http://api.fanfou.com/private_messages/inbox.[json|xml]
参数:
  • count (可选) - 私信数,范围 1-20,默认为 20。
    示例: http://api.fanfou.com/private_messages/inbox.xml?count=10
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用。
    示例: http://api.fanfou.com/private_messages/inbox.xml?callback=getStatuses
» 返回目录
发送私信
路径: http://api.fanfou.com/private_messages/new.[json|xml]
参数:
  • user (必需) - 收信人 id ,使用 POST 方式提交
  • text (必需) - 私信内容,使用 POST 方式提交
» 返回目录
删除私信
路径: http://api.fanfou.com/private_messages/destroy.[json|xml]
参数:
  • id (必须) - 私信的id。
    示例: http://api.fanfou.com/private_messages/destroy.xml?id=102;
    	或 http://api.fanfou.com/private_messages/destroy/102.xml
  • callback (可选) - JavaScript 函数名,使用 JSON 格式时可用,将 JSON 对象作为参数直接调用
    示例: http://api.fanfou.com/private_messages/destroy.xml?callback=getStatuses
» 返回目录