概要

マーケティングメール機能(Legacy Newsletter)の提供は、 2017年9月30日をもって終了いたします。
後継機能となるマーケティングキャンペーンへの移行はお済みでしょうか? 移行方法についてはこちらをご確認ください。

SendGridはMarketing Email機能に対するアクセスを可能にするMarketing Email APIを提供します。Webサイト上からも利用可能です。詳細についてはこちらを参照してください。

Marketing Email APIは開発者向けにマーケティングメールや配信先リスト、送信元、スケジュール配信イベントなどの管理を可能にします。このAPIは開発チームがWebベースのMarketing Emailとの間でデータの入出力を可能にします。これによりプログラミングの経験のないメンバーでも簡単に扱うことを可能にします。

Marketing Email APIはWeb APIとよく似ていて、HTTPリクエストは同じ形式に従っています。データを管理するために様々なパラメータとともにSendGridのサイトに対してHTTPリクエストを送信します。全てのクエリの応答はJSONおよびXMLで返ります。


URLフォーマット

以下はMarketing Email APIリクエストを作成するための構文です:

https://api.sendgrid.com/api/newsletter/[action].[format]
  • [action] - 各モジュールは複数のアクションをサポートしています。add, get, deleteなどです。
  • [format] - 応答フォーマットを決定します。JSONの場合”json”、XMLの場合”xml”が利用可能です。

HTTP応答コード

  • 2XX - APIコールが成功
  • 4XX - APIコールのパラメータにエラーがあります。応答のBodyにエラーの内容が含まれます。
  • 5XX - APIコールが失敗しました。時間をおいてリトライしてください。

応答

応答の形式はXMLとJSONをサポートしています。失敗と成功時の応答を以下に示します。

失敗時

  • XML
    1
    2
    3
    4
    5
    6
    7
    8
    
    <result>
       <message>error</message>
       <errors>
          ...
          <error>... error messages ...</error>
          ...
       </errors>
    </result>
    
  • JSON
    1
    2
    3
    4
    5
    6
    
    {
      "message": "error",
      "errors": [
        "...error messages..."
      ]
    }
    

成功時


認証

APIコールには認証が必要です。APIコールの際、以下のHTTPパラメータを送信する必要があります。認証情報はSMTP認証およびWebサイトと同じです。

  • api_user - SMTPおよびWebサイトの認証設定と同じです。
  • api_key - SMTPおよびWebサイトのパスワードと同じです。

各APIの詳細については各APIの章を参照してください。