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

はじめに

皆さんはAPIの挙動確認をどのように行っていますか？確認ができるツールは多数ありますが、今回はPostmanについて2回にわたってご紹介いたします。

Postmanについて

Postmanは、Web APIのアクセスに必要な設定を作成・管理できるサービスです。Webアプリケーションと各種OS向けのクライアントアプリケーションが提供されていますが、今回はより手軽なブラウザ版をご紹介します。PostmanのサイトからSign upをしてはじめましょう。

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

Postmanにアクセスしたら、まずはWorkspacesからCreate Workspaceを実行します。

Workspaceを作成した後は、Requestsの右にある＋ボタン（Create new request）からリクエスト編集画面を開いてください。

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

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

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

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

次にAuthorizationタブでTypeからBearer Tokenを選択します。Token欄にはAPIキーの値を入力してください。APIキーの発行方法についてはドキュメントを参照してください。APIキーにはMail Sendパーミッションを与えておいてください。

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

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

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

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

今回はPostmanの基本的な機能をご紹介しました。後編では少し応用的な利用方法をご紹介していますのでご覧ください。