API查询控件介绍
功能概述: 在创建记录或编辑记录时,可以通过此控件调用已集成API(或封装业务流程PBP)获取数据,并将获取到的数据直接填充到当前记录的字段或子表中。除了获取数据,也支持向外推送数据。
应用场景举例
-
添加客户信息时,根据客户公司名称从天眼查平台搜索相关工商信息并填充到相关字段。
-
根据物流单号,获取到物流信息后,自动填充到物流信息子表中。
-
下拉列表数据源,来自于外部系统。
配置示例
获取单行数据配置示例
场景:根据手机号获取归属地后,将数据写入到对应的省份、城市字段中。
1、添加API查询字段
2、选择调用来源
调用来源:有已集成API和封装业务流程两种,使用方式类似,我们以调用已集成API为例介绍。
只能选择被授权过的已集成API。
3、配置参数
系统会根据API配置,自动显示需要的参数。所以,这里的参数不是固定的,不同API可能不同,名称有红星的为必填参数,没有红星的可以选填。
4、选择字段显示类型
类型有三种:按钮、下拉框、搜索下拉框,区别如下;
-
按钮: 在点击按钮时请求并获取返回参数
-
下拉框: 在激活下拉框时请求,将返回的多条数据列表作为下拉菜单的选项进行选择
-
搜索下拉框: 在激活下拉框时请求,将返回的多条数据列表作为下拉菜单的选项进行选择
下拉框和搜索下拉框的方式只适合用返回多条数据的场景,查询手机号归属地的API没有返回对象数组,因此本场景只能选择按钮的方式。 另外两种方式请参考多行数据配置示例。
5、将返回数据写入表单字段
配置好API、参数和类型后,就可以将返回的数据写入到对应的字段了。
效果:
API返回 多行数据的配置示例
场景:输入公司名称后,去天眼查API搜索相关公司,可能会搜索到多家公司(多行数据),我们来看下如何将其他工商信息填充到对应字段中。
1、添加API查询字段
2、选择要调用的API
-
只能选择被授权过的API
-
选择API后,还需要配置传入的参数,名称有红星的为必填参数。
3、配置参数
系统会根据API配置,自动显示需要的参数。所以,这里的参数不是固定的,不同API可能不同。