Workiva支持中心

将 Workiva API 导入 Mac 版 Bruno

将 Workiva API 导入 Mac 版 Bruno

上次更新时间 2026年04月14日 11:32

本指南将引导您使用 OpenAPI 规范将 Workiva API 集合导入Bruno。您将学习如何配置全局环境变量、使用 OAuth 2.0 进行身份验证以及端到端验证 API 请求。

先决条件

从www.usebruno.com下载并安装 Bruno。

背景

Workiva API 以 OpenAPI (.yaml) 格式发布。这些规范可以直接导入到 Bruno 等 API 客户端中，使您能够处理完全结构化的集合，而无需手动构建请求。

步骤 1：导入 Workiva API 集合

导航至Workiva 平台代码生成页面。
下载 OpenAPIoas.yaml文件。
打开Bruno。在左上角，点击 + 图标，然后选择导入集合。
点击“选择文件”链接，然后选择下载的.yaml文件。
出现提示时，创建或选择一个本地文件夹，Bruno 将在其中存储集合（例如，../Documents/Bruno）。

（可选）将文件夹排列方式从“标签”更改为“路径”，然后单击“导入”。

步骤 2：配置全局环境

在 Bruno 的工作区部分，单击全局环境选项卡 ，然后单击创建环境。
输入全局环境的名称，然后单击创建。
创建以下全局变量：
- 访问令牌
- 客户端ID
- 客户端密钥
- api_version
填充ClientID和ClientSecret的值。将access_token留空，并将api_version设置为2026-01-01。
保存变量。

步骤 3：配置 OAuth 2.0 – 获取令牌

为了在多个集合中重用身份验证，OAuth 访问令牌将存储为全局环境变量。

从 Bruno 的工作区中选择Workiva API集合。
点击 Bruno 屏幕右上角的 Workiva 下拉菜单，然后从集合列表中选择相应的环境/区域。
点击“Auth”选项卡，从下拉菜单中选择“Bearer Token”，并将“Token”字段设置为使用{{access_token}}变量。
选择脚本选项卡。
将以下脚本添加到预请求部分。

对于2026 平台 API，每个请求都需要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文件夹，然后单击检索令牌 打开。
点击网址下方的“>>”图标，然后点击“脚本”选项卡。

在Post Response脚本部分，添加以下内容以全局保存令牌：
```
const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token); 
```
保存更改。

步骤 3a（可选）：导入其他 Workiva API

按照上述步骤顺序导入其他 Workiva API：

wData OpenAPIoas.yaml文件可从此处下载

Chains OpenAPIoas.yaml文件可从此处下载

步骤 4：生成 Bearer Token。

对于 OAuth2 请求正文，请设置以下变量（如果尚未设置）：
- {{ClientID}}
- {{ClientSecret}}
  - 要设置（或检查）变量，请点击 Bruno 工作区右上角的 Workiva，点击“全局”选项卡，然后选择“配置”。
    
    根据需要编辑变量。
发送获取令牌请求。
如果成功，响应将包含一个 Bearer 令牌，并且它将自动保存为全局变量。

您现在可以发送经过身份验证的请求。

【重要提示 】使用集合时，请将“身份验证”选项卡中的下拉列表中的值切换为“继承”。

如果成功，点击箭头发送请求后，您将在响应中看到返回的文档列表。

故障排除

请确保您引用的是正确的环境。如果集合默认为“无环境”，则将其切换为您指定的环境。
如果您的请求返回 401 或空白响应，请重新检查您的客户端 ID、客户端密钥、API_version 和环境值是否正确。