想要连接到 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-平台
- 值: 根据您所在的地区,使用相应的值。您可以通过检查 URL 来验证地区;如果 URL 包含
EU或APAC,请使用相应的 URL。否则,请使用美国标准值。
注: 美国地区仅包含“app”。
字段 美国价值 IAM 基本 URL https://api.app.wdesk.com/platform/v1 字段 欧盟价值 IAM 基本 URL https://api.eu.wdesk.com/platform/v1 字段 亚太地区价值 IAM 基本 URL https://api.apac.wdesk.com/platform/v1 - 保存 工作区设置。
注: 您应该在工作区设置中看到这四个变量。如果还没有,请重新查看上面提到 的 先决条件
。步骤 2:复制并修改链
- 导航至链构建器并找到名为 CLP | 生成代币的链。
- 单击右侧的垂直椭圆,然后选择 复制。
- 创建链副本后,点击铅笔图标即可编辑链。
- 点击右上角的 链设置 。
- 重命名链: CLP | HTTP 请求列表电子表格。
- (可选)输入 描述: "此链生成一个新的 Workiva API 访问令牌。您必须在以下变量值中提供之前生成的 API 授权中的有效客户端 ID 和客户端密钥。然后它会检索工作区内所有电子表格的列表。您的工作区必须至少包含一个或多个电子表格。
- 拯救链条。
步骤 3:列出电子表格
要检索我们的电子表格列表,此链使用来自 HTTP 请求连接器的 GET 命令 。
- 将 Get 命令从 HTTP 请求 连接器添加到链画布。
- 将 Post - 获取令牌 命令连接到 Get命令。
- 双击命令进行配置。
- 重命名命令: 获取 - 电子表格列表
- 点击命令,然后点击相应的铅笔图标来编辑命令。
- 选中 “显示响应 ”复选框。
- 单击 URL ,然后在“选择变量”面板中单击 工作区 ,然后选择您在步骤 1 中创建的变量(wsv-BaseURL-Platform)。
- 在变量后添加 /spreadsheets 。接下来,我们将通过在 Get 表单中指定
标头 来告诉端点如何执行。
这些标头会将 Bearer Token 传递给 API,以表明我们有权获取电子表格列表。 - 单击 标题 部分旁边的灰色加号 (+) 按钮两次,并将以下值填充到每个字段中,特别注意字母大小写和“Bearer”后面的空格。
- 标题字段 1:
- 键: 接受
- 值: application/json
- 头部字段 2:
- 键: 授权
-
值: 持有者 <Post - Retrieve a Token - Response>
代替包含 POST - 获取令牌命令的输出。- 在 “选择变量”面板中,单击 “运行时 ”向下箭头展开 “ POST - 获取令牌”。
- 点击 响应 旁边的向下箭头,展开变量选项。
- 选择 Access_token。
- 标题字段 1:
-
使用以下内容填充 内容类型 : application/json。
-
请使用以下示例有效负载填充响应。通过这种方式,我们为命令输出提供了一种格式,使返回的每个变量都更容易使用。
{ "data": [ { "created": { "dateTime": "2018-10-21T15:03:27Z" }, "name": "年终回顾", "id": "124efa2a142f472ba1ceab34ed18915f", "modified": { "dateTime": "2018-10-21T15:03:27Z" }, "template": false }, { "created": { "dateTime": "2020-02-20T15:03:27Z" }, "name": "第一季度回顾", "id": "164cfb2b132c4623a2cfaa31ef13925a", "modified": { "dateTime": "2020-03-29T13:15:27Z" }, "template": false } ], "@nextLink": "<opaque_url> } -
(可选)输入 描述: "此命令返回电子表格列表的一页。更多信息,请参阅开发者文档:https://developers.workiva.com/platform-v1/platform-getspreadsheets/
提示!要确定如何填充标头和响应字段,请查看您要连接的 API 端点的开发者文档,在本例中,我们使用的是“获取电子表格”端点
。 - 保存命令。
第四步:测试练习
现在链式流程已完成,请测试结果。
- 发布 链。
- 单击 执行 ,然后单击 运行链。
- 链式调用完成后,您应该会在 输出选项卡 - Get 命令的响应正文 中看到电子表格列表。
要继续挑战自己并了解更多关于使用 HTTP 请求连接器连接到第三方 API 的信息,请查看下一个练习: CLP - HTTP 请求获取单个电子表格。