Workiva APIコレクションをBruno for Windowsにインポートする

このガイドでは、OpenAPI 仕様を使用して Workiva API コレクションをBruno にインポートする手順を説明します。グローバル環境変数の設定、OAuth 2.0を使用した認証、APIリクエストのエンドツーエンドの検証方法を学びます。

背景

Workiva APIはOpenAPI (.yaml) フォーマットで公開されています。これらの仕様は、BrunoのようなAPIクライアントに直接インポートすることができ、手動でリクエストを構築することなく、完全に構造化されたコレクションを扱うことができる。

ブルーノの右上隅で、Globe アイコン をクリックし、Configure を選択する。
グローバル環境の作成 を選択する。
以下のグローバル変数を作成する：
- access_token
- 環境
- クライアントID
- クライアント・シークレット
- api_version
Environment 、ClientID 、ClientSecret の値を入力する。access_token は空白のままにし、api_version を2026-01-01 に設定する。
環境を守る。

複数のコレクションで認証を再利用するために、OAuth アクセストークンはグローバル環境変数 として保存されます。

Workiva API コレクションを選択します。
変数タブを選択します。
baseUrl 変数を更新して、ハードコードされたドメインの代わりに{{environment}} を使用するようにします。

オリジナル：
https://api.app.wdesk.com

https://api {{環境}} .wdesk.com
認可をベアラ・トークンに設定し、{{access_token}} 変数を使用する。
Scripts タブを選択します。
Pre-request セクションに以下のスクリプトを追加する。

2026 Platform API については、X-Version ヘッダーがリクエストごとに要求される。このスクリプトは、Workivaの2026 APIバージョン要件に沿って、ヘッダーがコレクション全体に一貫して適用されることを保証します。

注：この要件は現在、プラットフォームAPIにのみ適用される。
```
// X-Versionヘッダーの追加または更新 (Bruno) req.setHeader("X-Version", bru.getGlobalEnvar("api_version"))； 
```
Workiva API コレクションで、oauth2 フォルダに移動し、Retrieve a token を開きます。
Post Response スクリプト・セクションに以下を追加し、トークンをグローバルに保存します：
```
const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token)； 
```
変更を保存します。

認証されたリクエストを送信できるようになりました。成功すれば、ドキュメント・リストがレスポンスとして返されます。

Wdata Code Generation 。
.yaml ファイルをダウンロードし、Postman にインポートします ( ステップ 1: Workiva API コレクションのインポート で説明されている手順に従ってください )。注： .yaml ファイル名は、おそらくWorkiva API Collection と同じになる。
Wdataコレクション：
- 変数タブを選択します。
- baseUrl 変数を更新して、ハードコードされたドメインの代わりに{{environment}} を使用するようにします。
  
  オリジナル：
  https://h.app.wdesk.com/s/wdata/oc/api
  
  https://h. {{環境}} .wdesk.com/s/wdata/prep
- 認可をベアラ・トークンに設定し、{{access_token}} 変数を使用する。
- 認証設定とbaseUrl 変数が同じように構成されていることを確認します。

正しい環境を参照していることを確認します。コレクションがデフォルトで No 環境に設定されている場合は、ご指定の環境 に切り替えてください。
baseUrl 変数が環境とコレクション設定で一貫していることを確認してください。
を使用するようにbaseUrl{{environment}} コレクション変数を設定してください。
リクエストが401または空白のレスポンスを返した場合は、クライアントID、クライアント・シークレット、API_version、およびEnvironmentの値が正しいことを再確認してください。