HTTP API経由でメールを送信する
HTTP API は、プログラムで電子メールを送信するために推奨される方法です。柔軟な JSON またはマルチパート ペイロード (API バージョンに応じて) を備えた REST インターフェイスを提供するため、ほとんどの統合に適しています。
NTT CPaaS over HTTPを使用してメールを送信するには、以下の手順に従ってください。各ステップは、選択した API バージョンに関係なく適用されます。
- 適切な メール API エンドポイント バージョンを選択します。
- ベース URL を取得します。
- 承認を設定します。
- HTTP リクエスト (URL、ヘッダー、本文) をビルドして送信します。
各ステップの詳細については、以下のセクションを参照してください。
メール API エンドポイントを選択する
NTT CPaaSは、メール送信用のAPIを2つ提供しています。
メール API v3
- コンテンツタイプ:multipart/form-data
- 添付ファイルや詳細オプションなど、フル機能のメールを送信する必要がある場合に使用します。
詳細については、「 フル機能の電子メール API エンドポイントの送信 (opens in a new tab) 」を参照してください。
メール API v4
- コンテンツタイプ: application/json
- JSON ベースの要求構造を使用する場合、またはテンプレートやより最新のペイロードを使用する場合に使用します。
詳細については、「 電子メール メッセージの送信 (opens in a new tab) API エンドポイント」を参照してください。
ベース URL を取得する
NTT CPaaS アカウントには、すべての API リクエストで使用する必要がある一意のベース URL が含まれています。
例:
https://{base_url}/email/3/send
ベース URL を表示するには、NTT CPaaS 資格情報を使用して NTT CPaaS API リソース (opens in a new tab) ハブにログインします。ログインすると、すべてのページにxxxxx.api.infobip.comの形式でベースURLが表示されます。
ベース URL の詳細については、製品ドキュメント および API ドキュメント (opens in a new tab)をご覧ください。
承認を設定する
すべてのメール API リクエストには、認証ヘッダーが必要です。NTT CPaaSは、複数の認証方法に対応しています。
資格情報またはトークンには、次のスコープの少なくとも 1 つが含まれている必要があります。
- 'メール:管理'
- 'メール:メッセージ:送信'
- 'メッセージ:送信'
API 認証 の詳細については、製品ドキュメント および API ドキュメント (opens in a new tab)をご覧ください。
スコープの割り当てに関するガイダンスについては、API スコープ を参照してください。
HTTP 要求を作成する
HTTP リクエストを作成するときは、次のコンポーネントを含めます。
- API URL: ベース URL を選択したエンドポイントと組み合わせます。例:
https://{base_url}/email/3/send - 権限付与: 選択した認証方法を使用して「権限付与」ヘッダーを含めます。使用する資格情報またはトークンに必要なスコープが含まれていることを確認します。
- コンテンツタイプ: 使用しているメール API バージョンに応じてヘッダーを設定します。
- v3 →
multipart/form-data - v4 →
application/json
- v3 →
- 本文: 要求本文は、必須フィールドとオプションフィールドで構成されます。
- 必須フィールドには通常、次のものが含まれます。
- 差し出し人
- 受賞者
- 件名
- メールの内容
- オプションのフィールドには、次のものが含まれます。
- 添付 ファイル
- カスタムヘッダー
- トラッキングオプション
- テンプレート
- パーソナライゼーション フィールド
- 追加のメタデータ
- 必須フィールドには通常、次のものが含まれます。
各エンドポイントのドキュメントには、次のものが含まれます。
- 必須フィールドとオプションフィールドを示すパラメーターリスト。
- さまざまなユースケースのリクエスト本文を構築する方法を示す例セクション。