Workiva 支援中心

本指南逐步引導您使用 OpenAPI 規格將 Workiva API 集合匯入 Bruno 。您將學習如何設定全域環境變數、使用 OAuth 2.0 進行驗證，以及如何端對端驗證 API 要求。

必要條件

1. 從 www.usebruno.com 下載並安裝Bruno。

背景

Workiva API 以 OpenAPI (.yaml) 格式發布。這些規格可以直接匯入 API 用戶端 (如Bruno)，讓您得以處理完全結構化的集合，而無需手動建立要求。

第 1 步：匯入 Workiva API 集合

1. 巡覽至 Workiva 平台代碼產生 頁面。
2. 下載 OpenAPI .yaml 檔案。

3. 開啟 Bruno。按一下左上角的三點狀功能表並選取 Import Collection。

   

4. 選取 OpenAPI V3 檔案 並選擇下載的 .yaml 檔案。

   

5. 出現提示時，建立或選取一個Bruno 用來儲存集合的本機資料夾（例如： Bruno Collections）。

   

步驟 2：設定全域環境

1. 在Bruno 的右上角，按一下 地球符號圖示 ，然後選取 設定。

   

2. 選擇 建立全域環境。
3. 建立以下全域變數:
   • 存取權限
   • 環境
   • 客戶 ID
   • ClientSecret
   • api_version

4. 填入 Environment、 ClientID和 ClientSecret的值。將 access_token 留空，並將 api_version 設定為 2026-01-01。

   

5. 儲存環境。

步驟 3：設定 OAuth 2.0 – 擷取權杖

若要跨多個集合重複使用驗證，OAuth 存取權杖將儲存為 全局環境變數。

1. 選取 Workiva API 集合。
2. 選擇變數 索引標籤。

3. 更新baseUrl 變數，以使用{{environment}} 來取代硬體編碼的網域。

   原始資料：
   https://api.app.wdesk.com

   已更新：
   https://api.{{環境}}.wdesk.com

4. 將授權設定為持有權杖並使用 {{access_token}} 變數。
5. 選取 Scripts 索引標籤。

6. 新增以下指令碼至 Pre-request 區段。

   對於 2026 Platform APIs，每個要求都需要 X-Version 標頭。此指令碼可確保在集合中套用標頭的一致性，符合 Workiva 的 2026 API 版本要求。

   注意： 此要求目前僅適用於平台 API。

   // 新增或更新 X-Version 標頭 (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version"))); 

   

7. 在 Workiva API 集合中，導覽至 oauth2 資料夾，然後開啟 Retrieve a token。

8. 在 Post Response 指令碼區段中，新增以下內容以全域儲存權杖：

   const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token); 

9. 儲存您的變更。

步驟 4：產生持有者 Token

1. 在 OAuth2 要求正文中，設定：
   • {{ClientID}}
   • {{ClientSecret}}
2. 傳送 擷取權杖 要求。

3. 如果成功，回應將包括持有者 Token，並自動另存為 全局變數。

   

您現在可以傳送已驗證的要求。如果成功，您將在回應中看到傳回的文件清單。

步驟 5：匯入並配置 Wdata 和 Chains API 集合

1. 前往 Wdata 程式碼產生 頁面。
2. 下載 .yaml 檔案並將其匯入 Postman（按照 步驟 1：匯入 Workiva API 集合中概述的步驟進行操作）。注意： .yaml 檔案名稱可能與 Workiva API 集合相同。
3. 在 Wdata 集合中：
   • 選擇變數 索引標籤。

   • 更新baseUrl 變數，以使用{{environment}} 來取代硬體編碼的網域。

     原始資料：
     https://h.app.wdesk.com/s/wdata/oc/api

     已更新：
     https://h。{{環境}}.wdesk.com/s/wdata/prep

   • 將授權設定為持有權杖並使用 {{access_token}} 變數。
   • 對 Chains API Collection重複上述相同步驟，確保以相同方式配置授權設定和 baseUrl 變數。

疑難排解

• 確保您引用了正確的環境 。如果集合預設為無環境，請將它切換到您指定的環境 。
• 確認baseUrl 變數在您的環境和集合設定中是一致的。
• 請確定將baseUrl 集合變數設定為使用{{environment}} ；否則，您的請求可能會失敗。
• 如果您的要求傳回 401 或空白回應，請重新檢查您的用戶端 ID、用戶端密碼、API_version 和環境值是否正確。