关于 HTTP
「HTTP」(超文本传输协议)是一种互联网通信的通用协议。它指定了「客户端」发送给「服务器」什么样的消息,以及得到什么样的响应。
「HTTP 请求」就是从客户端发送到服务器端的请求。我们可以通过「HTTP 请求」向指定的网址发送 HTTP 请求消息,从而与外部系统进行通信。如下图所示:
250px|700px|reset
适用场景
「HTTP 请求」适用于数据时效性要求较高的场景,可以实现:在流程执行过程中,向外部系统发送请求,从而获取外部数据或触发外部操作。
例如:
- 应用 A 更新记录后,可以发送「HTTP 请求」,将更新后的记录同步至客户自研系统
- 应用 B 的流程执行过程中,需要获取存储在客户 EHR 系统中的数据,可以通过发送「HTTP 请求」读取到指定数据
配置步骤
(一)添加 「HTTP」节点
进入流程编辑器,新增节点选择「三方集成」中的「HTTP」。
250px|700px|reset
(二)执行操作
通过「HTTP」连接器可执行「HTTP 请求」操作。
250px|700px|reset
(三)连接配置
点击「新建连接配置」,配置连接信息。
250px|700px|reset
「HTTP 请求」连接器支持多种鉴权方式。
250px|700px|reset
鉴权方式 | 说明 |
飞书集成 | 选择默认飞书集成或自定义飞书集成
|
Query Auth | 服务端系统要求请求时传入的 Key 和 Value。将添加到 HTTP 请求的 Query 中一同发送 |
Header Auth | 服务端系统要求请求时传入的 Key 和 Value。将添加到 HTTP 请求的 Header 中一同发送。 |
Basic Auth | 通过 用户名 和 密码 进行认证,凭证将通过标准 Basic access 格式编码后置于发送的 HTTP 请求中名为 "Authorization" 的 Header field 内 |
(四)请求配置
配置发送 HTTP 请求的基础信息。
- 包括:请求方法、请求地址、请求头、请求参数及请求体
- 可以对照待请求的 API 文档说明来配置
250px|700px|reset
(五)高级配置
可以根据需要,设置操作执行失败时的重试策略:
250px|700px|reset
配置项 | 说明 |
重试间隔 | 每次重试之间的间隔时间,默认 5000 ms |
重试次数 | 失败后的自动重试次数,默认 0 次 |
超时时间 | 每次重试的 HTTP 请求超时时间,默认 5000ms |
(六)输出
「输出」中需要手动配置响应数据结构,在后续节点中,我们可以引用其中的具体字段。
配置方法:可直接使用 API 文档中的响应体示例,或参考文末常见问题中演示的方法配置
注意事项:定义的数据结构与实际传入的数据结构需要一致
250px|700px|reset
节点配置完成后,在流程中也会自动生成一个变量。服务端收到 HTTP 请求后,会返回响应数据。数据将会保存至「HTTP」自动生成的变量中,如图中示例:
250px|700px|reset
提示:目前仅支持 JSON 格式的响应数据。
常见问题(FAQ)
如何快速准确配置「输出」中 JSON 格式的响应数据结构
可以通过流程测试,获取到节点的实际输出结构,可以以此为 JSON 示例粘贴到格式中解析使用,操作方法可参考视频演示:
暂时无法在飞书文档外展示此内容
案例实践