API クイックスタート

このガイドでは、個人トークンの作成からベースアドレスの確認、REST エンドポイントの呼び出しまでを一から説明します。

ステップ 1. 個人トークンを作成する

個人ページの個人トークンセクションを開き、新しいトークン(PAT)を作成します。値はすぐにコピーしてください。一度だけ表示され、mbp_ プレフィックスで始まります。作成時にタスクに必要なスコープを選択してください。詳細は 認証ガイド を参照してください。

ステップ 2. ベースアドレスとフォーマット

すべての REST エンドポイントは /api プレフィックスの下にあります。パスにバージョン番号はありません。リクエストおよびレスポンスのボディは JSON です。ボディを含むリクエストには Content-Type: application/json ヘッダーを付けてください。トークンは Authorization: Bearer mbp_… ヘッダーで送信します。

ステップ 3. 最初のリクエスト — ボットのリストを取得する

トークンを確認するため、ボットのリストをリクエストしてください。bots:read(または *)スコープが必要です:

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

レスポンスとして JSON 形式のボット配列が返ります。トークンが無効または期限切れの場合、{"error":"..."} ボディとともに 401 が返ります(エラー を参照)。

ステップ 4. 最初のミューテーション — リアクションを作成する

リアクションの作成には reactions:write スコープが必要です。ステップ 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. 次は リファレンスで

トークンが動作したら、残りは インタラクティブリファレンス で確認するのが便利です。全エンドポイントのリスト、必要なスコープ、ボディスキーマ、「Try it」ボタンが揃っています。

次のステップ