文档目录:

• ZuosaAPI的使用说明
• 认证方式
• 用户id
• 搜索
• 消息和状态
• 显示大家在做啥
• 显示用户在做啥
• 显示用户和好友在做啥
• 获取一条指定的消息
• 发布一条新消息
• 删除一条消息
• 获取对某个用户的回复的消息
• 用户和好友关系
• 好友列表
• 粉丝列表
• 显示用户信息
• 添加好友
• 删除好友
• 判断两个用户是否是好友关系
• 私信
• 显示收到的私信
• 显示发件箱
• 发送私信
• 删除私信
• 用户帐号验证
• TAG_API_的接口调用
• 通过tag搜索
• 列出热门的tag
• 注册API
• Help
• 收藏
• 查看用户的收藏列表
• 添加一条收藏
• 删除一条收藏
• 阻止列表
• 添加一个阻止
• 删除一个阻止

ZuosaAPI的使用说明

认证方式

如需要验证用户，验证方式为 HTTP Basic 验证.

参考 RFC 2617

http://docstore.mik.ua/rfc/rfc2617.html ftp://ftp.isi.edu/in-notes/rfc2617.txt

用户id

即用户名, http://zuosa.com/ zuosa 粗体部分为用户名.

注意：

API中涉及到的用户ID，如果含有中文请使用UTF-8字符集编码。

如果通过URL中传递的请将此参数使用UrlEncode进行编码

搜索

URL: http://api.zuosa.com/search.[json|xml|rss|atom]

参数:

q: 查询表达式，如果含有中文请使用URLEncode编码

ec: (可选)参数q中的中文字符集，默认为 gb2312

page: (可选)获取结果的分页，最大1500

count: (可选)获取结果的分页的行数，最大100

消息和状态

显示大家在做啥

返回最近20个大家在做啥的消息

URL: http://api.zuosa.com/statuses/public_timeline.[json|xml|rss] 参数: (无)

显示用户在做啥

URL: http://api.zuosa.com/statuses/user_timeline.[json|xml|rss]?id=zuosa

http://api.zuosa.com/statuses/user_timeline/zuosa.[json|xml|rss]

参数:

id: (可选) 没有此参数表示获取验证用户的timeline count: (可选)返回的记录数,默认为20,范围1-20

显示用户和好友在做啥

URL: http://api.zuosa.com/statuses/friends_timeline.[json|xml|rss]?id=zuosa

http://api.zuosa.com/statuses/friends_timeline/zuosa.[json|xml|rss]

参数:

id: (可选) 没有此参数表示获取验证用户的timeline count: (可选)返回的记录数,默认为20,范围 1-20

获取一条指定的消息

查看显示一条指定的消息ID URL: http://api.zuosa.com/statuses/show.[json|xml]?id=2345

参数:

id: (消息的id)

发布一条新消息

发布一条新的消息,发布成功后将按照返回的格式请求返回这条更新 URL: http://api.zuosa.com/statuses/update.[json|xml]

参数:

status (必需) - 消息内容，使用 POST 方式提交,utf-8编码

in_reply_to_status_id(可选) - 指定回复的消息id

source (可选) - 消息来源，如果与zuosa的应用名称.(应用名称，需通过做啥的验证)。

Source 在Head中传递.

如果要上传图片按照 RFC 1867 http://www.ietf.org/rfc/rfc1867.txt 方式上传 ZuosaApi 将取 第一个且只第一个 文件作为用户上传的图片.

删除一条消息

删除一条消息

URL: http://api.zuosa.com/statuses/destroy.[json|xml]

参数:

id (必须) - 消息的id

http://api.zuosa.com/statuses/destroy.xml?id=123456

获取对某个用户的回复的消息

删除一条消息

URL: http://api.zuosa.com/statuses/mentions.[json|xml]

参数:

page(可选) - 获取第几页的数据。每页20条

http://api.zuosa.com/statuses/mentions.xml?page=1

用户和好友关系

好友列表

获取指定用户的好友列表

URL: http://api.zuosa.com/users/friends.[json|xml]

参数:

id (必须) – 用户名id

http://api.zuosa.com/users/friends.xml?id=zuosa

粉丝列表

获取指定用户的粉丝列表

URL: http://api.zuosa.com/users/followers.[json|xml]

参数:

id (必须) – 用户名id

http://api.zuosa.com/users/followers.xml?id=zuosa

显示用户信息

显示用户信息

URL: http://api.zuosa.com/users/show.[json|xml]

参数:

id (必须) – 用户名id

http://api.zuosa.com/users/show.xml?id=zuosa

添加好友

添加好友,成功则按照请求的格式返回好友的用户信息,否则就返回一个字符串说明失败的原因

URL: http://api.zuosa.com/friendships/create.[json|xml]

参数:

id (必须) –要加为朋友的用户名id

http://api.zuosa.com/friendships/create.xml?id=zuosa

删除好友

删除好友,成功则按照请求的格式返回好友的用户信息,否则就返回一个字符串说明失败的原因

