HTTP触发
1. 简介
1.1 功能简介
HTTP 触发是指,当指定 URL(由智能助手Pro 生成并提供)接收到来自外部系统的数据推送时,智能助手Pro 便会被触发,自动向下执行预设的业务流程。
1.2 应用场景
HTTP 触发,常用于即时回写外部信息至简道云表单,以实现业务流程的闭环。如:
- 物流状态实时更新:物流状态更新时,通过 HTTP 触发将最新物流状态回写至简道云表单;
- 发票开票状态回传:发票开具完成后,通过 HTTP 触发即时更新简道云表单中的订单开票状态;
1.3 实现机制
实质上,HTTP 触发提供了一种对外部系统的订阅机制。当外部系统中发生某一事件时,可以将事件数据通过 HTTP 请求推送到指定的 URL,而智能助手Pro 作为数据接收方,将被触发并执行相应操作。具体如下:
1)智能助手Pro 提供一个 URL,用于接收外部系统的 HTTP 请求。
2)将 URL 配置到外部系统的事件中,实现在事件发生后,自动向 URL 发送请求。
3)智能助手Pro 接收到请求后,解析出事件数据,并向下执行业务流程。
1.4 使用说明
不同配置下,智能助手Pro 接收请求的频率限制不同。具体如下:
- 智能助手Pro 为启用状态且配置了 IP 白名单:20 次/秒;
- 智能助手Pro 为启用状态但未配置 IP 白名单:1 次/秒;
- 智能助手Pro 为未启用状态:1 次/秒。
2. 操作步骤
2.1 选择触发方式
进入「应用后台 >> 智能助手」,在右上角点击「新建智能助手」,选择触发方式为「HTTP触发」。点击「确定」后,将自动进入设计页面。
2.2 配置触发地址
触发地址,是智能助手Pro 提供给外部系统的一个特定 URL,用于接收外部系统的 HTTP 请求。
点击「复制」,将获取到的触发地址 URL 配置到外部系统中即可。如下图所示:
注:
1)新建触发方式为「HTTP触发」的智能助手Pro 时,系统会为该智能助手Pro 自动生成一个 URL。且该 URL 是固定的,不会因为编辑智能助手Pro 而改变。
2)复制智能助手Pro 时,新生成的智能助手Pro 也会具有一个新的 URL。
2.3 触发配置(选做)
2.3.1 指定可触发的IP
为确保智能助手Pro 仅能被可信来源的请求触发,可以启用 IP 白名单功能。启用后,智能助手Pro 会在接收请求时,检查请求 IP 地址是否在白名单内,若不在,则不会触发。配置步骤如下:
- 勾选「指定可触发的IP」选项,启用 IP 白名单功能。
- 点击「添加IP」按钮,输入允许触发的 IP 地址或 IP 地址段。
- 设置完成后,点击「确定」保存设置。
注:
1)若未配置白名单,则默认所有 IP 均可触发智能助手Pro;
2)仅支持 IPv4 地址,或是带一个 * 号通配符的 IP 地址段;
3)输入多个 IP 地址时,需要回车换行录入,每个地址占一行,最多支持添加 50 个。
2.3.2 自定义返回内容
智能助手Pro 在接收到请求后,会返回触发结果至推送地址。支持自定义触发成功时的返回内容,并可选择 JSON 或文本格式。配置步骤如下:
- 勾选「自定义返回内容」后,点击「设置响应」;
- 选择内容格式并输入返回内容即可。
2.4 触发数据列表
触发数据列表,是智能助手Pro 在接收到请求后,从中解析出的参数列表,可以用于后续的工作流配置(即,解析出的数据支持被后续 执行节点 调用)。
点击「获取示例数据」,并在 3 分钟内向触发地址 URL 推送一条测试数据后,即可查看触发数据列表。
注:
1)点击「获取示例数据」后,智能助手Pro 会进入数据接收状态,自动获取前后 3 分钟内的最新一条数据;
2)支持解析请求中文本、数字、文本数组类型的字段。其中,解析规则如下:
- 接收到的日期会被转换为文本格式,在后续调用前,可以自行使用公式再次转换为日期;
- 数字的小数位超过 8 位时,会四舍五入保留 8 位;
- 数组内的数字、日期会被转换为文本格式。
3)解析数据时,会将 null、空字符串、空 json 均作为空值处理。
3. 错误码
智能助手Pro 在触发失败时,会返回具体的错误码(code)和错误信息(msg),对照表如下:
错误码 | 错误信息 | 说明 |
8304 | The call frequency exceeds the frequency limit | 请求超出频率限制 |
100003 | Automated global configuration does not exist | 发送请求时,智能助手Pro 已被删除 |
100105 | The trigger is not enabled | 发送请求时,智能助手Pro 为未启用状态 |
—— | Request entity too large | 请求 body 超出 2M 的限制 |
4. 注意事项
2)若配置了白名单,则智能助手Pro 仅可被当前已发布版本中的白名单 IP 触发。对于设计中的版本,即使已将某个 IP 地址添加至白名单,但在发布新版本之前,该 IP 地址仍无法触发智能助手Pro。
3)查看 执行日志 时,可在「节点执行详情 >> HTTP 触发」页面内查看触发 IP、触发数据等信息。