Managing API Keys
API keys are issued and managed in the “APIキー (API Keys)” section of the app detail screen (/apps/:id).
Issuing a key
Section titled “Issuing a key”- In the “APIキー (API Keys)” section of the app detail screen, enter a “キー名 (Key name)” in the “新しいAPIキーを発行 (Issue a new API key)” form (required field).
- Select the scope that matches your use case from the “スコープ (Scope)” dropdown (the default is
full). - Click “発行 (Issue)” (while issuing, “発行中… (Issuing…)” is displayed).
A short description of each scope is shown below the form.
| Scope | Description shown in the dashboard |
|---|---|
subscribe_only | For browser embedding (subscription registration only) |
notify | For server-side sending |
full | All operations |
The API endpoints that each scope can actually access differ. For the detailed permission matrix, see API Keys.
A key is displayed only once, at issue time
Section titled “A key is displayed only once, at issue time”If you lose a key, you must delete that key and issue a new one.
Revoking (deleting) a key
Section titled “Revoking (deleting) a key”Issued API keys appear in the list on the app detail screen, showing the key name and scope (subscribe_only / notify / full). Clicking the “削除 (Delete)” button on the right side of each key switches to a confirmation prompt “元に戻せません。削除しますか？ (This cannot be undone. Delete?)”; confirm with “削除する (Delete)” or cancel with “キャンセル (Cancel)”. Once deleted, the key is invalidated immediately, and any application using that key will thereafter receive INVALID_API_KEY (401).