URL: http://api.zuosa.com/friendships/destroy.[json|xml]

参数:

id (必须) –要加为朋友的用户名id

http://api.zuosa.com/friendships/destroy.xml?id=zuosa

判断两个用户是否是好友关系

URL: http://api.zuosa.com/friendships/exists.[json|xml]

参数:

user_a (必须) – 第一个用户的用户名id

user_b (必须) – 第二个用户的用户名id

如果user_b 是user_a 的好友则返回true，不是则返回false

http://api.zuosa.com/friendships/exists.xml?user_a=alex&user_b=zuosa

私信

显示收到的私信

URL: http://api.zuosa.com/direct_messages/inbox.[json|xml]

http://api.zuosa.com/direct_messages.[json|xml]

参数: 无

显示发件箱

URL: http://api.zuosa.com/direct_messages/outbox.[json|xml]

参数: 无

发送私信

URL: http://api.zuosa.com/direct_messages/new.[json|xml]

参数:

user (必须) 收件人 POST提交

text (必须) 私信内容 POST 提交

删除私信

URL: http://api.zuosa.com/direct_messages/destroy.[json|xml]

参数:

id: 私信id

用户帐号验证

URL: http://api.zuosa.com/account/verify_credentials.[json|xml]

认证成功返回

XML	<authorized>True</authorized>

JSON	{"authorized":True}

TAG_API_的接口调用

通过tag搜索

URL: http://api.zuosa.com/tag/search.[json|xml]?id=zuosa&tag=tag1,tag2,tag3

参数:

id: (可选) 没有此参数表示在所有人发送的消息的范围内搜索,否则表示这个用户的

count: (可选)返回的记录数,默认为20,范围 1-50

ec: (可选) url中的tag字符编码,不填表示gb2312.

说明:

tag1,tag2,tag3是3个tag,之间使用逗号(英文半角)分隔.

如果某个tag中含有逗号请用双引号(英文半角)括起. 例如: tag1,”tag,2”

列出热门的tag

URL: http://api.zuosa.com/tag/list.[json|xml]?id=zuosa

参数:

id: (可选) 没有此参数表示zuosa中最热的tag,否则表示这个用户的最热的tag

count: (可选)返回的记录数,默认为20,范围 1-20

返回:

       <tags>

         <tag refcount=”2” clickcount=”52” >TagName1</tag>

         <tag refcount=”2” clickcount=”52” >TagName2</tag>

       </tags>

注册Api

URL: http://api.zuosa.com/register/create.[json|xml]

参数:

source （必须）： 注册的来源(需要zuosa认证的来源ip鉴权才能使用注册api)

username（必须）：帐号，格式：字母开头只能包含字母,数字,"-"

password（必须）：密码，格式：必须为六位以上（包括六位）

gender （可选）：f为女性，m为男性，不填默认为女性

blogurl （可选）：博客地址，格式：http打头的合法格式的url地址

birthday （可选）：格式：年-月-日，例：1900-08-08

email （可选）：格式：包含@符号的合法格式的email

注册成功返回

XML

<register>

    <registinfo statuescode="200">

         <message>注册成功</message>

    </registinfo>

    <userinfo>

         <id>XXX</id>

         <name>XXX</name>

         <screen_name>XXX</screen_name>

         <gander>XXX</gander>

         <location />

         <description />

         <profile_image_url>XXXX</profile_image_url>

         <blogurl>XXX</blogurl>

         <protected>False</protected>

    <userinfo>

  </register>

注册失败返回：

    <registinfo statuescode="XXX">

         <message>XXX</message>

    </registinfo>

    <userinfo/>    

信息返回码说明：

• 注册成功：200
• 没有来源：100
• 鉴权失败：101
• 用户名无效：102
• 用户名被占用：103
• 密码少于六位：104
• 生日格式错误：105
• Email格式错误：106
• 博客地址错误：107

Help

Help/test 测试api服务的运行情况

URL: http://api.zuosa.com/help/test.xml.[json|xml]

收藏

查看用户的收藏列表

URL: http://api.zuosa.com/favorites.[json|xml]

参数:

page: 第几页（从0开始，每页20条）

http://api.zuosa.com/favorites.xml

添加一条收藏

URL: http://api.zuosa.com/favorites/create.[json|xml]

参数:

Id: 更新消息的id

http://api.zuosa.com/favorites/create.xml?id=649147

删除一条收藏

URL: http://api.zuosa.com/favorites/destroy.[json|xml]

参数:

Id: 更新消息的id

http://api.zuosa.com/favorites/destroy.xml?id= 649147

阻止列表

添加一个阻止

URL: http://api.zuosa.com/blocks/create.[json|xml]

参数:

Id: 要阻止的用户名id

http://api.zuosa.com/blocks/create.xml?id=zuosa

删除一个阻止

URL: http://api.zuosa.com/blocks/destroy.[json|xml]

参数:

Id:要解除阻止的用户名id

http://api.zuosa.com/blocks/destroy.xml?id=zuosa