历史版本57 :資料服務概述 返回文檔
編輯時間: 內容長度:图片数:目录数: 修改原因:
[helpvideo]8593[/helpvideo]

目錄:

1. 概述编辑

1.1 应用场景

  • 企业安全规范要求,不允许直连业务库,代码开发接口效率低,人工传输易出错。

  • 缺乏安全的数据共享机制,随着数据消费端增加,IT 出现重复造轮子的倾向。

1.2 功能简介

数据服务提供数据共享能力,可以加工、融合后的数据封装发布为规范化API接口数据,供外部系统调用,实现数据价值输出及共享开放。

15.png

2. 约束限制编辑

注:推荐使用谷歌和 Edge 浏览器最新版本,其他浏览器可能会有兼容问题。

3. 前提条件编辑

  • 使用 FineDataLink 的数据服务功能创建数据 API 需要注册相关功能点,详情参见:注册简介

  • 非超级管理员用户想要使用该功能需要为用户分配 数据服务管理权限

  • 确认连通性:

    发起 API 调用请求时,请求会下发至数据服务的服务器,并被进一步转发至数据源中执行数据查询,因此需要保证可以访问相应的数据源及其所在的网络。需要在保证网络连通的前提下,再使用数据服务;如果网络不通,会导致 API 调用请求无法执行。您可设置 配置黑白名单 进行控制。

4. 操作流程编辑

使用 FineDataLink 数据服务进行API发布的操作流程如下:

注:数据服务完整示例请参见:数据服务示例

步骤

步骤一:配置数据源

1)数据服务支持的数据源详情参见:数据服务支持的数据源

2)在进行数据服务新建 API 之前,需要将已处理好、需要发布数据对应的数据库接入 FineDataLink,以便在 API 发布配置过程中,可通过选择数据源名称来控制需要发布的数据。详情参见:配置数据连接 

步骤二:发布API

在 FDL 中发布一个 API 需要三步,分别为:填写 API 信息设置发布内容及参数预览测试。详情请参见:发布 API 概述

步骤三:绑定 API 至应用

API 发布后,需要将 API 绑定在「应用」中,以此获取外部系统调用需要输入的鉴权认证,保证发布的 API 接口在被外部系统调用时更安全。详情请参见:绑定API至应用

「步骤二:发布API」中也可以绑定应用

步骤四(选做):摘要签名认证、配置黑白名单

1)数据服务支持使用简单身份认证及加密身份认证调用数据服务API,可根据需要选择。详情请参见:摘要签名认证方式

2)外部系统调用时开通黑白名单,可保证发布的 API 接口在被外部系统调用时更安全。详情请参见:配置API黑白名单

1)使用发布的 API :

使用数据服务发布的API(GET 请求)

使用数据服务发布的API(POST application/json请求)

使用数据服务发布的API(POST x-www-form-urlencoded请求)

2)对 API 进行任务管理、监控,查看运行状态和 API 调用情况、批量上下线 API 等,请参见:服务运维

注1:4.1.6.3 及之后版本,API任务、数据服务应用禁止被多人同时编辑。详情请参见:任务禁止被多人同时编辑

注2:4.1.9.3 及之后的版本支持使用「回收站」进删除任务的还原、管理,详情请参见:回收站

5. 兼容说明编辑

1)4.0.24 及之前的版本升级 4.0.28 版本:

  • 对于 API 发布方,需要重新创建一遍已有 API,或是通过我们的定制脚本完成迁移。

  • 对于调用方,在调用时由于增加了应用ID路径,需要手动修改API的访问地址。

  • 升级前若 API 设置了参数,会自动将参数值拼接上单引号发送,更新后,所见即所传,不会自动拼接单引号过去,可能会需要调整发布SQL或者传参方式。

2)4.0.26 及之后的版本升级 4.0.28 版本:

  • 对于调用方,在调用时由于增加了应用ID路径,需要手动修改API的访问地址。

  • 升级前若 API 设置了参数,会自动将参数值拼接上单引号发送,更新后,所见即所传,不会自动拼接单引号过去,可能会需要调整发布SQL或者传参方式。

如有需要可联系帆软技术支持,联系方式:前往「服务」,选择「在线支持」、电话「400-811-8890」。

6. 注意事项编辑

若用户使用 FineDataLink 数据服务发布的 API 由于跨域问题无法调用,可以修改 FineDataLink 服务器目录 %tomcat%.../conf/web.xml,删除OPTIONS的配置,如下图所示:

然后重启工程

注:此操作有一定的安全风险。

7. API输出与数据服务的区别编辑

区别项
API输出数据服务
功能说明

12.png

API输出算子,可调用业务系统的接口,修改业务系统的数据

可参考示例进行理解:活动日程信息更新至企业微信日程新增/修改宜搭表单数据

将处理后的数据,封装发布为规范化的 API 接口,供外部系统调用

数据服务生成的是一个API接口,可供外部系统调用

可参考示例进行理解:数据服务示例