EOSFans API 快速开始

优质

小牛编辑

133浏览

2023-12-01

本文介绍 EOSFans API，以及用户认证的方式 (内容参考自 Ruby-China API)。

OAuth 2 / API 认证

在使用 API 之前，你需要注册应用并获得可以 OAuth App 信息。并使用标准的 OAuth 2 实现登录，获得 access_token 信息。

所有 Response 采用 JSON 格式返回，请求状态通过 HTTP Status 返回。

错误的情况 Response Body 一定会是这样的格式: { "error" : "Error message" }

200, 201 - 请求成功，或执行成功。
400 - 参数不符合 API 的要求、或者数据格式验证没有通过，请配合 Response Body 里面的 error 信息确定问题。
401 - 用户认证失败，或缺少认证信息，比如 access_token 过期，或没传，可以尝试用 refresh_token 方式获得新的 access_token。
403 - 当前用户对资源没有操作权限。
404 - 资源不存在。
500 - 服务器异常。

在部分 API 的 response 内容里面你会看到 abilities 节点，这是特别标识当前 access_token 对应的用户对此资源的权限。

请参考源代码，确定那些路径是需要用户认证的，需要用户认证的路径，你需要带上 access_token=? 参数。

例如：

{
  "topic": {
    "id": 256170,
    ....,
    "abilities": { "update": true, "destroy": true }
  }
}