Postmanを使ってWeb APIにアクセスする その1

はじめに

SendGridサポートチーム佐藤(@awwa500)です。皆さんはAPIの挙動確認をどのように行っているでしょうか?私もさまざまなツールを使ってAPIにアクセスしていますが、その中から特に利用頻度の高いPostmanについて2記事にわたってご紹介いたします。

Postmanについて

PostmanはWeb API開発のためのツール兼サービスです。各種OS向けのクライアントアプリケーションが提供されており、これらをインストールすることでWeb APIのアクセスに必要な設定を作成・管理できるようになります。Postmanのサイトからインストーラをダウンロードしてインストールを行ってください。

Postman

SendGridのWeb API経由でメール送信する

Postmanをインストールしたら、まずはWeb API経由でメール送信を試してみます。SendGridのAPIリファレンスを確認しつつ必要なパラメータをPostmanの画面に入力していきます。

はじめにエンドポイントの設定を行います。APIリファレンスのRequestと同じ内容になるよう、Postmanの画面で「POST」を選択し、URLに「https://api.sendgrid.com/v3/mail/send」と入力します。

Postmanの設定1

次に、BodyタブでrawおよびJSON(application/json)を選択して、APIリファレンスに記載されているRequest Bodyの内容をコピー&ペーストします。

Postmanの設定2

ペーストしたBodyのうち、”to”と”from”はそれぞれ宛先アドレス、送信元アドレスを意味するので、実際の値に書き換えます。

Postmanの設定3

次にHeadersタブAuthenticationヘッダを追加し、Valueに「Bearer APIキーの値」を入力します。「Bearer」と「APIキーの値」の間は半角スペースで区切ります。APIキーの発行方法についてはドキュメントを参照してください。APIキーにはMail Sendパーミッションを与えておいてください。

Postmanの設定4

ここまで入力したらSendボタンを選択してリクエストを発行します。Statusに「202 Accepted」と表示されていればリクエスト成功です。しばらく待つと指定した宛先にメールが届くはずです。

Postmanの設定5

最後に作成した設定を保存しておけば、設定をコピーしてリクエストパラメータを修正するなどして再利用できます。

Postmanの設定6

サンプルコードを出力する

Postmanに登録したリクエスト内容はさまざまな形式で出力することができます。画面右上のCodeを選択すると、各種プログラミング言語の他、cURLやシェルスクリプトなどの形式で出力ができます。

サンプルコードを出力
サンプルコードを出力

以上、今回はPostmanの基本的な機能をご紹介しました。次回は少し応用的な利用方法をご紹介したいと思います。