历史版本2 :数据接收-通用API接收 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

FineDataLink 版本功能变动
4.2.8.4数据服务功能可实时接收上游下发的数据,解析后写入数据库

1.2 应用场景

用户希望 FineDataLink 提供一个接口,支持业务系统调用,向其他系统/数据库写入/更新数据。

1.3 功能简介

数据服务模块支持发布数据接收 API,实时接收上游下发的数据,解析后写入数据库。如下图所示:


2. 新建数据接收API编辑

1)进入 FDL 工程,点击「数据服务,新建一个数据接收 API 。如下图所示:

32.png

2)接收方式默认为「通用API请求体」。如下图所示:

33.png

3. 服务内容(数据接收)编辑

3.1 设置数据来源

1)点击「来源请求体解析」右侧的「配置」按钮,输入 JSON 结构的数据,作为。如下图所示:

1753324721470473.png

勾选「将模板数据作为服务入参调试值」按钮效果:将用户输入的 json 模板数据填入服务入参的调试值。如下图所示:

39.png

2)选择要解析的节点。如下图所示:

注:不支持跨路径解析数组。

1753324905426422.png

3)可查看解析后的字段名、字段路径,支持删除字段。如下图所示:

注:删除字段时,若只剩最后一个字段,「删除」按钮禁用。

1753324947876855.png

点击「解析预览按钮,支持查看解析后的数据:

37.png

4)配置完成后,最终界面如下图所示:

1753325237179443.png

点击「编辑按钮,可对数据来源配置进行修改。

3.2 设置数据去向

接下来需要设置目标表及字段映射。如下图所示:

40.png

设置项
说明
数据操作固定为:数据插入更新,暂不支持数据删除
目标表类型默认需要选择已存在表,可点击「新建目标表按钮,在目标数据库中自动建表
字段映射方式
可选择同名映射、同行映射,详情请参见:数据同步-数据去向与映射
字段映射

1)来源表的字段类型根据配置解析时的模板数据生成,实际数据类型不一致时,将报

2)支持取消某个字段的映射关系,支持调整目标表中字段的前后顺序

1753326793683249.png

主键映射1)目标表未配置主键时,可在此处配置主键;目标表已有主键时,直接显示主

2)目标表存在主键后,支持配置主键冲突策略:

41.png

3.3 高级配置

1753326919511904.png

按钮状态
说明
开启

调用发布的 API 时,监控数据是否通过该接口入库成功:

API 接口将先进行数据缓存,等待数据入库操作完成后,返回入库结果

关闭

调用发布的 API 时,监控数据是否通过该接口推送成功:

  • API 接口将直接返回数据缓存结果,再执行数据入库操

  • 数据入库是否成功的结果不进行返回

3.4 参数和变量

44.png

参数和变量
说明
预定义参数该 API 发布后,调用该 API 时需要填入的参数;若在 3.1 节勾选了「将模板数据作为服务入参调试值」按钮,3.1 节输入的 JSON 数据为此处调试值的值
返回变量调用该 API 后,返回的参数

4. 接口配置编辑

45.png

4.1 基础属性

设置项
说明
请求方式只支持选择 POST
路径
配置要发布的API路径。

API路径不允许重复。

默认为空,支持指定英文、数字、下划线(_)、连字符(-)、正斜杠(/);不支持以正斜杠(/)开头和结尾

例如以下完整的API请求路径示例:

http://192.168.5.175:8089/webroot/service/publish/应用ID/demo

注1:service前的部分为发布API所在的当前 FineDataLink 服务器地址

注2:应用ID是API被绑定应用的ID,详情参见绑定API至应用

超时时间
填写响应超时时间,如果在指定时间后仍没有返回查询结果,则接口返回超时错误

默认10000ms,必填

已授权应用

用户可在创建 API 时将其添加至授权应用,同时在 API 测试阶段可直接测试 API 调用情况

同时可以将 API 任务批量添加至多个有权限的应用下

详情请参见:绑定API至应用

API 若想被调用必须绑定应用

4.2 接口请求

注:Query 禁用。

设置项
说明
请求 Body 格式
只支持 application/json
Body 整体绑定

默认开启且禁止关闭

绑定服务入参调用该接口时,需要填入参数 inputJSONString
调试值数 inputJSONString 的调试值,值为本文 3.4 节设置的调试值

4.3 接口响应