概述

起步

闲言社区 OpenAPI 将部分网站服务封装成一系列 API(Application Programming Interface,应用编程接口)开放出来,供第三方开发者使用。

闲言社区 OpenAPI 采用 RESTFul 风格设计。

所有的 OpenAPI 请求地址都是 可预期的 以及 面向资源 的,并且使用规范的 HTTP 响应代码 来标识请求结果的正确与错误信息。

所有的 OpenAPI 请求都会以规范友好的 JSON 对象格式返回(包括错误信息),并且使用「个人访问令牌」Personal Access Token 作为鉴权方法。

所有请求和响应的编码均为 UTF-8

调用说明

基础地址(Base URL)为:

https://bbs.90so.net

认证方式

OAuth2 token (sent in a header)

请求 API 时,增加 Authorization Header

Authorization: Bearer {token}

请求

所有的请求方式(Method)均与动词相关:

  • HEAD:可以针对任何资源发出以仅获取 HTTP 标头信息
  • GET:获取资源
  • POST:创建资源
  • PATCH:通过部分 JSON 数据更新资源
  • PUT:替换资源或集合
  • DELETE:删除资源

响应

错误返回格式

{
    "message": "Unable to authenticate with invalid API key and token.",
    "status_code": 401
}
错误原因 状态码 错误描述
因为无效的 API 密钥和令牌无权限请求接口 401 无法使用无效的 API 密钥和令牌进行身份验证

字段类型

在文档中,我们将使用许多不同类型的数据。您可以在下方的说明列表找到它们的解释及含义。

类型 定义 范例
integer 整数,不带小数的数字。 1234
float 浮点数,带小数的数字。 1234.12
string 字符串是用于表示文本的字符序列。 "闲言"
boolean 布尔值,是 true 或 false 中的一个,所对应的关系就是真与假的概念。 true
date 表示日期的字符串。 "2019-09-01"
datetime 表示日期和时间的字符串。 "2019-09-10 12:23:01"
list() 列表,该列表为数组,数组中的每一项的类型由括号内的字段类型决定。 ["item1", "item2", "item3"]
object() 资源,括号内的资源实体不在此处展开,可从对应的资源 XX 对象中找到。 {"id": 1,"name": "NPC小明"}

加入我们

{warning} 为了避免广告及不看文档的用户,我们目前还没有任何的官方交流群,可能以后会有,但现在还没有。

你有以下两种方式加入到我们中来:

打赏支持

我们没有收费服务,你如果觉得你从中获益,你可以 打赏 来支持我们。