工作流节点 —— 发送API请求


节点功能: 可以通过API接口获取外部系统的数据,也可以向指定接口地址推送数据。

使用场景

  • 1、当一个采购申请记录通过后,将当前记录的数据推送给其他系统。

  • 2、定期从订单管理系统获取订单数据,将获取的数据新增到工作表。

image.png

支持两种数据处理方式: 推送数据和获取数据

  • 发送自定义请求: 即向第三方系统发送请求,获取数据/推送数据。支持Get、Post、Put、Delete、Head和Patch 6种方法。

  • 发送指定数据对象: 即将工作表中的记录数据推送给第三方系统。

一、发送自定义请求

1.1 Get 方式

场景示例: 课程意见公开收集时,可以获取用户IP地址,根据IP地址,从相关API服务中获取此IP的归属地,写入到对应字段中。

image.png

使用的API接口地址文档:https://www.juhe.cn/docs/api/id/1

API URL

将API接口的地址粘贴到这里,支持参数值的静态或动态拼接

如果请求时需要使用网络代理和开启SSL证书验证,勾选即可。

网络代理的配置,需要管理员在 组织后台 > 集成 > 其他中配置

Header配置

有的系统,需要授权信息或其他参数在上面的API URL的中配置拼接配置即可;

有的系统则需要将参数配置在Header中

如下接口示例:

image.png

配置方式:

image.png

Token在header中的名称叫:Authorization(即授权凭证),后面直接写入您的token值即可。

可信IP地址

有时候,一些第三方平台需要设置可信IP才能调用API,本平台工作流发送请求使用的IP是:123.59.59.220, 添加到对方白名单即可。

请求失败设置

可以设置请求失败时的状态码和错误消息。

  • 成功的状态码写在一起,英文逗号隔开即可。

  • 错误码和错误消息分开设置

错误的内容会在工作流的运行历史中显示

测试API

以上接口信息配置完毕后,就可以测试是否能正常请求了,点击【测试API】按钮。

如果请求URL中的参数使用了节点动态值,在第一次点击测试时,会让您填写参数的测试数据,您填写后可以将测试值替换动态参数后发起请求,所有字段都不是必填项,可以留空,请求时以空值请求即可,再次点击测试API时 参数保留最后一次填写值

  • [!TIP]

    • 测试支持请求时间、返回状态码、请求耗时(秒);
    • 原返回参数增加「响应 Body」命名,增加「响应 Header」,内容为 API 返回的 Header列表;
    • 如果请求方式是 HEAD,没有返回 Body 值,则不展示响应 Body ;
    • 在后续节点被使用时,动态值分为Body和Header区别展示,没有Body则不展示;

请求超时或请求失败时

请求时间超过10秒则超时,当发送超时或失败时,后续流程节点可以有两种处理方式:

  • 继续执行

    后面的节点继续执行,如果之后有节点使用本节点对象或输出的数据时,将跳过对应的项(并不一定是整个节点调整,例如更新节点更新了5个字段,其中1个字段更新时使用了此节点的值,那么只有此字段不处理,其他字段正常更新)

  • 中止流程

    到此节点结束,后续节点不再执行。

1.2 Post 方式

image.png

Body: 支持 form-data、x-www-form-urlencoded、 Raw和 binary四种方式。

  • 以binary方式发送附件时,以二级制数据输出,只能选择1个附件。

其他请求信息配置的说明,请参考Get方式中的介绍。

二、发送指定数据对象

image.png

数据对象:选择要推送的记录,即将流程中哪一条节点的记录推送出去。

APIURL:支持参数值的 静态或动态拼接。根据对方系统要求。

三、如何使用发送API请求获取的返回参数

发送自定义请求获取数据后,就可以引用这些数据

3.1 获取的返回数据是单条

则可以 新增记录,更新记录等节点中可以直接应用此API节点的值。

例如,使用【新增记录】节点,将这些数据加入表中,新记录中字段的值可以使用API节点中获取到值。

image.png

3.2 获取的返回数据是多条数组

通过API请求获得到数组数据后,需要通过【获得批量数据】将数组数据转换为流程内容可使用的多行数据(从对象数组获取批量数据的方式),然后才能处理这些数据。

如下图:第二节点 【获得批量数据】从第一个节点【触发Webhook】节点接收并处理为内部可使用的多行数据,然后第三个节点【新增记录】将多行数据【第二个节点】逐个加入到表中。

image.png

注意事项:

  • 数据将POST到设置的通知地址,通知地址需要在10秒内返回200状态以代表正常接收数据。

  • 当收不到通知地址http 200状态的响应返回时,明道会重新将数据推送到设置的通知地址。

  • 最多尝试推送10次,如若都不成功将会放弃此数据的推送。

更多API使用场景,请参考API专区文档


文档问题反馈

文档中是否有错别字、内容过期、难以理解等问题? 点此给我们反馈吧

results matching ""

    No results matching ""