API 快速开始

本指南将带你从零到第一个成功请求:创建个人令牌、获取基础地址并调用 REST 端点。

第 1 步:创建个人令牌

打开个人中心的个人令牌部分,创建一个新令牌(PAT)。立即复制其值——它只显示一次,以 mbp_ 前缀开头。创建时选择满足你需求的访问范围(scopes);详见授权指南

第 2 步:基础地址与格式

所有 REST 端点均位于 /api 前缀下。路径中没有版本号。请求体和响应体均为 JSON;对于带请求体的请求,请传递 Content-Type: application/json 请求头。令牌通过 Authorization: Bearer mbp_… 请求头传递。

第 3 步:第一个请求——获取机器人列表

通过获取机器人列表来验证令牌。需要 bots:read(或 *)scope:

curl -H "Authorization: Bearer mbp_YOUR_TOKEN" https://your-domain/api/bots

响应将返回机器人的 JSON 数组。如果令牌错误或已过期,将返回 401{"error":"..."} 响应体(参见错误)。

第 4 步:第一个变更操作——创建反应

创建反应需要 reactions:write scope。将第 3 步获取的机器人 ID 填入:

curl -X POST -H "Authorization: Bearer mbp_YOUR_TOKEN" -H "Content-Type: application/json" -d '{"name":"你好","trigger":{"type":"command","value":"/start"}}' https://your-domain/api/bots/BOT_ID/reactions

成功响应将返回带有 id 的已创建反应。请求体的具体字段请查看交互式参考——它为每个端点生成 curl、JavaScript 和 Python 的现成示例。

第 5 步:继续查看参考文档

令牌可用后,在交互式参考中继续探索更方便:可看到完整端点列表、所需 scopes、请求体 Schema 以及"试一试"按钮。

下一步

  • 授权与令牌 — PAT、请求头和 scopes 详解。
  • 错误 — 错误格式与状态码。
  • 分页 — 如何翻页大型列表。