APIリファレンス概要

Web API v3

RESTfulなWeb API v3は、配信停止リストの管理, テンプレートの利用, IPアドレスの管理, および TLS強制などの機能を提供します。

メール送信

Mail Send v3

Web API v3のメール送信用エンドポイントを使用してメール送信できます。詳細についてはv3 Mail Send概要を参照してください。

Mail Send v2

また、Web API v2のMail Sendエンドポイントも利用できます。

Marketing Campaigns API

Marketing Email APIはマーケティングメールの管理一覧取得送信者情報の設定メールのスケジュール配信などの機能を提供します。

SMTP

APIというよりプロトコルです。SMTPは多くのアプリケーションでサポートされ、多くの場合最も簡単にSendGridと連携することのできる方法です。SMTPを使って連携する方法についてはこちらを参照してください。

SMTPAPI

SMTP APIは次のようなことを可能にするAPIです。

  • メールにタグ付けしてタグごとに詳細な統計データを取得する。
  • 1回のリクエストで複数のカスタマイズされたメールを送信する。
  • 1通のメール毎に設定を変更する。

SMTPAPIを利用する場合、X-SMTPAPIヘッダにJSON文字列を設定することで利用できます。Web APIを利用する場合、x-smtpapiパラメータに設定することで利用できます。 詳細についてはSMTP APIを参照してください。

メール受信

SendGridは受信したメールを本文や添付ファイルなどにパースしてWebアプリケーションにPOSTすることができます。メールを受信してアプリケーションと連携する方法の 詳細についてはInbound Parse Webhookを参照してください。次のようなアプリケーションで使われます:

  • メール経由での記事の投稿
  • メーリングリストにおけるメールの返信
  • メール経由でのユーザプロファイルの写真の更新
  • メール経由でのサポートリクエストの送信

リアルタイムイベント通知Webhook

SendGridは予め設定しておいたURLにSendGrid上で発生したイベントをリアルタイムに通知することができます。これらのイベントには、クリック、開封、配信停止、バウンス、その他多数が含まれます。これらのイベントはSendGrid側で記録しているデータよりも多くの情報を含むため、利用者がそれぞれのレポートを独自にカスタマイズすることを可能にします。ユーザ定義のパラメータをそれぞれのイベントに含めることにより、このAPIをよりいっそう強力なものにすることができます。SMTPAPIを通じて、利用者が送信するメールそれぞれにユニーク引数を埋め込むことができます。これらのパラメータはイベント通知に含まれているため、アプリケーションはイベントと利用者を関連付けることができます。詳細についてはEvent Webhookを参照してください。次のような場合に使われます。

  • 特定のキャンペーンでの迷惑メール報告とユーザの関連付け
  • ユーザが確認メールをクリックしたことをリアルタイムに把握
  • メール内の特定のリンクがクリックされたことを把握
  • ユーザが使用しているブラウザのバージョンを取得
  • 利用者が受け取る特定のMTAの応答を取得

アカウントの設定変更

Web APIを使うことでOEM向けにサブユーザの作成と管理を行うことができます。APIリファレンス概要参照

また、プロファイル設定認証情報の設定各種Appsの有効化設定などを行うことができます。

情報の取得

SendGridは統計情報、バウンス、迷惑メール報告、配信停止、その他情報を取得するためのWeb APIを提供しています。

Blocks, Bounces, Invalid Emails, Spam Reports, Unsubscribes, and Statistics各エンドポイントから情報を取得することができます。

.