SendGridのPostman Collectionsを使ってWeb API v3にアクセスする方法
この記事は SendGrid v3 API + Postman の抄訳です。
ビジネスに関連するメールには、注文確認やパスワードリセットなどのトランザクションメールから、販売促進のためのニュースレターや新しい製品・サービスを紹介するためのマーケティングメールまで、様々な種類があります。こうしたメールを送るために、開発者は多くのアプリケーションやライブラリ、開発手法を使って、システムへSendGridを組み込みます。
開発を進める中でメール送信処理に問題があった場合、ソースコード、送信リクエスト、APIの呼び出し方法のどこに原因があるのか判断するため、プログラムの動作確認やAPI呼び出しを何度も繰り返さなければなりません。もし、APIを簡単にすばやく呼び出せるツールがあれば、大幅な時間短縮が可能になるでしょう。
Postmanは広く使われているAPIツールで、500万人の開発者と10万以上の企業がこのツールを使って毎月1億3000万種類ものAPIを呼び出しています。Postmanは誰でも簡単に開発ができるように、APIのリクエストに関するデザインやテスト、デバッグの機能を提供しています。
Postmanをまだ使っていない方は、ご利用のOS(Mac, Windows, Linux)にあわせて、ここからダウンロードしてください。インストールが完了したら、次のボタンをクリックしてSendGrid v3 APIのPostman Collectionsをダウンロードしてください。
ダウンロードが完了したら、Postmanの画面左側にあるCollectionsタブの下にSendGrid v3 API Documentationフォルダが作成されていることを確認してください。
APIキーの作成
SendGridのAPIキーをまだ作成していない場合は、SendGridへログインしてダッシュボード左側のSettingsメニューからAPI Keysを選択してください。
Postmanの設定
Postmanの画面左側に表示されているCollectionsタブから呼び出したいWeb APIのエンドポイントを選択してください。
APIを呼び出す前に、ヘッダを2つ設定する必要があります。Authorizationヘッダの設定は必須で、SendGridのAPIキーを定義します。On-behalf-ofヘッダの設定は任意で、サブユーザ機能を利用している場合に、親アカウントのAPIキーを使ってサブユーザの情報を取得したいときに設定します。
AuthorizationヘッダにAPIキーを設定する
‘KEY’ = Authorization
‘VALUE’ = Bearer [APIキーをここに入れる]
On-behalf-ofヘッダを設定しサブユーザの情報を取得する
‘KEY’ = on-behalf-of
‘VALUE’ = [サブユーザ名をここに入れる]
エンドポイントのパラメータ
いくつかのエンドポイントでは、limitsやoffsets、start_dateやend_dateなどのパラメータが設定可能です。設定はエンドポイントのURLの下にあるParamsで行います。
下の画面はGlobal Statsのエンドポイントでstart_dateとend_dateのパラメータを送信リクエストに設定しています。また、Authorizationヘッダとon-behalf-ofヘッダを利用して、親アカウントのAPIキーでサブユーザのStatsを取得しています。
おわりに
SendGridでは、仕事や生活には余裕をもち、効率的であるべきだと考えています。今回ご紹介したPostman Collectionsは、SendGridのWeb APIを使ったシステム開発にきっと役立つはずです。APIの問題解決に費やす時間を短縮し、ビジネスの成長にメールをどう活用できるか集中して考えられるようになると信じています。
