SendGrid Web API【入門】

はじめに

SendGridは多数のAPIを提供しています。APIを利用することで、SendGridをアプリケーションの一機能として組み込むことを可能にします。
今回はSendGridが提供するAPIのうち、最もよく利用されるAPIの一つであるWeb APIについてご紹介します。

Web APIでできること

Web APIは大きく分けて5つのカテゴリ、13の機能から構成されています。

  • メール送信
    • Mail
  • リスト管理
    • バウンスリスト管理(Bounces)
    • ブロックリスト管理(Blocks)
    • 迷惑メール報告リスト管理(Spam Reports)
    • 無効メールリスト管理(Invalid Emails)
    • 配信停止リスト管理(Unsubscribes)
  • アプリケーション設定
    • アプリケーション設定全般(Filter Commands)
    • 各アプリケーション設定(Filter Settings)
  • 基本設定
    • クレデンシャル管理(Multiple Credentials)
    • Parse Webhook設定(Parse Webhook Settings)
    • プロファイル設定管理(Profile)
  • 統計情報取得
    • 一般的統計情報取得(General Statistics)
    • 詳細統計情報取得(Advanced Statistics)

インターフェイスの概要

これらはXMLまたはJSONをサポートしたRESTに近いAPIです。基本的に情報の取得系処理にGET、更新系処理にPOSTを利用します。各APIコール時に認証情報を付加することで認証を行います。認証に使えるのは、SendGridアカウントの認証情報の他、サブユーザ(Silverプラン以上で利用可)、クレデンシャル管理機能で作成した認証情報です。
インターフェイスの詳細については、APIマニュアル(会員登録が必要)をご覧ください。

APIを試してみる

各APIのリクエストとレスポンスの内容を確認するために便利なツールが提供されています。Mailを例にとってAPIを試してみましょう。

SendGrid APIリファレンス(英語)を開きます。
APIリファレンス

Settingsをクリックして認証情報とレスポンスフォーマット(JSON/XML)を指定してSaveをクリックします。
Settings画面

Try Itをクリックして開始します。
Try It をクリック

Mailでは、to、subject、from、text(またはhtml)の指定が必須です。それぞれ入力したら、パラメータ一覧下のMake Requestをクリックしてリクエストを送信します。
各パラメータに値を入力

Make Request をクリック

リクエストの送信結果が表示されます。
送信結果の確認

問題がある場合、レスポンスに問題の原因を特定するための情報が含まれています。
送信時にエラーがあった場合

このように各APIの動作を簡単に確認することができます。

APIライブラリの利用

SendGridのAPIを各プログラム言語から使用する場合、直接HTTPのリクエストを送信することもできますが、各言語向けのライブラリを使うことでより簡単にAPIを利用することができます。APIライブラリは公式およびコミュニティベースのものが多数公開されています。詳しくは「APIライブラリのご紹介」をご覧ください。
公式ライブラリについては、各言語ごとにサンプルを交えながら使用方法を解説したチュートリアルシリーズ記事もご覧ください。