API Keys

目次

APIキーとは

APIキーは、アプリケーション、メールクライアント、WebサイトなどからSendGridへアクセスする際の認証に使います。ユーザ名やパスワードを変更することなしに、いつでも削除できます。そのため、可能な場合はAPIキーを使ってアクセスすることを推奨しています。

APIキーには以下の3種類があります。

  1. Full Access - すべてのAPIへのアクセス権限が付与されます。
  2. Restricted Access - アクセス権限をカスタマイズすることができます。
  3. Billing Access - Billing APIのエンドポイントにアクセスすることができます。※弊社(構造計画研究所)からお申込みいただいた場合、「Billing Access」は選択できません。

APIキーの権限についての詳細は、API Keys permissionsを参照してください。

API keysでは、各APIキーの以下の項目がリスト表示されます。

Name - APIキーのラベル名。

API Key ID - APIキーのID。API経由で、APIキーの編集や削除をする際に使います。

Action - APIキーの設定を編集したり、削除することができます。

アカウント1つあたりに設定できるAPIキーは100個までです。

APIキーの作成

APIキーの作成方法は以下の通りです。

  1. SendGridダッシュボードの「API Keys」のページでCreate API Keyを選択します。
  2. APIキーのラベル名を入力します。
  3. Full AccessまたはRestricted Accessの権限を選択します。※弊社(構造計画研究所)からお申込みいただいた場合 、「Billing Access」は選択できません。
  4. Restricted Accessを選択した場合は、各カテゴリのパーミッションを選択します。詳しくはAPIキーの権限を参照してください。
  5. Create & Viewを選択します。
  6. 安全な場所にAPIキーを保存します。セキュリティの観点から、APIキーをソースコードに直接埋め込んだり、GitHubのようなオープンな場所にコミットしたりしないでください。

APIキーは一度しか表示されません。再確認することはできないため、安全な場所に保存してください。

アカウント1つあたりに設定できるAPIキーは100個までです。

APIキーの権限

APIキーを作成する際に、各APIに対する権限をどの程度与えるか選択します。これによりAPIキーのアクセス範囲を制限できます。

具体的には、次のアクセスレベルから選択可能です。

  • No Access 対象APIのエンドポイントにはアクセスできません。
  • Read Access 対象APIのエンドポイントには、HTTP動詞「GET」によってのみアクセスできます。
  • Full Access 対象APIのエンドポイントには、利用可能な全てのHTTP動詞によってアクセスできます。

作成者よりも強い権限を持ったAPIキーを作成することはできません。

古いAPIキーから新しいAPIキーへの差し替え

  1. 新しいAPIキーを作成します。
  2. 古いAPIキーを利用しているソースコードを新しいAPIキーに差し替えます。
  3. 古いAPIキーをリストから選択し、メニューから「Delete API Key」をクリックします。

APIキーの検証

新しく作成したAPIキーは、以下のcURLコマンドで簡単に検証することができます。

1
2
3
4
5
curl -i --request POST \
  --url https://api.sendgrid.com/v3/mail/send \
  --header 'Authorization: Bearer YOUR_API_KEY_HERE' \
  --header 'Content-Type: application/json' \
  --data '{"personalizations": [{"to": [{"email": "recipient@example.com"}]}],"from": {"email": "sender@example.com"},"subject": "Hello, World!","content": [{"type": "text/plain", "value": "Howdy!"}]}'

HTTPレスポンスヘッダを参照し、ステータスコード202が返ってくることを確認します。

APIキーの編集

APIキーを編集をするためには、同じ列の歯車アイコンをクリックして「Edit Details」を選択します。ラベル名と各APIに対する権限を編集できます。

APIキーの削除

APIキーを削除すると、以降はそのAPIキーを使ってサービスにアクセスできなくなります。

APIキーを削除するためには、同じ列の歯車アイコンをクリックして「Delete」を選択します。削除されたAPIキーを使った場合は、アクセスが拒否されます。