API キーの作成・名前の変更・失効

API キーを作成する

1. プロジェクトの環境を開き、メニューの「API キー」を押します。
2. 「＋ API キーを作成」を押します。
3. 名前 (例: 本番サーバー。100 文字まで) を入力し、「作成する」を押します。名前を空欄にすると「既定」になります (英語の画面では「Default」)。
4. 表示されたキーをコピーして、サーバーの設定に保存します。
5. 「閉じる」を押します。

キーは作成したときに一度だけ表示します。あとから表示することはできません。キーはサーバーだけで使い、ブラウザやアプリには含めないでください。

• 本番環境のキーは sk_live_、テスト環境のキーは sk_test_ で始まります。ほかの環境では使えません。
• API キーを作成・変更・失効できるのは、開発者・管理者・オーナーです。

API キーの一覧

名前、キーの先頭の文字、最後の使用、作成日を表示します。30 日以上使われていないキーには「30 日使われていません」と表示します。

API キーの名前を変更する

1. 行の右の操作のメニューを押します。
2. 「名前を変更」を選び、名前を入力して保存します。

• 名前は 100 文字までです。超えると「キーの名前は100文字以内で入力してください。」と表示し、保存しません (切り詰めて保存することはありません)。作成のときも同じです。
• 名前の変更は 監査ログ に「API キーの名前の変更」(api_key.renamed) として、前の名前と新しい名前とともに残ります。

API キーを失効する

1. 行の右の操作のメニューを押します。
2. 「失効する」を選びます。
3. 確認のダイアログで「失効する」を押します。

• そのキーを使っている呼び出しは、すぐに 401 で失敗します。失効したキーは元に戻せません。
• 失効したキーは一覧に表示しません。キーの名前と先頭の文字は 監査ログ に残ります。

API キーを入れ替える

1. 新しい API キーを作成します。
2. サーバーの設定を新しいキーに変更します。
3. 古いキーの「最後の使用」が更新されなくなったことを確認します。
4. 古いキーを失効します。

API の呼び出しの回数には、キーごとに 1 分あたりの上限があります (Free は 600 回、カード登録済みは 3,000 回)。詳しくは レート制限 をご覧ください。