PostmanAdvent Calendar 2024

Postman APIを活用して環境変数のInitial Valueを動的に更新してみた

Postman

Last updated at 2024-12-16Posted at 2024-12-16

はじめに

本記事はPostman Advent Calendar 2024の16日目の記事です。

今回は、Postman APIを活用して環境変数のInitial Valueを動的に更新する方法について紹介します。

背景

PostmanのCLIツールであるNewmanでは、環境変数を指定して実行する際に、環境変数のCurrent ValueではなくInitial Valueが参照されます。

認証にOAuth2.0を使用している場合、Current Valueに有効なアクセストークンを動的に更新し続けることで、常に認証が成功するように設定することができます。

しかし、CLIツールであるNewmanを利用する場合、環境変数のInitial Valueを参照して実行するため、Current Valueのトークンがリフレッシュできても、Initial Valueが参照されるため認証エラーになります。

Postman APIを活用することで、動的に環境変数のInitial Valueを更新し、認証エラーが発生しないようにしたいと思います。

Postman APIを活用することで動的に環境変数のInitial Valueを更新し、認証エラーが発生しないようにしたいと思います。

前提

Postmanには、OAuth2.0のアクセストークンを自動でリフレッシュする便利な機能があります。

しかし、Newmanではこの機能がサポートされていないため、Postmanのリクエストに直接アクセストークンをリフレッシュする処理を追加する必要があります。

本記事はアクセストークンを自動更新する処理を実装した後にNewmanからの実行でもアクセストークンを自動で更新する方法の記事になります。

Postman APIを活用して環境変数のInitial Valueを更新する

Postmanの公式サイトには、環境変数のInitial Valueを動的に設定する方法が紹介されています。

以下のエンドポイントを使用してリクエストを作成します。

エンドポイント.

[PUT] https://api.getpostman.com/environments/{{environmentId}}

環境変数IDは、環境変数画面の右にあるInformationボタンをクリックすると表示されます

作成したリクエストのPre-request Scriptタブで、現在のトークンの値を取得して変数に格納します。

Pre Request.

const access_token = pm.environment.get("access_token");
const refresh_token = pm.environment.get("refresh_token");

次に、リクエストボディを書いていきます。

nameには使用する環境変数の名前を入れます。
keyには更新したい値のキーを入れます。
valueにはそのキーのInitial Valueに入れたい値を入れます。
Pre-request Scriptに追加した処理によって、リクエストを送信する前にトークンの変数に有効なトークンの値がセットされます。

以下のようにリクエストボディを書いて、有効なトークンの値をInitial Valueに代入します。

リクエストボディ.

 {
     "environment": {
         "name": "使用する環境変数の名前",
         "values": [
             {
                 "key": "環境変数の中にある変数名",
                 "value": "更新したい値",
                 "enabled": true
             }, {
                 "key": "access_token",　//Current valueの値をInitial Valueに代入する
                 "value": "{{access_token}}",  //Current valueの値
                 "enabled": true
             }, {
                 "key": "refresh_token", 
                 "value": "{{refresh_token}}",
                 "enabled": true
             }
         ]
     }
 }