构建请求
请求由三个部分组成:
- API 版本
- 资源路径
- 输出类型
要构造正确的请求,您需要将 URI 格式化如下:
https://api.yourepo.com/{version}/{resource}.{output_type}
一个示例请求,用于获取已购买包的成员列表。
https://api.yourepo.com/1.0/package/buyers.json?package=com.yourepo.source.package
默认情况下,请求是 HTTP GET 请求。但是,许多方法将要求您发送 POST 数据。通常,我们会遵循所有读取请求使用 GET,写入请求使用 POST 的标准。
除了每个单独方法所需的参数外,您还需要发送 API 密钥。
如果您使用的是服务器端 API,则需要发送 secret_key
以及您的 API 密钥值。
API 版本
对于每个请求,您应该指定要使用的 API 版本。目前,默认的也是唯一可用的版本是 1.0。
资源路径
资源路径在进一步的文档中提供给您。
数据格式
YouRepo only supports one data format currently, JSON.
回应
您的请求的响应将包含几个关键内容:
- HTTP 状态码
- API 状态
code
- API 响应消息
我们以请求为例:
GET https://api.yourepo.com/1.0/package/buyers?package=com.yourepo.source.package&secret_key=YOUR_SECRET_KEY{ "code": 0, "response": { "start": 0, "limit": 25, "total": "62", "page": 1, "buyers": [ { "nickname": "member1", "status": "Completed", "profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member1" }, { "nickname": "member2", "status": "Completed", "profile_url": "https:\/\/www.yourepo.com\/forum\/profile\/member2" }, ..... ] } }