帮我吧数据接口 - 开发向导 - 帮我吧API接口文档v1

开发向导

请在使用数据接口前，认真阅读本页内容，方便您的后续开发。为了方便您开发过程中定位问题是接口原因，还是您的自身程序问题，建议您自行下载一个Postman或Apifox。

Restful API说明

RESTful API（Representational State Transfer）是一种基于HTTP协议的API设计风格，广泛应用于Web服务开发。它使用标准的HTTP方法（如GET、POST、PUT、DELETE等）来操作资源，并通过URL定位资源。

数据请求格式

Content-Type: 指定请求体的格式，在POST与PUT操作中需要设定，例如：Content-Type: application/json

Accept: 指定客户端期望的响应格式，例如：Accept: application/json

Authorization: 用于身份验证，通常包含令牌（token），例如：Authorization: Bearer <token>

安全与验证

仅支持基于HTTPS的SSL安全请求

验证方式有Basic Auth和Oauth2两种，可根据需要选择性使用。

（1）Basic Auth方式

通过帮我吧主账号密码的形式来进行验证，具体如下：{account}:{password}，调用格式如下，其中{}中的内容需要根据实际情况进行替换：account为登陆的账号，password为密码。

curl调用示例：

（2）Oauth2方式

通过帮我吧后台API接口模块生成对应的密钥，然后调用[1.1 获取Token](1.1 获取Token)，利用生成的token去调用各个模块接口。

① 在帮我吧后台的API接口板块中生成对应token，注意使用主账号进行生成对应的key及secret。

② 用生成的密钥ID和密钥去调用token接口（获取token接口文档）。

curl调用示例：

返回的结果：

{
  "access_token": "ac30422e19e6a7771f333b98cdf7b6f34148f03f",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": null
}

③ 用生成的token调用需要的接口，验签方式选择Bearer Token。

数据格式

仅支持JSON格式

POST和PUT操作，必须在header里设置 Content-Type: application/json

分页

数据返回条数太多时，会自动分页，默认每页100条，可以在请求URL里更改per_page参数的值来自定义每页返回的条数，建议不要超过100条，因为会影响接口返回速度。

当请求的数据个数超过per_page参数值时，可设置自增的page参数继续请求下一页数据。

示例：

{
  "tickets": [ ... ],
  "count": 123,
  "next_page": "https://www.bangwo8.com/api/v1/tickets.json?page=2",
  "previous_page": null
}

返回结果说明

成功的请求，会返回200或300范围的HTTP状态码

失败的请求，会返回400范围的HTTP状态码

如果返回500范围的HTTP状态码，可能服务器发生内部错误

帮我吧数据接口 - 开发向导

开发向导#

Restful API说明#

数据请求格式#

安全与验证#

（1）Basic Auth方式#

（2）Oauth2方式#

数据格式#

分页#

返回结果说明#