配置 HTTP 标注操作
HTTP 标注会指导您输入有关正在连接的 HTTP Web 服务或 REST API 端点的详细信息。完成配置后,您会在流中调用该操作。HTTP 标注假设您熟悉要调用的 API。
所需的 Edition
| 适用于:Lightning Experience |
| 查看支持的版本。 |
| 所需用户权限 | |
|---|---|
| 要使用 Flow Builder 中提供的所有流类型、元素和功能(包括 Einstein 和 Agentforce for Flow)打开、编辑、创建、激活或取消激活流: | 管理流 |
| 要创建外部凭据、命名凭据和 HTTP 标注操作: | 自定义应用程序权限 |
在配置 HTTP 标注操作之前:
- 创建外部凭据和命名凭据,以便外部服务可以连接到 API。请参见验证 HTTP 标注操作的指导原则。
- 准备 JSON 格式的示例 API 响应。如果 API 文档中不存在示例,您可以使用第三方 API 平台检索响应。
- 从文档齐全的 API 开始。如果字段要求或定义等详细信息不准确或不是最新信息,调试过程可能需要一些时间。
-
打开流列表视图。
- 从“设置”中,在快速查找方框中,输入流,并选择流。
- 从自动化应用程序中,选择流选项卡。
- 从任何 Lightning 应用程序的“流”选项卡中,单击操作菜单并选择打开流。
- 打开您想要在其中使用标注的现有流,或创建流。
- 将操作元素添加到流,并单击创建 HTTP 标注。
-
配置将 Salesforce 连接到基于 HTTP 的 API 的外部服务。
- 输入外部服务的名称,例如 ConnectToMaps。该名称必须以字母开头,并且只包含字母数字字符,不包含空格。
- 作为参考,输入外部服务所连接内容的描述。
-
选择您为此外部服务创建的命名凭据。
与凭据关联的 URL 会自动填充。
- 单击下一步。
-
配置可在 Flow Builder 或 Salesforce 中使用的可调用操作。
- 对于标签,输入标注执行的操作,例如,连接到地图。
-
选择您正在调用的 API 所需的操作或方法。
一般情况下,GET 会引入外部数据。其他方法修改外部系统中的数据。具体功能取决于 API。
- 输入执行操作的 API 的描述,并包含指向 API 文档的链接,以便您在更改标注时可以引用它。
-
为请求添加 URL 端点。
基本 URL 显示外部服务的命名凭据 URL。如果您看不到整个 URL,请单击该字段。
-
输入以斜杠 (/) 开头且不包含问号 (?) 的端点的 URL 路径。
URL 路径支持的字符包括字母数字字符、下划线、斜杠和花括号。
- 如果您有路径变量,将其放在花括号中,并选择变量的数据类型。路径变量只能包含字母数字字符和下划线。
- 输入变量的描述,包括使用详细信息。
-
输入以斜杠 (/) 开头且不包含问号 (?) 的端点的 URL 路径。
-
如果您调用的 API 包含查询参数密钥,请添加它们。在流中使用此操作时,您可以输入定义密钥的值。
- 单击 + 添加密钥。
- 输入密钥值,并选择数据类型。
- 要在流中调用操作时需要值,选择必需。
- 输入查询参数密钥的描述,包括使用详细信息。
-
对于 POST、PUT、PATCH 和 DELETE,提供示例 API 请求正文。Salesforce 会从示例请求生成数据结构。
- 单击新建。
- 粘贴示例 JSON 请求。
- 单击审查,并确认 Apex 数据结构正确。
- 要进行更改,请在示例 JSON 请求中编辑文本,或从数据结构中选择数据类型。
- 单击审查。
- 单击完成。
-
提供示例 API 响应正文。Salesforce 从示例响应生成数据结构。
- 单击新建。
- 粘贴示例 JSON 响应。
- 单击审查,并确认 Apex 数据结构正确。
- 要进行更改,在示例 JSON 响应中编辑文本,或从数据结构中选择数据类型。
- 单击审查。
- 单击完成。
-
单击保存。
Flow Builder 将创建操作和外部服务。该操作在流的“操作”窗口中可用。
-
对于 POST、PUT、PATCH 和 DELETE,通过创建资源并为外部服务器的正文选择 Apex 类来设置流的正文。
- 对于正文,选择新建资源。
- 输入新资源的 API 名称。
-
输入描述变量及其使用方法的描述。
数据类型和 Apex 类已为您设置。HTTP 标注操作的 Apex 类使用此命名约定:ExternalServiceName__HTTP Callout Label_IN_body。例如,如果外部服务名为 MyCustomES,新 HTTP 标注的标签为 Get Accounts,则 Apex 类为 MyCustomES_Getx20Accounts_IN_body,其中 x20 表示标签中的空格。
- 单击完成。
- 对于正文,选择您创建的 Apex 定义的变量。
- 单击完成。
要在流中转换 Salesforce 与外部系统之间的数据,使用“转换”元素。对于 POST、PUT、PATCH 和 DELETE 方法,您可以在 HTTP 标注操作之前添加“分配”元素。在“分配”元素中,为 Apex 定义的变量中的每个字段分配值。HTTP 标注操作引用 Apex 定义的变量作为在外部服务器中创建数据的输入。
Flow Builder 会自动从推断的数据结构创建 Apex 类,以存储 Salesforce 与外部服务器之间传输的数据。使用 GET 方法的 HTTP 标注操作的 Apex 类命名约定是 ExternalServiceName__HTTP Callout Label_OUT_2XX。例如,如果外部服务名称为 MyCustomES,新 HTTP 标注的标签是 Get Accounts,则 Apex 类是 MyCustomES_Getx20Accounts_OUT_2XX。要删除 Apex 类,请删除与 Apex 类关联的外部服务。有关更多信息,请查看删除外部服务。
另请参阅:
本文章是否解决您的问题?
请与我们共享您的想法,以便我们进行改进!

