このガイドでは、OpenAPI 仕様を使用して Workiva API コレクションをBruno にインポートする手順を説明します。グローバル環境変数の設定、OAuth 2.0を使用した認証、APIリクエストのエンドツーエンドの検証方法を学びます。
前提条件
- www.usebruno.com からブルーノをダウンロードしてインストールする。
背景
Workiva APIはOpenAPI (.yaml) フォーマットで公開されています。これらの仕様は、BrunoのようなAPIクライアントに直接インポートすることができ、手動でリクエストを構築することなく、完全に構造化されたコレクションを扱うことができる。
ステップ 1: Workiva API コレクションのインポート
- Workiva Platform Code Generationページに移動します。
- OpenAPI
oas.yamlファイルをダウンロードする。 -
オープンブルーノ. 左上隅で + アイコンをクリックし、インポートコレクション を選択します。
-
choose file(s) "リンクをクリックし、ダウンロードした
.yamlファイルを選択します。 -
プロンプトが表示されたら、Brunoがコレクションを保存するローカルフォルダを作成または選択します（たとえば、../Documents/Bruno ）。
オプションで、フォルダーの配置を「タグ」から「パス」に変更し、インポートをクリックする。
ステップ2：グローバル環境の設定
-
BrunoのWorkspaceセクションで、Global Environments Tabをクリックし、Create Environment をクリックします。
-
グローバル環境の名前を入力し、Createをクリックします。
- 以下のグローバル変数を作成する：
access_tokenクライアントIDクライアント・シークレットapi_version
-
ClientIDおよびClientSecretの値を入力する。access_tokenは空白のままにし、api_versionを2026-01-01に設定する。 - 変数を保存する。
ステップ 3: OAuth 2.0の設定 - トークンの取得
複数のコレクションで認証を再利用するために、OAuth アクセストークンはグローバル環境変数 として保存されます。
-
Bruno のワークスペース領域からWorkiva API コレクションを選択します。
-
Bruno 画面の右上隅にある Workiva ドロップダウンをクリックし、Collection リストから適切な Environment/region を選択します。
-
Auth "タブをクリックし、ドロップダウンから "Bearer Token "を選択し、"Token "フィールドに
{{access_token}}変数を使用するように設定する。 - スクリプト タブを選択します。
-
Pre-request セクションに以下のスクリプトを追加する。
2026 Platform API については、X-Version ヘッダーがリクエストごとに要求される。このスクリプトは、Workivaの2026 APIバージョン要件に沿って、ヘッダーがコレクション全体に一貫して適用されることを保証します。ドキュメントはこちら：https://developers.workiva.com/2026-01-01/versioning.html
注： この要件は現在、プラットフォームAPIにのみ適用される。
// X-Versionヘッダーの追加または更新 (Bruno) req.setHeader("X-Version", bru.getGlobalEnvar("api_version"))；完了したら、ワークスペース領域の左下にある "Save" ボタンをクリックします。
-
Workiva API コレクションで、oauth2 > token フォルダに移動し、Retrieve a tokenをクリックして開きます。
-
Urlの下にある">>"アイコンをクリックし、"Script"タブをクリックします。
Post Response スクリプト・セクションに以下を追加し、トークンをグローバルに保存します：
const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token)； - 変更を保存します。
ステップ 3a (オプション)：追加のWorkiva APIをインポートする
追加の Workiva API をインポートするには、上記と同じ一連の手順に従ってください：
wData OpenAPIoas.yaml ファイルはからダウンロードできます。
チェーン OpenAPIoas.yaml ファイルはからダウンロードできます。
ステップ4：ベアラートークンの生成
- OAuth2リクエスト・ボディに、以下の変数を設定します（まだ設定されていない場合）：
{クライアントID}}-
{クライアント・シークレット}}-
変数を設定（またはチェック）するには、Brunoワークスペースの右上にあるWorkivaをクリックし、Globalタブをクリックして "Configure "を選択します。
必要に応じて変数を編集する。
-
- Retrieve a token リクエストを送信する。
- 成功すれば、レスポンスにベアラートークンが含まれ、グローバル変数 として自動的に保存される。
認証されたリクエストを送信できるようになりました。
重要な注意: コレクションを使用する場合は、"Auth "タブのドロップダウンリストの値を "Inherit "に切り替えてください。
成功すれば、矢印をクリックしてリクエストを送信した後、レスポンスに文書リストが返されます。
トラブルシューティング
- 正しいEnvironment を参照していることを確認してください。コレクションがデフォルトでNo環境に設定されている場合は、指定したEnvironment に切り替えてください。
- リクエストが401または空白のレスポンスを返した場合は、クライアントID、クライアント・シークレット、API_version、およびEnvironmentの値が正しいことを再確認してください。