在科技飞速发展的时代,企业信息化建设将越来越完善、系统化,应用系统也将越来越多。大量数据沉淀在业务发展中,但这些数据并没有给企业带来直观的价值,也没有形成企业的数据资产。因此,越来越多的企业进入数据处理阶段,对主数据处理的需求也越来越明确。MDM基础数据管理平台是清理和处理企业主数据,使企业主数据具有独特性、准确性、一致性和及时性。错误数据和重复数据通过主数据清洗功能进行清洗,确保企业数据能够实现上述几点,然后分发给下游系统,使企业信息化更加完善。下面如平台出租技术提供分享支持:
在平台出租搭建发现第一部分将对主数据及相关组合的产品体系进行列举,同时对主数据产品进行简单说明,最后是对本次将要介绍的主数据接口进行整体的概述,后续将会对每一个接口进行详细说明。
1.产品体系
1.应用集成方案 ESB + MDM
2.统一身份方案 IDM + ESB
3.基础数据方案 MDM + ESB
4.数仓建设方案 DAP + ESB
5.集成底座方案 IDM + MDM + ESB (iPaaS方案)
6.数据中台方案 MDM + ESB + DAP (dPaaS方案)
7.应用中心方案 MDM + ESB + Portal (aPaaS方案)
8.全域集成方案 ESB + MDM + DAP + Portal + IDM (ePaaS方案)
2.产品介绍
MDM基础数据管理系统是对主数据进行同步、清洗、治理、分发全生命周期的一次管理,帮助各个业务系统的主数据统一,保障它们的完整性、一致性。同步就是从主数据源头到主数据的过程;治理是到主数据后进行一系列的管理和维护;分发是把治理后的主数据分发给各个业务系统,包括源头。
通过以上各个过程的相互配合从根本上解决企业各个业务系统之间数据不能共享、数据重复、错误等问题。使企业数据方面更完善,业务进行得更顺畅。
3.接口介绍
主数据的全部接口大体上可以分为三大类:数据查询类、同步导入类和日志管理类,下面的这张图片展示了所有主数据的接口以及它们所属的接口类型。文档后续将对每一个接口进行详细的介绍。注:本篇文档中涉及到的接口均以组织主数据为例进行介绍说明。
首先介绍数据查询类接口,查询类接口的数量占据了主数据接口数量的一半。包括全量数据查询接口、单条数据查询接口、任务数据查询接口、接口信息获取接口、文件信息获取接口、规则查询接口。下面将对这些接口一一进行介绍。
1.全量接口
1.接口说明:
全量接口是对当前主数据下的所有数据进行查询,根据状态分为“已发布”数据的全量查询和“已删除”数据的全量查询;支持分页查询。
2.调用URL:
1)已发布
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/published
2)已删除
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/deleted
3.调用方式:GET
4.入参信息
5.出参信息
6.使用说明
关于全量的使用需要注意的是,当入参中的当前页为空时,默认查询第一页数据;当入参中的单页数据数量为空时,默认查询10条数据,如果想更改这个默认值,需要到数据建模中进行配置,然后到功能建模中进行保存部署。
7.样例展示
2.单条接口
1.接口说明:
单条接口与全量接口相反,查询的是单条数据,同样也分为两种,一种是通过ID查询,另一种是通过CODE查询。
2.调用URL:
1)编码和应用查询
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/data-code/{dataCode}/{appCode}
2)ID和应用查询
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/data-id/{dataId}/{appCode}
3.调用方式:GET
4.入参信息
5.出参信息
6.样例展示
3.任务接口
1.接口说明:
数据的下发首先需要生成分发任务,通过任务关联业务系统以及选择对应的分发流程,然后进行数据的下发。而在不登录MDM系统的情况下,就可以通过任务接口去获取到即将下发的数据。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/records/task
3.调用方式:GET
4.入参信息
5.出参信息
6.样例展示
4.接口查询
1.接口说明:
该接口是用于获取主数据在不同业务系统中的接口信息,然后通过在分发流程中调用该接口来实现数据的统一分发。接口的信息配置是在控制台的应用配置模块进行相关信息的添加。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/records/api-info
3.调用方式:GET
4.入参信息
5.出参信息
6.使用说明
在控制台应用配置中选择对应的主数据点击接口配置去添加接口信息,保存后去到分发流程中进行服务的配置即可。
5.编码规则
1.接口说明:
规则查询接口可以某一类主数据的某一个字段关联的编码规则进行查询,查询接口的出参将value值填入,就是另外两个接口的入参。
2.调用URL:
1)获取编码规则
http://localhost:4040/mdm/openapi/OrgManageService/rest/code-rule/entries/{fieldCode}
2)生成编码规则
http://localhost:4040/mdm/openapi/OrgManageService/rest/code-rule/gen-real-code
3)生成编码信息
http://localhost:4040/mdm/openapi/OrgManageService/rest/code-rule/gen-trial-code
3.调用方式:GET/POST/POST
4.入参信息
5.出参信息
6.样例展示
数据管理类接口主要是对数据进行一些操作,比如导入、同步、删除等。具体包括数据删除接口、导入接口、批量同步接口、单条同步接口以及任务提交接口。下面将一一对这些接口进行说明。
1.数据删除
1.接口说明:
数据删除接口是对单条数据进行状态的修改,实际上并没有真正地删除掉这条数据,只是将数据的状态修改为已删除,满足实际业务的需要。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/data-code/{dataCode}
3.调用方式:DELETE
4.入参信息
5.出参信息
6.样例展示
2.导入接口
1.接口说明:
导入接口是将数据同步到临时表中,之后会生成对应的批次,然后通过批次号将数据同步到真实表中,这也是我们现在主推的一个同步方式。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/imp-all-fields
3.调用方式:POST
4.入参信息
5.出参信息
6.样例展示
3.批量同步
1.接口说明:
导入接口中提到,数据在同步到临时表后会生成对应的批次,在调用批量同步接口时,根据批次号获取到相应的数据,然后将数据同步到真实表中。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/imp-all-fields
3.调用方式:PUT
4.入参信息
5.出参信息
6.使用说明
对于isCreateTask 这个入参,如果想要自动生成分发任务,该入参值为“Y”,出参会有对应的taskId,否则入参值为“N”,taskId为空。
7.样例展示
4.单条同步
1.接口说明:
单条同步接口只能每次同步一条数据,数据直接同步到真实表,没有临时表过渡,这种同步方式现在并不推荐。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/sync-data
3.调用方式:GET
4.入参信息
5.出参信息
6.样例展示
5.提交接口
1.接口说明:
在生成了分发任务后,需要调用任务提交接口,通过分发流程将数据分发到下游业务系统中去。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/record/launch-flow/{taskId}/{flowCode}
3.调用方式:POST
4.入参信息
5.出参信息
6.样例展示
日志管理类接口包括了同步日志接口、初始化分发日志接口和分发日志回写接口,下面将一一对这三个接口进行说明。
1.同步日志
1.接口说明:
在将数据同步到真实表后,调用同步日志接口将日志信息插入到日志表中,但是这个实际使用中并不会用到,因为在调用同步接口的同时就会生成对应的日志信息,不需要再手动调用同步日志接口。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/sync-log
3.调用方式:POST
4.入参信息
5.出参信息
2.创建日志
1.接口说明:
在提交了分发任务后,数据已经主数据平台分发出去了,这时需要调用初始化接口生成分发日志,将数据的基本信息以及分发信息写入表中。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/create-logs
3.调用方式:POST
4.入参信息
5.出参信息
6.样例展示
3.回写日志
1.接口说明:
在数据从主数据平台分发出去之后,下游业务系统会对数据进行接收同步,在这之后,需要回写分发日志对状态进行更改,这时就需要调用分发日志的回写接口。入参分为两种情况,一种是当所有数据全部分发成功或者全部分发失败,这个时候入参为taskId和state 这样可以直接批量回写;如果状态不一致,入参是一个JSONArray和原有的回写接口一样。
2.调用URL:
http://localhost:4040/mdm/openapi/OrgManageService/rest/distribute-logs
3.调用方式:GET
4.入参信息
当状态一致时:
当状态不一致时:
5.出参信息
6.样例展示
总结概述
接下来如盘口出租技术提供对这篇文档介绍的接口进行总结说明以及接口的应用场景大致有哪些,在实际业务当中是怎样进行应用的。
1.接口汇总
本次对主数据的所有接口进行了分类汇总,共分成三大类:查询类接口、管理类接口和日志类接口,针对日常工作中涉及到的接口基本上都可以在这篇文档中找到,建议熟悉接口分类后,直接根据分类找到对应的接口。在接口的介绍中,对调用URL,调用方式、出参和入参进行了说明,同时对于一些接口在调用过程中需要注意的地方也进行了阐述。另外,大部分接口都附有调用样例,可以供学习使用的人进行参考。
2.应用场景
针对查询类接口,通常都是用于获取数据的相关信息,比如说全量接口,就可以查询到某一类主数据在某个应用系统中关联元素据有哪些;再比如task接口,在数据分发时经常会用到,用于查询下发的数据信息;而对于管理类接口更多的时候是应用于数据库的同步分发流程中,比如数据库的导入和批量同步接口,先同步到临时表在同步到真实表,这就是一个标准的同步流程;除了同步,还有分发过程中涉及到的提交任务接口,负责将数据分发出去;最后就是日志类接口,通常是穿插在同步分发流程中,来对同步分发信息进行管理。
3.心得体会
本次针对平台搭建发现主数据接口的汇总可以说是比较全面的,通过三种不同的类型来对主数据目前的所有接口进行分类汇总,对每一个接口的相关信息也都进行了说明和介绍,以及个别接口在使用过程中的注意事项,在文档中也都进行了阐述,同时,也都配有调用样例,后续可以通过这篇文档来对主数据接口进行学习。
针对我本人而言,也借着这次机会,对主数据的所有接口重新地整体地了解一遍,很多之前没用过的接口通过这次机会也都调用了一遍,在这个过程中也了解到了之前不知道的一些细节。针对之前不熟悉的接口,通过这次汇总,知道了接口的用途和用法,针对之前比较熟悉的接口也进一步地加深了对其的印象,相信这些会对我后续拓展新的接口或者对接口进行完善都会起到一定的辅助作用。
接口调用可视化展示:可呈现近一天、近一周、近一月的各类服务类型的调用汇总状况,包括服务所属应用服务名称,调用应用名称,总调用次数,成功调用次数等。通过仪表盘提供数据服务系统概览,包括“数据源数量”、“接口数量”、“用户数量”等数据。此外,仪表盘还应提供“接口访问趋势图”、“用户访问TOP”、“接口访问TOP”等分析数据,并允许用户自定义时间段进行联动数据库的统计分析。
文章来源:http://xefnxmx.cn|盘口,出租,提供,数据,中台,方案,MDM,ESB,DAP,