認証

Authorizationヘッダ

AuthorizationヘッダにAPI Keyを指定して要求を行うことで認証を行います。

APIキー

Web API v3はAPI Keyをサポートします。API Keyを利用することで、ユーザ名/パスワードとは異なる方法で認証することができます。APIキーはアカウントに対して追加のセキュリティレイヤーとして機能するとともに、パーミッションを割り当ててアクセス可能な範囲に制限を設けることができます。APIキーはhttps://app.sendgrid.com/settings/api_keysで作成できます。キーを使用するには、”Bearer XXX”という値の”Authorization”ヘッダを追加する必要があります。ここでXXXはAPIシークレットキーです。

ヘッダ例:

1
2

GET https://api.sendgrid.com/v3/resource HTTP/1.1
Authorization: Bearer ここにAPI Keyを入れる

1

curl -X "GET" "https://api.sendgrid.com/v3/templates" -H "Authorization: Bearer ここにAPI Keyを入れる" -H "Content-Type: application/json"

サブユーザの代理で要求を行う

on-behalf-ofヘッダを利用することで、親アカウントが特定サブユーザの代理で要求を発行できるようになります。この方法は、サブユーザの権限にスイッチすることなく、一括でサブユーザの設定を変更したり、管理したりする際に利用できます。このヘッダを利用する場合、シンプルに On-Behalf-Of: サブユーザのユーザ名 と指定するだけです。

このような形式でAPI呼び出しを行うと、サブユーザ自身がAPI呼び出しを行ったかのようにみえます。正しいサブユーザ名を指定しているか確認してください。

on-behalf-ofヘッダを使用して認証する際、親アカウントのAPIキーまたは基本認証情報を指定する必要があります。

APIキーの使用方法

1
2
3
4
5

curl -X GET \
  'https://api.sendgrid.com/v3/stats?start_date=2016-01-01&end_date=2017-01-01&aggregated_by=month' \
  -H 'authorization: Bearer API Key' \
  -H 'on-behalf-of: subuser_username' \