想要连接到 Workiva 预置的 Premium Connectors 之外的第三方应用程序?您可以通过利用 HTTP 请求连接器命令与 REST API 进行交互来实现这一点。在本关联学习路径中,我们将更新我们的链,以在命令中使用 Bearer Token,该命令使用列表电子表格端点,为我们提供工作区中的电子表格列表。
注意: 虽然标记为 HTTP 请求,但支持(并推荐)HTTPS(安全 HTTP)。
| 主要业务用例 | 连接到第三方系统 |
| 主要学习目标 | 使用 HTTP 请求连接器学习链式连接的基础概念 |
| 先决条件 | 配置 Workiva API 授权配置 HTTP 请求连接器 CLP - HTTP 请求 生成令牌 |
| 支持模板 | CLP - HTTP 请求列表电子表格 |
步骤 1:创建工作区变量
为了在多个链和命令中使用 Workiva API 详细信息,我们将创建工作区变量来存储该信息。我们将为平台 API URL 创建一个新的工作区变量。
- 从 链式构建器中,导航至 工作区设置。
- 在 “工作区变量”下,单击加号创建新的工作区变量。
-
请使用以下信息配置变量:
- 名称: wsv-BaseURL-Platform
- 数值: 根据您所在的地区,使用相应的数值。您可以通过检查 URL 来验证地区;如果 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 字段 CA值 IAM 基本 URL https://api.ca.wdesk.com - 保存 工作区设置。
注意: 您应该可以在工作区设置中看到所有这些变量。如果不符合要求,请重新查看上述 先决条件 。
步骤 2:复制并修改链
- 导航至 Chain Builder 并找到名为 CLP | Generate a Token 的链。
- 点击右侧的垂直椭圆,然后选择 “复制”。
- 创建链副本后,点击铅笔图标即可编辑链。
- 点击右上角的 “链条设置” 。
- 重命名链: CLP | HTTP 请求列表电子表格。
- (可选)输入 描述:“此链生成一个新的 Workiva API 访问令牌。您必须在以下变量值中提供之前生成的 API 授权中的有效客户端 ID 和客户端密钥。然后它会检索工作区内所有电子表格的列表。您的工作区必须至少包含一个或多个电子表格。
- 拯救链条。
步骤 3:列出电子表格
为了检索我们的电子表格列表,该链使用了一种 GET 命令 来自 HTTP 请求连接器。
- 将 HTTP 请求 连接器中的 Get 命令添加到链画布。
- 将 Post - 获取令牌 命令连接到 Get命令。
- 双击命令进行配置。
- 重命名命令: 获取 - 电子表格列表
- 点击命令,然后点击相应的铅笔图标来编辑命令。
- 选中 “显示响应” 复选框。
- 单击 URL ,然后在“选择变量”面板中单击 “工作区” ,然后选择您在步骤 1 中创建的变量 (wsv-BaseURL-Platform)。
- 在变量后添加 /spreadsheets 。接下来,我们
将通过在 Get 表单中指定 标头来 告诉端点如何执行。 - 点击 标题 部分旁边的灰色加号(+)按钮两次,并在每个字段中填入以下值,特别注意字母大小写和“Bearer”后面的空格。
- 标题字段 1:
- 使用 加 号添加 标题 字段。
- 关键: 接受
- 值:application/json
- 标题字段 2:
- 使用 加 号添加另一个 标题 字段。
- 关键: X版本
- 值:2026-01-01
-
我们将告诉端点如何使用在 Post 表单中填充的参数来执行操作。为此,请点击表单部分旁边的绿色加号按钮 4 次,并在每个字段中填入以下值,特别注意字母大小写。
-
- 字段 1:
- 名称: client_id
- 值: <wsv-Workiva API Client ID>
在 “选择变量”面板中,单击向下箭头展开 “工作区” ,然后选择“wsv -Workiva API 客户端 ID”。
- 字段 2:
- 名称: client_secret
- 值: <wsv-Workiva API Client Secret>
在 “选择变量”面板中,单击向下箭头展开 “工作区” ,然后选择 “wsv-Workiva API 客户端密钥”。
- 字段 3:
- 名称: 授权类型
- 值: client_credentials
- 字段 4:
- 名称: 范围
- 值: 可在此处添加值,以指定此令牌应具有哪些访问权限。
- 字段 1:
- 请使用以下示例有效负载填充响应。通过这种方式,我们为命令输出提供了一种格式,使返回的每个变量都更容易使用。
{ "access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }-
(可选)输入 描述:“此命令返回电子表格列表的一页。更多信息,请参阅开发者文档: https://developers.workiva.com/2026-01-01/getspreadsheets.html
提示!要确定如何填充标头和响应字段,请查看您要连接的 API 端点的开发者文档,在本例中,我们使用的是“获取电子表格”端点。
- 保存命令。
步骤 4:测试练习
现在链式流程已完成,请测试结果。
- 发布 该链条。
- 点击 “执行” ,然后 点击“运行链”。
- 链式操作完成后,您应该会在 “输出”选项卡中看到“Get 命令的响应正文 ”电子表格列表。
要继续挑战自己并了解更多关于使用 HTTP 请求连接器连接到第三方 API 的信息,请查看下一个练习: CLP - HTTP 请求获取单个电子表格。