Postman Monitor : Collections と Flows の定期実行

今日はPostman Monitor を触っていきます。

Postman Monitor とは

Postman Monitorは、APIのテストや監視を自動化するための機能です。これを使うことで、cronのように指定したスケジュールに従ってCollectionsであらかじめ保存されているAPIコールを実行し、結果を確認することができます。処理のエラー時にメールを送信させることが可能ですので外形監視として用いることが出来ます。

さっそくやってみる

1. Collections でAPIコールの作成

では最初にいつものRequest CatcherでAPIを１個作成しCollectionsでPOSTコールを作成後保存します。

2. Monitor の起動と実行

マネージメントコンソール左ペインの下の四角いアイコンの集合体をクリックします。

モニターをオンにします。

Create new monitorをクリックします。

適当な名前を付けコレクションの選択します。

コレクションはAPIコールの集合体です。 例えばこのように１つのコレクションが2つのAPIコールを持っている場合、この２つはまとめて実行されます。１個のAPIコールのみを定期実行させたい場合、コレクションを分割してください。

実行間隔を指定します。無償版では分単位での設定が出来ず最短で1時間単位となります。

エラーの送信先メールアドレスを指定しモニターの作成をクリックします。

次に表示されるRunボタンをクリックすると定期実行が開始されます。

暫く待つと以下のように実行履歴、応答時間などが表示されます。

実行が失敗すると以下のように赤く表示されます。

そしてエラーを通知するメールが届きます。

Houstonは映画好きならわかるネタですね。

3. Flows の実行

いままでの設定手順で体験したように Monitor は複数のAPIコールを纏めて設定するCollectionsを定期実行する機能であり、Flowsは起動できません。
FlowsはPostmanクラウドにアップロードすることでWebhookとして起動できます。
CollectionsにてWebhookを起動するAPIコールを作成すれば、同じくMonitorで監視可能です。WebhookはHTTPのPOSTメソッドですので、以下のようにPOSTのAPIコールを設定すればMonitorから呼び出せます。