API数据源
系统逻辑触发API调用,从外部获取数据。
需求场景
搭建的应用,数据不是应用自身产生的,而是来自于外部数据源,即通过外部API接口对接的方式获取数据。
[!TIP|style:flat]
API数据源鉴权,需根据其具体定义处理,一般包括以下方式:
1、类似token。判断比如access token是否超过有效期,如果超过,刷新access token,并且将token写入表中存储起来,便于后续请求读取。
2、直接请求。按照接口定义和需要,配置鉴权参数,比如header中或者request body中配置。
如果遇到其他方式,且平台未支持,请联系我们。
功能入口
在工作流“配置”界面,点击“+”,在浮窗中即可找到“API调用外部数据”入口。
配置过程
点击“API调用”信息块,右侧侧滑出详细的配置界面。
(1)名称:即该次API调用的名称;
(2)请求方式:即该次API调用的请求方式,包括get、post、put、delete、patch等五种方式;
(3)选择数据集:即该次API调用获取到数据后需要填充的逻辑表;
(4)链接:即该次调用API的接口地址;
(5)头部数据:即配置头部参数;
(6)输出数据:即配置输出参数;
(7)返回数据:即配置返回参数。
上述配置完成后,点击“确认”保存即可。
案例:停车场计费系统
某停车场的计费系统,通过向计费服务发送车辆入场和出场时间,获得该车辆的停车费用。
API接口格式
请求格式:
curl -X POST \
'http://10.6.5.116:8080/api/run' \
-H 'Content-Type:application/x-www-form-urlencoded' \
-d 'start_time=2021-12-01%2012%3A18%3A22&end_time=2021-12-01%2014%3A17%3A58'
返回格式:
{
"RequestId": "c5c2b5bf-ce83-4ba1-9b1e-2b6f5aa771b8",
"Success": true,
"Code": "",
"ErrorMessage": "Success",
"Data": {
"data": "2.14",
"message": "success",
"success": true
}
}
配置操作
业务流程约定使用自定义按钮“出场”触发计费,从外部计费服务器获取车辆停车费用;
编辑工作流,在按钮触发器之后,添加“API调用”功能节点;
在API调用侧滑窗配置API调用。 名称:是该节点(数据集)的名称,命名需要能清晰的代表该节点的意义 请求方式:参考请求格式后,可知是POST请求 选择数据集:请求接口时需要传出的参数一般都会包含在上游节点的数据集中。因此这里选择“按钮触发器” 链接:是API接口的地址。参考请求格式后,可知是“http://10.6.5.116:8080/api/run” 头部数据:根据curl格式的请求格式看,“-H”后面的信息就是头部数据对应的信息 输出数据:是请求接口时需要传出的参数,这里是“start_time”和“end_time” 返回数据:根据返回格式看,停车费数据其实是包含在Data中的data,所以要对应的创建Data这个object,然后在Data之下再创建data这个string。获取到的data,这里我们把他命名为“返回金额”
请求格式中,时间参数的格式是YYYY-MM-DD HH:mm:ss,在系统中需要通过公式编辑器转换成“string”类型。
获取到计费金额后,添加更新单条记录这个节点,将计费金额写入到车辆的出场收费记录中。这里数据项,引用的就是“API调用节点”数据集中的“返回金额”。