HTTP API経由のメール送信
HTTP API は、プログラムでメールを送信する方法として推奨されています。このAPIは、柔軟なJSONまたはマルチパートのペイロード (APIのバージョンによって異なります) に対応するRESTインターフェースを使用するため、ほぼすべてのシステム連携に適しています。
NTT CPaaSからメールをHTTP経由で送信するには、以下の手順に従います。各ステップは、選択するAPIのバージョンに関係なく適用されます:
- 適切な メールAPIエンドポイント のバージョンを選択します。
- ベースURLを取得します。
- Authorization(認可) を設定します。
- HTTPリクエスト (URL、ヘッダー、本文) を作成して送信します。
各ステップの詳細については、以下のビデオと該当セクションをご参照ください。
メールAPIエンドポイントの選択
NTT CPaaSでは、メール送信用に2つのAPIバージョンを提供しています:
メールAPI v3 [#email-api-v3-choose-email-api-endpoint]
- コンテンツタイプ:multipart/form-data
- 添付ファイルや詳細オプションなど、フル機能のメールを送信する必要がある場合に使用します。
詳細については、 フル機能メールの送信 用APIのエンドポイントについて詳述しているドキュメントをご参照ください。
メールAPI v4 [#email-api-v4-choose-email-api-endpoint]
- コンテンツタイプ:application/json
- JSONベースのリクエスト構造を使用する場合、またはテンプレートやより最新のペイロードを使用する場合に使用します。
詳細については、メールメッセージの送信用APIのエンドポイントについて詳述しているドキュメントをご参照ください。
ベースURLの取得
NTT CPaaSアカウントには、どのAPIリクエストでも必ず使用する必要がある一意のベースURLが含まれています。
例:
https://{base_url}/email/3/send
ベースURLを表示するには、お持ちのNTT CPaaS資格情報を使って NTT CPaaS APIリソースハブにログインします。ログインすると、すべてのページにxxxxx.api.infobip.comの形式でベースURLが表示されます。
Authorization (認可) の設定
すべてのメールAPIリクエストには、Authorizationヘッダーが必要です。NTT CPaaSでは、複数の認証方式をサポートしています。
認証情報またはトークンには、次のスコープの少なくとも1つが含まれている必要があります:
email:manageemail:message:sendmessage:send
スコープの割り当てに関するガイダンスについては、APIスコープ について詳述しているドキュメントをご参照ください。
HTTPリクエストの作成
HTTPリクエストを作成する時は、次のコンポーネントを含めるようにします:
- API URL: ベースURLを選択したエンドポイントと組み合わせます。例:
https://{base_url}/email/3/send - Authorization:選択した認証方式を使用して
Authorizationヘッダーを含めます。使用する認証情報またはトークンに必要なスコープが含まれていることを確認します。 - Content-type:使用するメールAPIのバージョンに応じてヘッダーを設定します。
- v3 →
multipart/form-data - v4 →
application/json
- v3 →
- 本文:リクエスト本文は、必須フィールドと任意フィールドで構成されます。
- 必須フィールド には通常、次のものが含まれます:
- 送信者
- 受信者
- 件名
- メールのコンテンツ
- 任意フィールド としては、以下が含まれる場合があります:
- 添付ファイル
- カスタムヘッダー
- 追跡オプション
- テンプレート
- パーソナライゼーション用のフィールド
- 追加のメタデータ
- 必須フィールド には通常、次のものが含まれます:
各エンドポイントについて詳述しているドキュメントには、以下の項目が含まれています:
- どのフィールドが必須または任意なのかが示されているパラメーターの一覧。
- 様々なユースケースに応じて変わるリクエスト本文の記述方法を示す例文 セクション。