ドキュメント

API キーの作成と無効化

必要な権限とプラン

閲覧
Viewer 以上
作成・無効化
Developer 以上
プラン
すべてのプラン

API キーを作成する

  1. プロジェクトと環境を選び、メニューの「API キー」を開きます。
  2. 「API キーを作成」を押します。
  3. 「名前」（例: 本番サーバー（送信用））を入力します。
  4. 「スコープ」で送信のみ・読み取りのみ・すべて・個別に選択のいずれかを選びます。
  5. 「有効期限」でなし・30 日・90 日・1 年のいずれかを選び、「作成」を押します。
  6. 表示されたキーをコピーし、安全な場所に保管します。キーはこの画面でのみ表示されます。

本番環境では sk_live_…、テスト環境では sk_test_… のキーを作成します。

スコープ

スコープ画面の表示許可される操作
messages:send送信メッセージの送信
messages:retry再送信配信の再送信
logs:read配信ログの閲覧配信ログ・顧客アカウント・エンドポイントの参照
endpoints:writeエンドポイントの管理エンドポイントの登録・変更・削除、署名シークレットの再発行
consumers:write顧客アカウントの管理顧客アカウントの登録・削除

一覧の確認と無効化

一覧では名前・キーの先頭・スコープ・最終使用・有効期限を確認できます。30 日間使用されていないキーと期限切れのキーには印を表示します。有効期限のあるキーは、失効の 7 日前に Owner と Admin へメールでお知らせします。

  1. 対象の「無効化」を押します。
  2. 確認のダイアログで「無効化」を押します。

無効化したキーを使用している API リクエストは、すぐに 401 エラーになります。無効化したキーは一覧から削除され、元に戻せません。キーごとの失敗したリクエストは「このキーの API ログ」で確認できます。