Yupoo API 概述
要调用Yupoo的API,您必需先申请并配置一个API Key。申请API Key .
然后您需要选择一种请求形式。目前,Yupoo支持两种请求形式(REST和XML-RPC,它们都基于HTTP协议)。发送一个HTTP请求到特定的地址,并指定调用的方法名和参数,然后会返回格式化的结果.
例如,以REST形式为例,API地址为 http://www.yupoo.com/api/rest/
如果要调用方法yupoo.photos.search,API Key为9a0554259914a86fb9e7eb014e4e5d52,要搜索的tags为"china",那么请求的所有参数为:
- method = yupoo.photos.search
- api_key = 9a0554259914a86fb9e7eb014e4e5d52
- tags = china
最后要发送一个如下的HTTP请求:
http://www.yupoo.com/api/rest/?method=yupoo.auth.search&api_key=9a0554259914a86fb9e7eb014e4e5d52&tags=china
请求的method参数指定调用的方法名.
请求的api_key参数指定用户的API Key.
REST形式的请求默认返回REST形式的返回结果。您可以再添加一个参数format指定返回结果的格式,值可以为"rest"或"xmlrpc".具体请查看返回形式文档
注意:所有请求都必需以UTF-8编码发送
参数说明
以下参数为通用参数,哪些请求必需指定都作了相应说明,具体API方法文档里不再指出。
- method: 要调用的方法名 (除了上传请求其它请求都必需指定)
- api_key: 您的API Key (所有请求都必需指定)
- auth_token: 用户登录认证码 (所有需要认证的方法请求必需指定)
- api_sig: 签名 (所有需要认证的方法请求和认证相关的方法请求-yupoo.auth.*-都必需指定)
错误代码
以下错误代码为通用错误代码,具体API方法文档里不再指出。
- 96: Invalid signature
- 签名不正确
- 97: Missing signature
- 需要签名,但是没有传递这个参数
- 98: Login failed / Invalid auth token
- auth_token未指定或不正确
- 99: User not logged in / Insufficient permissions
- 用户未登录或权限不足
- 100: Invalid API Key
- API Key不正确
- 105: Service currently unavailable
- 服务暂时不可用
- 112: Method not found
- 调用的方法不存在
- 115: Invalid XML-RPC Method Call
- 无法分析XML-RPC请求
- 125: Missing required argument
- 没有指定某些必需的参数
- 126: API Key expired
- API Key已经过期
- 127: Unconfigured API Key
- API Key未配置
- 128: User disabled
- 用户被禁用