DB12∕T 1231-2023 政务信息资源共享数据交换技术规范.pdf

ICS35.240.01CCS L 6712天津市地方标准DB12/T 12312023政务信息资源共享数据交换技术规范Government infomation resources sharing-Data exchanging technique specification2023-07-19 发布2023-09-01 实施天津市市场监督管理委员会发 布DB12/T 12312023I前言本文件按照GB/T 1.12020标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。本文件由天津市互联网信息办公室提出并归口。本文件起草单位：天津市互联网信息办公室、天津市大数据管理中心、天津市标准化研究院。本文件主要起草人：边柯柯、张永跃、刘津、由方岚、袁琳、李丹阳、宋万洋、张楠、李晓明。DB12/T 123120231政务信息资源共享数据交换技术规范1范围本文件规定了政务信息资源共享交换采用的数据格式、数据交换方式、数据交换流程和技术要求。本文件适用于市、区两级政务部门及公共服务机构开展政务信息资源共享工作。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。DB12/T 1230-2023政务信息资源共享 总体框架DB12/T 1233-2023政务信息资源共享 政务信息资源目录编码规范3术语和定义DB12/T 1230-2023、DB12/T 1233-2023 界定的以及下列术语和定义适用于本文件。3.1资源提供方resource provider通过共享交换平台提供政务信息资源的政务部门或公共服务机构。注：资源提供方负责编制信息资源目录，发布相应信息资源。3.2资源使用方resource consumer通过共享交换平台申请、获取政务信息资源的政务部门或公共服务机构。3.3数据交换data exchanging政务部门或公共服务机构间通过共享交换平台进行政务信息资源传输的过程。3.4政务信息资源目录系统government information resource catalog system对信息资源目录进行全生命周期管理的系统，具有信息资源编目、导航、检索以及发起数据共享申请等功能。3.5服务管理总线service management bus用于接口的注册、发布及调用管理，支撑接口服务形式的数据交换。4交换内容数据交换内容包括结构化文件、非结构化文件、库表数据、接口传输数据：a)结构化文件格式包括但不限于 csv、xlsx、rdf；b)非结构化文件格式包括但不限于 pdf、docx；c)库表数据包括但不限于 Oracle、MySQL、GBase 数据库数据；DB12/T 123120232d)接口传输数据包括但不限于 json、xml 数据。5交换形式数据交换形式包括以下三种：a)数据库表交换:通过前置节点交换实现,适用于大体量、高时效性、周期性的结构化数据交换场景，资源使用方通过共享批量获取数据，与自有数据融合后可进行综合业务处理、统计分析、数据挖掘等应用；b)文件交换:通过前置节点交换实现,适用于无系统承载的结构化、非结构化文件交换场景；c)服务接口交换:通过服务管理总线注册并发布服务接口方式实现,适用于小数据包、高频次、高时效性、周期性的数据交换场景，资源使用方通过调用服务接口进行查询、核验等应用。数据交换的参与对象包括：资源使用方、资源提供方、共享交换平台。数据交换业务逻辑如图1：图 1数据交换业务逻辑6交换流程基于共享交换平台的数据交换业务流程见图2。a)资源使用方通过共享交换平台检索所需资源；b)资源使用方通过共享交换平台对资源发起共享申请，申请中应注明数据使用场景、联系方式及其他要求信息；c)根据资源共享条件，无条件共享资源应在共享交换平台备案后获取；有条件共享的资源，在申请提交并由资源提供方审核通过后获取。DB12/T 123120233图 2数据交换业务流程7数据库表交换7.1交换要求7.1.1初始设置资源提供方与资源使用方应遵循以下数据库表交换规则：a)数据库表命名：前置节点数据库中的库表命名规则应为“T_”+“信息类编码”，其中信息类编码中“/”应改为“_”。信息类编码即信息资源目录类编码，是标识政务信息资源目录的唯一编码，编码规则应符合政务信息资源共享 政务信息资源目录编码规范。示例：“政务信息资源目录（信息类）名称：婚姻登记信息”“信息类编码：3070020000013/000017”“库表名称：T_3070020000013_000017”b)交换规则要求字段：除完成业务字段创建外，数据库表结构中还应增加时间戳及数据状态标记位，共 3 个字段，应符合表 1 规范要求；c)添加注释：资源提供方应对数据库表及业务字段添加注释信息，便于理解业务含义；d)设置主键应满足以下条件之一：1)业务字段中存在作为此表主键的字段，应设置此字段为主键；2)业务字段中不存在作为此表主键的字段，应使用 GUID 字段作为主键，使用时需要在 GUID字段中上传能代表数据唯一标识的主键值。DB12/T 123120234表 1交换规则要求字段序号字段含义字段名数据类型数据格式是否可空说明1当前数据的物理创建时间TOPIC_ADD_TIME日期型DATETIME非空记录数据在部门前置节点数据库中第一次入库的物理时间2当前数据的最后修改时间TOPIC_UPDATE_TIME日期型DATETIME非空记录数据在部门前置节点数据库中最后一次修改入库的物理时间3数据状态标识位OPERATETYPE字符型VARCHAR(2)非空数据状态标识位I：新增U：修改D：删除7.1.2操作要求资源提供方在准备、组织数据交换时应遵循以下要求：a)数据库中表结构应与政务信息资源目录系统中注册的信息类（信息项）相对应（如字段类型、长度、是否为必填项、主键等），若有表结构改动应先在政务信息资源目录系统中变更目录，并由变更后目录提供的库表创建脚本语句进行前置节点数据库表结构修改；b)挂接的数据库表应添加唯一标识的主键字段，作为数据更新的依据；c)GUID 字段作为主键的情况下，部门应自行上传能作为数据唯一标识的数值，不能将 GUID 字段设置为自动增长或其他不符合标准的数值；d)当部门第一次上传数据时，TOPIC_ADD_TIME 及 TOPIC_UPDATE_TIME 值应保持一致（即赋予该字段当前数据写入时间），且 OPERATETYPE 字段内容填“I”；e)当部门需修改或删除数据内容时，除更新业务字段值外，应同时修改 TOPIC_UPDATE_TIME 字段值为当前数据写入时间，OPERATETYPE 字段赋值为“U”或“D”；f)TOPIC_ADD_TIME、TOPIC_UPDATE_TIME、OPERATETYPE 三个字段都不应为空，并且 OPERATETYPE字段中只应存在“I”、“U”、“D”三种值；g)挂接数据字段为“DATE”、“DATETIME”等日期型时，应写入实际时间值，不应写入“0000-00-00”、“0000-00-00 00:00:00”等无意义时间值。7.2交换流程数据库表交换业务流程，包括但不限于：a)资源注册：资源提供方通过共享交换平台注册政务信息资源，应注明资源描述、共享类型、资源格式、更新频率、信息项等资源目录元数据信息，其中资源格式应选择“数据库表”；b)注册审核：共享交换平台对资源提供方发起的资源注册进行审核，审核通过后，资源目录状态变为“已发布”；c)资源挂接审核：资源提供方将数据挂接到前置节点数据库，并将数据挂接状态设置为“挂接待审核”。1)满足数据质量检查要求的，共享交换平台审核通过，并将数据挂接状态调整为“已挂接”；2)不满足数据质量检查要求的，共享交换平台将数据挂接状态调整为“挂接不通过”，并将问题反馈给资源提供部门，部门调整完成后再次进行挂接操作。DB12/T 123120235d)资源挂接审核通过后，共享交换平台按资源提供方设定的更新频率定期进行数据抽取；e)资源使用方在资源申请备案通过后，在本方前置节点数据库中创建库表结构；f)共享交换平台根据共享申请约定，向资源使用方前置节点数据库推送数据；g)数据获取后，资源使用方应向资源提供方确认获取数据的入库时间、入库记录数量等。8文件交换8.1交换要求8.1.1文件存放路径根据前置节点服务器操作系统种类，应明确交换文件的存放路径，例如：Windows：d:/tjgxLinux：/home/user/others/tjgx8.1.2文件夹命名规则在前置节点中创建存放推送或接收文件的文件夹，文件夹命名规则为“T_”+“信息类编码”，其中信息类编码中“/”应改为“_”，并对文件夹授予读写权限，文件夹命名规则示例如下：“政务信息资源目录（信息类）名称：统计年报”“信息类编码：3070020000016/000012”“文件夹名称：T_3070020000016_000012”8.2交换流程文件交换业务流程，包括但不限于：a)资源注册：资源提供方通过共享交换平台注册政务信息资源，应注明资源描述、共享类型、资源格式、更新频率、信息项等资源目录元数据信息，其中资源格式应选择“文件”；b)注册审核：共享交换平台对资源提供方发起的资源注册进行审核，审核通过后，资源目录状态变为“已发布”；c)资源挂接审核：资源提供方将资源文件上传至前置节点文件存放路径中，文件上传工具或程序需将编码格式设置为“GBK”，并将资源挂接状态设置为“挂接待审核”；d)资源挂接审核通过后，共享交换平台按照资源提供方设定的更新频率定期进行文件抽取；e)资源使用方在资源申请备案通过后，按照文件夹命名规则在本方前置节点指定路径中创建资源接收文件夹；f)共享交换平台根据共享申请约定，向资源使用方前置节点指定文件存放路径推送资源文件；g)文件获取后，资源使用方应向资源提供方确认获取文件的提供时间及数量等。9接口服务9.1接口接入要求共享交换平台与资源提供方（包括各级政务部门、基础库建设方、主题库建设方），在发布服务接口时应遵循如下要求：a)共享交换平台应将发布接口的服务器 IP 和端口加入白名单；b)接口协议：应至少支持 HTTP Open API、RESTful API、Web Service 三种接口协议种的一种，需要级联发布的部门接口应遵循 HTTP Open API 或 RESTful API 协议；DB12/T 123120236c)字符编码：应遵循 UTF-8 编码规则；d)接口接入应至少提供表 2 所列信息；e)接口接入的定义及描述示例见附录 A.1。表 2接口接入信息说明参数参数说明接口名称接口名称功能说明接口功能描述URL样式写明调用接口的URL样式接入接口协议写明支持的协议，如：HTTP Open API、RESTful API、Web Service等请求方式支持POST、GET、POST/GET等方式接口参数写明参数名称、参数说明、参数数据类型、参数传值要求等提交数据举例对于特定格式（json、xml格式等）参数应举例说明返回HTTP状态写明返回HTTP状态所对应的状态说明返回数据参数写明返回参数的名称、参数说明等返回数据格式字符串/json/xml或其他格式应举例说明返回数据举例对特定格式（json、xml、自定义格式等）的返回参数应提供示例说明错误代码对错误信息进行定义，并进行详细说明9.2接口发布要求接口发布，即将接入服务管理总线的接口按照统一标准进行发布并按需提供服务，具体要求包括：a)网络要求：调用接口的各级政务部门信息系统应与服务管理总线联通；b)接口协议：接入的接口服务协议应至少支持 HTTP Open API、RESTful API、Web Service 中的一种；c)字符编码：UTF-8；d)接口发布应同时发布表 3 所列信息；e)接口发布示例见附录 A.2。表 3接口发布信息说明接口功能说明说明涉及接口的功能接口地址服务管理总线接口地址接口提供部门接口提供部门（即政务信息资源目录所属部门）适配参数说明提供适配参数说明接口协议说明支持的协议，如：HTTP Open API、RESTful API、Web Service等接口认证参数说明涉及接口接入服务管理总线认证的相关参数9.3协议转换要求接入规范/限制具体要求应符合表4。DB12/T 123120237表 4协议转换要求说明接入接口协议发布接口协议接入规范/限制HTTPHTTP1.应支持GET/PUT/POST/DELETE2.参数传递Query：Key-Value形式Body：Key-Value/JSON/byte形式3.应支持RESTful风格接入，如：http:/localhost:8081/abc/userId/search4.应支持HTTP返回结果透传，不做任何变换加工Web ServiceHTTP1.应使用Authorization与或WSSE格式的用户名密码接入SOAP Header2.对于anytype参数类型，参数定义时要经过特殊定义为“ws:anyType”3.接入后端WS服务方法必须是同步的4.支持的bindType是Document-Literal(Wrapper or Unwrapper)5.返回结果是将SOAP XML转化为JSON格式HTTPWeb Service1.应以SOAP 1.1格式发布Web Service服务，并提供标准的WSDL2.应使用服务管理总线提供的SDK传递AccessKey和signature等Header信息DB12/T 123120238AA附录A（资料性）服务接口说明示例A.1接口接入说明接口名称：婚姻信息核验接口功能说明：婚姻信息核验API实现根据业务请求编号、身份证号码、性别进行查询，所有查询参数为必填项。URL样式：http:/localhost:8081/abc/userId/search请求方式：POSTURL参数：名称：ywqqbh是否必须：是描述：婚姻信息核验提交数据举例：返回HTTP状态：200返回格式：JSON返回参数：code：0msg：datas：rownum：rows：C_NAME：C_GENDER：C_BIRTHDAY：BIRTH_CERTIFICATION_NUMBER：FATHER_NAME：FATHER_ID_NUMBER：FATHER_ETHNIC_GROUP：MOTHER_NAME：MOTHER_ID_NUMBER：MOTHER_ETHNIC_GROUP：调用示例：根据接口实际情况填写。DB12/T 123120239BBA.2接口发布说明调用地址：https:/10.10.10.10/qwerty接口名称：婚姻登记信息核验服务名：SFZProaass版本号：1.0.0SK：6Oz/6zeVGqBmcRoU2mUiQ5Is170=AK：c9c8565c86ae4e6182f7f92d4327c276调用方式：POST返回格式：JSON返回参数：responseCode:0;married:yes结果代码：0-无错误1-查询超时2-查询无结果3-参数错误