カスタムAPIコール

このピースでできること

  • SendGrid APIに対して、任意のHTTPリクエストを送信します。
  • テンプレート一覧の取得など、標準アクションにない操作も実行できます。
 

SendGrid の接続方法

接続方式を2種類から選択できます。
  • API Key — API キーのみで接続(US リージョン固定)
  • API Key + Data Residency — API キーとデータレジデンシー(US / EU)を指定して接続
EU リージョンをご利用の場合は 「API Key + Data Residency」 を選択し、EU を指定してください。

API キーの取得手順

  1. SendGrid にログインします
  1. 左メニューの Settings → API Keys を開きます
  1. 「Create API Key」 をクリックします
  1. キー名を入力し、権限を選択します(通常は Full Access または必要なスコープのみ)
  1. 「Create & View」 をクリックし、表示された API キーをコピーします
  1. 接続画面の 「API Key」 欄に貼り付けます
API キーは作成時にのみ表示されます。必ずコピーして保管してください。
 

ピースの設定項目

1. Method(必須)

  • 送信するHTTPメソッドを指定します。
  • 実行したいAPIの仕様に合わせて選択してください。

2. URL(必須)

  • SendGridのベースURL()からの相対パスを指定します。
  • 先頭は から始めてください。

3. Headers(任意)

  • 追加で付与したいHTTPヘッダーをJSON形式で指定します。
  • 通常は を指定することが多いです。

4. Query Params(任意)

  • クエリパラメータをJSON形式で指定します。
  • 値は文字列で指定してください。

5. Body(任意)

  • POST / PUT / PATCH などで必要なリクエストボディをJSON形式で指定します。
  • GETの場合は通常不要です。