API 快速入門

本指南將帶你從零開始完成第一個成功請求:建立個人 Token、取得基礎位址,並呼叫 REST 端點。

步驟一:建立個人 Token

開啟個人後台,進入個人 Token 區塊,建立新 Token(PAT)。立即複製其值——僅顯示一次,且以 mbp_ 前綴開頭。建立時請選擇足夠完成任務的存取範圍(scopes);詳細說明請參見授權指南

步驟二:基礎位址與格式

所有 REST 端點均位於 /api 前綴下,路徑中不含版本號。請求與回應主體為 JSON;帶主體的請求請傳遞 Content-Type: application/json 標頭。Token 透過 Authorization: Bearer mbp_… 標頭傳遞。

步驟三:第一個請求——機器人列表

透過取得機器人列表來驗證 Token。需要 bots:read(或 *)範圍:

curl -H "Authorization: Bearer mbp_你的_TOKEN" https://你的網域/api/bots

回應將回傳機器人的 JSON 陣列。若 Token 無效或已過期,將回傳 401,主體為 {"error":"..."} (參見錯誤)。

步驟四:第一個變更——建立反應

建立反應需要 reactions:write 範圍。請將步驟三取得的機器人 ID 代入:

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

成功回應將回傳已建立的反應及其 id。請求主體的確切欄位請查閱互動式參考文件——它為每個端點生成 curl、JavaScript 及 Python 的現成範例。

步驟五:後續——參閱參考文件

Token 運作正常後,其餘內容可在互動式參考文件中方便地查閱:完整端點列表、所需 scopes、主體 Schema 及「Try it」按鈕。

延伸閱讀

  • 授權與 Token — PAT、標頭與 scopes 的詳細說明。
  • 錯誤 — 格式與狀態碼。
  • 分頁 — 如何翻閱大型列表。