API 配置中的 body 请求内容支持使用 Content-Type 为 form-data 和 x-www-form-urlencoded 请求格式,可以添加多行,每行选择一个字段,使用字段名作为键名、使用字段值作为键值,详情参见本文第四章
支持自签名证书,详情参见本文第三章
支持控制 API 调用频率,详情参见本文第三章
支持 PATCH 请求方法,详情参见本文第三章
当 API 输出遍历多行数据流循环调用时,将每一次调用的响应体都添加到输出参数的数组中
用户需要将多应用系统的数据通过 FDL 打通,实现业务系统间的数据交互(交互的形式为 API)。
比如系统中数据取出并分析后,希望直接把分析结果数据推送到业务系统中(以 API 的形式),形成业务系统里面需要直接处理的业务数据,打通分析到业务的流程。
或者希望实现简道云数据下云后将数据推送至指定 API 接口。
FineDataLink 支持 API 输出,通过 API 写入满足应用集成场景。
具体效果:可到 活动日程信息更新至企业微信日程 中查看。
API输出支持 POST、PUT、PATCH、DELETE 请求方式。
注:GET 方法不需要前置输入字段,如果需要可以使用输入算子去实现。
示例接口:新增或更新表单实例 接口
若想将数据输出到 API 接口中,需要先了解调用这个接口需要的内容。
调用接口前,需要准备调用该接口的内容,例如 Header 参数、body 内容;一般情况下,需要将待写入的数据生成参数,使用「JSON生成」算子处理成接口需要的 body 格式。
写入 API 接口界面如下图所示:
区别于 PUT 的更新资源,PATCH 方法用来更新局部资源,例如有一个 UserInfo ,里面有userId, userName, userGender等10个字段。因为需求,在某个特别的页面里只能修改 userName ,这时候的更新可以使用 PATCH 只传一个 userName 到指定资源去,表示该请求是一个局部更新,后端仅更新接收到的字段。
Headers 请求头中的Content-Type
支持 application/x-www-form-urlencoded、application/json、application/xml、multipart/form-data、text/xml、text/plain 请求格式;
允许用户在 Headers 内对 Content-Type 进行自定义设置,即 Content-Type 的下拉框支持输入非下拉列表值;
Body与Content-Type双向联动
如果输入的 Content-Type 不在联动列表内,则 Body 内格式较改变 Content-Type 前不发生变化;
如果用户输入不在列表内的 Content-Type 后,再修改Body的格式,则自动覆盖Headers内的Content-Type为联动值;
若用户有自签名证书,可开启自签名证书。并手动上传证书并输入密码。
若用户需要绕过证书验证,可以查看下文「其他说明」关闭 SSL 证书验证。
API输出执行状态与 HTTP 响应状态绑定:
运行时和预览时只有当响应状态码为2xx时,执行成功,否则报错,错误信息内包含具体的状态码和响应body信息,具体见本文第六节。
「返回响应值至参数」选项为复选框,默认不勾选,勾选后用户可以设定参数名与默认值,其中默认值为用户自行从API接口文档内复制粘贴的多行文本。
控制频率:秒/分钟/小时/天
例如控制调用频率为 1 分钟一次,则任务执行后可以看到日志,API 一分钟调用一次,如下图所示:
API输出支持关闭SSL证书验证:
支持用户在Headers内新增一个参数、参数名为SSL-certificate-verification,当客户配置此参数时:
当SSL-certificate-verification值为false时,FDL在调用API不进行证书有效性验证(当然仅当目标端的API配置了https时,才需要进行证书有效性验证)
注:在实际传给服务端的API的Headers内去除此参数,此参数仅应用于FDL内部;
任务构建失败
异常节点:【数据转换】
[API输出]: 源字段为空
[API输出]:未接入前置节点
[API输出]:JSON格式非法
[API输出]:XML格式非法
[数据转换] - 执行失败
[API输出]:API连接超时 - (后端报错信息)
[API输出]:API连接响应错误 - API响应错误(API响应状态码、API响应body(前10行)、后端报错信息及堆栈)
数据输出到 API 时,支持关闭 SSL 证书验证。
当 API 使用了https 可以取消证书有效性验证,用户在 Headers 内新增一个参数,参数名为SSL-certificate-verification,当 SSL-certificate-verification值为 false 时,FDL 在调用 API 不进行证书有效性验证(仅当目标端的 API 配置了 https 时,才需要进行证书有效性验证)。
注:在实际传给服务端 API 的 Headers 内去除此参数,此参数仅应用于 FDL 内部。
滑鼠選中內容,快速回饋問題
滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。
不再提示
10s後關閉
反馈已提交
网络繁忙