想要连接到 Workiva 预置的 Premium Connectors 之外的第三方应用程序?您可以通过利用 HTTP 请求连接器命令 与 REST API 进行交互来实现这一点。
在本互联学习路径中,我们将创建一个通过第三方 API 进行身份验证的链,以获取持有者令牌。虽然我们将使用 Workiva API 来演示这一点,但这些原理和过程也可以应用于连接各种其他 API。
| 主要业务用例 | 连接到第三方系统 |
| 主要学习目标 | 学习基础链概念,并利用 Workiva 的 HTTP 请求连接器命令连接第三方 REST API 并进行身份验证。 |
| 次要学习目标 | 创建工作区变量 |
| 先决条件 | 配置 Workiva API 授权 配置 HTTP 请求连接器 |
| 支持模板 | CLP | 生成访问令牌 |
步骤 1:创建工作区变量
为了在多个链和命令中使用 Workiva API 详细信息,我们将创建工作区变量来存储该信息。我们将为以下数据创建三个工作区变量:API 授权客户端 ID 和客户端密钥,以及 IAM(身份和访问管理)基本 URL。
- 从 链式构建器中,导航至 工作区设置。
- 在 工作区变量中,单击加号 (+) 三次,创建三个工作区变量,并按如下方式配置它们:
- 变量 1:
- 名称: wsv-Workiva API 客户端 ID
- 值: 输入您的 API 授权的 客户端 ID。
要查找客户端 ID,请导航至 Workiva 平台中的个人资料,并在“安全”选项卡下找到 API 授权。
如需更多 API 授权方面的帮助,请按照以下说明操作。
- 变量 2:
- 名称: wsv-Workiva API 客户端密钥
- 值: 输入您的 API 授权的 客户端 ID。
要查找客户端密钥,请导航至 Workiva 平台中的个人资料,并在“安全”选项卡下找到 API 授权。
请按照以下说明查找您的客户密钥,以获取更多帮助。 -
点击锁定按钮以加密您的客户端密钥。
保护客户端密钥的安全至关重要;请将客户端密钥保存在安全的地方,以备将来需要访问时使用。
-
变量 3:
- 名称: wsv-BaseURL-IAM
- 值: 请根据您所在的地区在下方输入值。您可以通过检查网址来验证地区。如果 URL 中包含
EU或APAC,请使用相应的 URL。
注: 美国地区仅包含“app”。
字段 美国价值 IAM 基本 URL https://api.app.wdesk.com 字段 欧盟价值 IAM 基本 URL https://api.eu.wdesk.com 字段 亚太地区价值 IAM 基本 URL https://api.apac.wdesk.com - 保存工作区设置。
- 变量 1:
步骤 2:创建链
为了生成 Bearer Token,我们将创建一个带有 POST 命令的新链;这将给我们所需的 Bearer Token。
- 导航至链构建器中的 链选项卡 。
- 创建一个新的链,并将链命名为: CLP | 生成访问令牌。
- 包含 描述: 此链生成一个新的 Workiva API 访问令牌。您必须在以下变量值中提供之前生成的 API 授权中的有效客户端 ID 和客户端密钥。
- 保存 链条。
步骤 3:获取令牌
此链使用来自 HTTP 请求连接器的 POST 命令来检索我们的 Bearer Token。Bearer Token 是访问 API 所需的重要身份验证凭证。一旦在链中获得该令牌,即可在后续命令中使用该令牌来提供与 API 交互的授权。
- 从 HTTP 请求 连接器向起始区域添加 Post 命令。
- 双击该命令进行配置。
- 重命名命令: POST - 获取令牌。
- 选中 “显示响应 ”复选框。
- 在 URL 字段中填写您需要访问的端点的 URL。要检索 Workiva API 的令牌,请使用以下内容填充 URL,并使用 Workspace 变量填充 IAM 基本 URL。
- 单击 URL ,然后在“选择变量”面板中单击 工作区 ,然后选择您在步骤 1 中创建的变量 (wsv-BaseURL-IAM)。
- 在变量后添加 /oauth2/token 。
- 在 内容类型 字段中,输入: application/x-www-form-urlencoded。
- 使用方括号 加号 添加 标题 字段。
- 键: 接受
- 值: application/json
- 使用 加号 添加另一个 标题 字段。
- 图例: X 版本
- 值: 2026-01-01
我们将告诉端点如何使用填充到 Post 表单中的参数来执行。为此,请点击表单部分旁边的绿色加号按钮 4 次,并在每个字段中填入以下值,特别注意字母大小写。
- 字段 1:
- 名称: 客户端 ID
- 价值: <wsv-Workiva API Client ID>在 “选择变量”面板中,单击向下箭头展开 “工作区 ”,然后选择
“ wsv -Workiva API 客户端 ID” 。
- 字段 2:
- 名称: 客户端密钥
- 价值: <wsv-Workiva API Client Secret>在 “选择变量”面板中,单击向下箭头展开 “工作区 ”,然后选择
“ wsv -Workiva API 客户端密钥” 。
- 字段 3:
- 名称: 授权类型
- 值: client_credentials
- 字段 4:
- 名称: 范围
- 值: (可选)在此处添加值,以指定此令牌应具有哪些权限范围。
-
将下面的示例有效负载填充到 响应 中,这样,我们就为命令输出提供了一种格式,使返回的每个变量更容易使用。
{ "access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }
- (可选)输入 描述: "此 HTTP 命令执行 POST 调用以生成后续 HTTP 命令使用 Workiva IAM API 进行身份验证所需的访问令牌。此命令利用工作区变量来存储 Workiva IAM API 的基本 URL 以及 API 授权客户端 ID 和客户端密钥。更多信息请访问:https://developers.workiva.com/2026-01-01/tokenrequest.html”。
- 保存 命令。
提示!要确定如何填充表单和响应字段,请查看您要连接的 API 端点的开发者文档。对于 Workiva API,您 可以在
这里找到 Bearer Token 文档。第四步:测试练习
现在链式流程已完成,请测试结果。
- 发布 链。
- 单击 执行 ,然后单击 运行链。
-
链运行完成后,您应该会在 输出选项卡 - Post 命令的响应正文 中看到已生成访问令牌。
查看 HTTP 请求连接学习路径中的下一个练习 ,学习如何在后续的命令列表电子表格中使用 Bearer Token。