APIキーを管理する

SendGridでは、各機能を利用する際の認証情報としてAPIキーを利用します。

APIキーには、次のような特徴があります。

  • メール送信およびAPIアクセスにのみ利用できる
  • Webポータルのログインには利用できない
  • パーミッションを設定して機能単位でアクセス制限をかけることができる

こういった特徴を利用して、アプリケーション別、オペレータ別、サーバ別など、目的別に認証情報を管理することができます。万が一APIキーが漏洩した場合でも、個別に削除することで被害を最小限に抑える、といった柔軟な運用ができます。

APIキーの発行

はじめに、Webポータルのメニューから「Settings > API Keys」を選択して、画面右上の「Create API Key」を選択します。

次に、管理用の名前(用途を示すわかりやすいものをお勧めします)を入力し、パーミッション毎にアクセスレベルを選択します。アクセスレベルには次の3種類があります。パーミッションリストについてはこちらを参照してください。

アクセスレベル説明
Full Access対象APIの全てのエンドポイントへのアクセスが可能
Restricted Access対象APIのアクセスレベルをカスタマイズ可能
Billing Access弊社経由で契約のアカウントでは選択不可

Create & View」ボタンを選択すると、APIキーが発行され、画面に表示されます。このAPIキーは1度しか表示されず、再確認することはできないため、適切な場所に保存する必要があります。 表示されたAPIキーをクリックするとクリップボードにコピーされます。コピー後は「Done」ボタンを選択して一覧画面に戻ります。

APIキーの削除

APIキーを削除するには、APIキー一覧で右側の歯車ボタンから「Delete API Key」を選択します。

確認画面が表示されるので、本当に削除して良ければ「Confirm」ボタンを選択します。

APIキーの利用

APIキーが利用できるのは、SMTP、Web API v2Web API v3です。APIキーを利用したメール送信方法については「トランザクションメールを送信する」を参照してください。