API送信とは
API送信(API Sending)とは、Brevo REST APIが提供するエンドポイント POST /smtp/email にHTTPリクエストを送ることでメールを送信する方式です。SMTPがメール転送プロトコルを使うのに対し、API送信はWeb API経由で送信パラメーターをJSON形式で指定します。差し込み変数の柔軟な指定・トランザクションテンプレートとの連携・送信結果のレスポンス取得など、よりきめ細かい制御が可能です。
API送信の役割
SMTP方式では設定できないパラメーター(例:特定の連絡先属性の更新、添付ファイルのBase64エンコード送信、送信IPの指定、CCやBCCの詳細設定)をAPI送信では一つのリクエスト内で完結して設定できます。また、リクエストへのレスポンスで送信IDが即時取得できるため、後続処理(送信成否の記録・リトライ制御など)をアプリケーション側で細かくハンドリングするシステム要件に適しています。
Brevoでの実装
Brevo管理画面の「Transactional(トランザクション)」→「SMTP & API」→「API」タブでAPIキーを生成します。アプリケーション側では生成したAPIキーを api-key ヘッダーに付与し、エンドポイント https://api.brevo.com/v3/smtp/email にPOSTリクエストを送ります。リクエストボディにはJSON形式で送信先・件名・本文(HTMLまたはテキスト)またはテンプレートIDを指定します。Brevo公式SDKがPython・Node.js・PHP・Ruby・Javaなど主要言語向けに提供されており、これらを使うと実装工数を短縮できます。
注意点
注意: APIキーは外部に漏洩しないよう、環境変数やシークレットマネージャーで管理してください。ソースコードへのハードコードは厳禁です。
ヒント: トランザクションテンプレートIDを使って送信すると、テンプレートの更新がコードの変更なくリアルタイムに反映されるため、メール文面の修正サイクルを短縮できます。