公開API

APIキーを作り、そのスコープを選ぶ

キーはそれが働くワークスペースで作り、連携に必要なスコープだけを与え、秘密として保管します。キーは一度しか表示されません。失くしたら失効させて新しく発行してください。

最終確認 2026年8月20日

手順

1. キーが触れるコードのあるワークスペースの中で作ります。キーはワークスペースをまたぎません。
2. 連携が動く範囲で最も狭いスコープを与えます。読むだけなら読み取り専用です。
3. キーはただちに自分の秘密情報の保管庫へ写します。
4. クライアントに合わせて Bearer トークンか X-Mosaqo-API-Key ヘッダーで認証します。
5. 可能ならアドレスで制限し、定期的に入れ替えます。

結果の確かめ方

/me のような識別のエンドポイントを呼びます。期待したワークスペースが返るはずで、それはキーがどこで有効かの確認にもなります。

よくある落とし穴

• リポジトリにコミットされた、あるいはチャットに貼られたキー。
• すべての連携で共有される万能のキー1本。
• 誤ったワークスペースで作られたキー。あらゆる要求に 403 を返します。