APIキーとは
APIキーとは、Brevoのシステムに対してプログラムからアクセスする際の認証情報として機能する固有の文字列です。REST APIを通じた連絡先の追加・メール送信・統計取得、あるいはSMTPを使ったトランザクションメール送信など、あらゆるプログラム連携においてAPIキーが必要になります。ユーザー名とパスワードの代わりに使用され、アカウントへのアクセス権限をコントロールします。
APIキーの役割
APIキーはリクエストごとにHTTPヘッダーへ付与することで、Brevoがリクエスト元を識別・認証します。複数のキーを発行して用途ごと(開発環境・本番環境・外部サービス連携など)に使い分けることで、セキュリティリスクを分散できます。不要になったキーはいつでも無効化でき、特定の連携を切り離す際に便利です。
Brevoでの発行方法
Brevo管理画面の右上アカウントメニューから「Settings(設定)」→「Developers(開発者)」→「API Keys(APIキー)」へ進みます。「Generate a new API key(新しいAPIキーを生成)」ボタンをクリックし、用途を識別しやすい名称を付けてキーを発行します。発行直後に表示されるキー文字列は一度しか表示されないため、必ずその場で安全な場所にコピーして保存してください。
注意点
注意: APIキーはGitHubなどのコードリポジトリにコミットしてはいけません。環境変数や秘密情報管理サービス(AWS Secrets Managerなど)を使って管理してください。漏洩した場合は即座に無効化して再発行します。
ヒント: 開発・テスト用と本番用でAPIキーを分けておくと、万一の漏洩時に本番環境への影響を最小限に抑えられます。