本指南逐步引導您使用 OpenAPI 規格將 Workiva API 集合匯入Bruno。您將學習如何設定全域環境變數、使用 OAuth 2.0 進行驗證，以及如何端對端驗證 API 要求。
必要條件
- 從www.usebruno.com下載並安裝Bruno。
背景
Workiva API 以 OpenAPI (.yaml) 格式發布。這些規格可以直接匯入 API 用戶端 (如Bruno)，讓您得以處理完全結構化的集合，而無需手動建立要求。
第 1 步：匯入 Workiva API 集合
- 巡覽至Workiva 平台代碼產生頁面。
- 下載 OpenAPI
oas.yaml檔案。 -
開啟Bruno。按一下左上角的 + 圖示並選取Import Collection。
-
按一下「選擇檔案」連結並選擇下載的
.yaml檔案。 -
出現提示時，建立或選擇Bruno將儲存集合的本機資料夾（例如，../Documents/Bruno）。
或者，將您的資料夾排列從「標籤」變更為「路徑」，然後按一下「匯入」。
步驟 2：設定全域環境
-
在 Bruno 的 Workspace 區段中，按一下Global Environments 分頁 ，然後按一下Create Environment。
-
為您的全域環境輸入名稱，然後按一下建立。
- 建立以下全域變數:
存取權限客戶 IDClientSecretapi_version
-
填入
ClientID和ClientSecret的值。將access_token留空，並將api_version設定為2026-01-01。 - 儲存變數。
步驟 3：設定 OAuth 2.0 – 擷取權杖
若要跨多個集合重複使用驗證，OAuth 存取權杖將儲存為全局環境變數。
-
從 Bruno 的 Workspace 區域選取Workiva API集合。
-
按一下「Bruno」畫面右上角的「Workiva」下拉式清單，然後從「集合」清單中選取適當的環境/區域。
-
按一下「驗證」索引標籤，從下拉式選單中選取「持有權杖」，並設定「權杖」欄位以使用
{{access_token}}變數。 - 選取Script索引標籤。
-
新增以下指令碼至Pre-request區段。
對於2026 Platform APIs，每個要求都需要X-Version標頭。此指令碼可確保在集合中套用標頭的一致性，符合 Workiva 的 2026 API 版本要求。文件可在此處找到： https://developers.workiva.com/2026-01-01/versioning.html
注意：此要求目前僅適用於平台 API。
// 新增或更新 X-Version 標頭 (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")));完成後按一下工作區區域左下角的「儲存」按鈕。
-
在 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：產生持有者 Token
- 對於 OAuth2 請求正文，設定以下變數（如果尚未設定）：
{{ClientID}}-
{{ClientSecret}}-
若要設定（或檢查）變數，請按一下「Bruno」工作區右上角的 Workiva，再按一下「全局」索引標籤並選擇「設定」。
視需要編輯變數。
-
- 傳送擷取權杖要求。
- 如果成功，回應將包括持有者 Token，並自動另存為全局變數。
您現在可以傳送已驗證的要求。
重要注意事項: 使用集合時，請從下拉式清單中將「驗證」索引標籤中的值切換為「繼承」。
如果成功，在按一下箭頭傳送要求後，您會在回應中看到傳回的文件清單。
疑難排解
- 請確保您引用了正確的Environment。如果集合預設為其「無」環境，請將其切換為您指定的環境。
- 如果您的要求傳回 401 或空白回應，請重新檢查您的用戶端 ID、用戶端密碼、API_version 和環境值是否正確。