コンテンツにスキップ

API キーの管理

API キーはアプリ詳細画面(/apps/:id)の「APIキー」セクションで発行・管理します。

  1. アプリ詳細画面の「APIキー」セクション内、「新しいAPIキーを発行」フォームで「キー名」を入力します(必須項目)。
  2. スコープ」のプルダウンから用途に合ったスコープを選びます(初期値は full)。
  3. 発行」をクリックします(発行中は「発行中…」と表示されます)。

フォーム下には各スコープの簡単な説明が表示されます。

スコープダッシュボード上の説明
subscribe_onlyブラウザ埋め込み用(購読登録のみ)
notifyサーバーサイド送信用
full全操作

スコープごとに実際にアクセスできる API エンドポイントは異なります。詳しい権限マトリクスはAPI キーを参照してください。

キーは発行時に一度しか表示されない

Section titled “キーは発行時に一度しか表示されない”

キーを紛失した場合は、そのキーを削除して新しいキーを発行し直す必要があります。

発行済みの API キーは、アプリ詳細画面の一覧にキー名とスコープ(subscribe_only / notify / full)が表示されます。各キーの右側にある「削除」ボタンをクリックすると「元に戻せません。削除しますか?」という確認表示に切り替わり、「削除する」で確定、「キャンセル」で中止できます。削除すると即座に無効化され、そのキーを使っているアプリケーションは以後 INVALID_API_KEY(401)となります。