DB35_T+2146-2023政务数据汇聚+推送接口配置.docx

ICS01.040.35CCSL 7235 福建省地方标准DB35/T 21462023政务数据汇聚 推送接口配置Governmental data ingestion Data push interface profile2023 - 10 - 25 发布2024 - 01 - 25 实施福建省市场监督管理局发 布目次前言II1 范围12 规范性引用文件13 术语和定义14 缩 略语15 推送服务25.1 概述25.2 服务描述25.3 SM2 公钥交换25.4 用户身份验证25.5 SM4 密钥获取25.6 数据推送26 传输协议3附录 A（规范性） 推送接口配置参数4附录 B（资料性） 推送服务示例7参考文献9前言本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由数字中国研究院（福建）提出。 本文件由福建省信息化标准化技术委员会（SAFJ/TC 11）归口。 本文件起草单位：数字中国研究院（福建）、福建理工大学、福州福大经纬信息科技有限公司、福建省标准化研究院、福州大学。 本文件主要起草人：余劲松弟、涂平、佟瑞菊、吴升、王洪庆、文芳。 政务数据汇聚 推送接口配置1 范围本文件规定了政务数据汇聚推送接口配置的推送服务和传输协议。本文件适用于政务数据汇聚推送接口的开发、测试和应用。 2 规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件， 仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T 32907 信息安全技术 SM4分组密码算法GB/T 35276 信息安全技术 SM2密码算法使用规范DB35/T 1777 政务数据汇聚：数据集的规范化描述DB35/T 1884 政务数据汇聚 核心接口描述 3 术语和定义DB35/T 1884界定的以及下列术语和定义适用于本文件。 3.1接口配置 interface profile基于相关规范的接口定制。 3.2推送服务 push service将相关信息推送到政务数据汇聚指定接口地址的相关操作。 4 缩略语下列缩略语适用于本文件。 ECB：电子密码本（Electronic Codebook） FTP：文件传输协议（File Transfer Protocol） GDI：政务数据汇聚（Governmental Data Ingestion） GUID：全局唯一标识符（Globally Unique Identifier） JSON：JavaScript对象表示法（JavaScript Object Notation） KVP：键值对（Key Value Pair） PKCS：公钥加密标准（Public Key Cryptography Standards） SOAP：简单对象访问协议（Simple Object Access Protocol） WSDL：Web服务描述语言（Web Services Description Language） XML：可扩展标记语言（Extensible Markup Language） XSD：可扩展标记语言模式定义（XML Schema Definition） 5 推送服务5.1 概述推送服务包括但不限于服务描述、SM2公钥交换、用户身份验证、SM4密钥获取和数据推送等操作。 5.2 服务描述采用DB35/T 1884规定的服务描述配置请求参数。 采用DB35/T 1884规定的服务描述定制返回结果，包括接口地址、支持协议、二进制字段编码和每次推送的最大记录数，并应符合附录A中表A.1的规定。 5.3 SM2 公钥交换接口对接前，默认按GB/T 35276生成SM2密钥对，进行公钥交换。 SM2公钥请求配置参数服务名称、版本号、SM2公钥请求操作，应符合附录A中表A.2的规定，示例见附录B的B.1。 注： 将生成的SM2公钥进行Base64编码，用于存储和交换。 5.4 用户身份验证在推送前，应根据提供的用户名、密码调用身份验证接口，获取身份验证字符串。 用户身份验证请求配置参数包括服务名称、版本号、用户身份验证操作、用户名和用户密码，应符合附录A中表A.3的规定，示例见附录B的B.2。 用户身份验证成功的返回结果为GUID验证字符串，如：“2AAA12CD-008F-4571-BB48-43FE83780BDA”；身份验证失败，应返回失败内容，格式为“ERR:具体原因”，如“ERR:账号不存在！”。 用户身份验证请求参数及返回结果默认采用GB/T 35276规定的SM2公钥加密传输。 5.5 SM4 密钥获取在推送前，应根据用户身份验证得到的GUID验证字符串获取SM密钥，SM密钥应符合GB/T 32907。SM4密钥获取请求配置参数包括服务名称、版本号、密钥获取操作、GUID验证字符串，应符合附录A中表A.4的规定，示例见附录B的B.3。 默认采用GB/T 35276规定的SM2交换传输SM4密钥。SM4密钥有效期宜默认设为24小时。 5.6 数据推送通过调用Web Service接口，将数据推送到服务描述返回的接口地址,并接受返回值。 推送参数包括服务名称、版本号、数据推送操作、数据集、验证字符串和扩展参数，应符合附录A 中表A.5的规定，示例见附录B的B.4。 数据集每一条数据记录应包含新增、删除、修改等操作类型，对应的标签属性分别为add、delete 和update。数据集采用XML格式，按DB35/T 1777进行描述。 推送返回值包含flag和msg节点。flag的值为true时，表示操作成功；flag为false时，表示操作失败；msg的内容为状态代码和代码说明。返回消息应符合附录A中表A.6的规定。返回值默认采用XML格式。 推送请求配置参数及返回结果默认采用GB/T 32907规定的SM4加密传输，加密模式默认采用ECB，填充模式默认采用PKCS5Padding。 如需指定JSON等其它消息格式，应与本文件保持一致。 6 传输协议推送服务宜采用HTTP KVP、FTP、SOAP等传输协议，默认采用SOAP协议。推 送 服 务 的 WSDL 的 请 求 语 法 如 下 ： http:/www.myserver.org:port/path?wsdl 表A.2 SM2 公钥请求配置参数 表A.3 用户身份验证请求配置参数 附 录 A（规范性） 推送接口配置参数表A.1表A.6分别为服务描述返回结果信息、SM2公钥请求配置参数、用户身份验证请求配置参数、SM4密钥获取请求配置参数、数据推送请求配置参数和数据推送返回结果格式及代码说明。 表A.1 服务描述返回结果信息名称 英文名 短名 定义 数据类型 值域 多重性 接口地址 Interface Address iaddress 推送服务的接口地址 XML XML元素 支持协议 Supported Protocol sprotocol 推送服务的传输协议 字符串 HTTP KVP, FTP, SOAP, other 1:N 二进制字段编码 Blob Encoding bencoding 推送数据中二进制字段的编码 字符串 ASCII, UTF-8, Decimal, Hexadecimal, Base64, 其它，默认采用Base64 1:1 每次推送最大记录数 Max Records mrecords 每次推送的最大记录数量 整型 默认500 1:1 注： 0:1表示可选且不具有多重性，0:N表示可选且具有多重性，1:1表示必选且不具有多重性，1:N表示必选且具有多重性。 名称 英文名 短名 定义 数据类型 值域 多重性 服务 Service service 服务名称 字符串 GDI 1:1 版本号 Version version 服务版本号 字符串 m.n.k，如：1.0.0 1:1 操作 Operation operation SM2公钥请求操作 字符串 GetSM2Key 1:1 名称 英文名 短名 定义 数据类型 值域 多重性 服务 Service service 服务名称 字符串 GDI 1:1 版本号 Version version 服务版本号 字符串 m.n.k，如：1.0.0 1:1 操作 Operation operation 用户身份验证操作 字符串 UserAuthentication 1:1 用户名 User ID uid 用户名 字符串 自由文本,无特殊字符 1:1 表A.6 数据推送返回结果格式及代码说明 表 A.3 用户身份验证请求配置参数（续）名称 英文名 短名 定义 数据类型 值域 多重性 用户密码 User Password upasswd 用户密码 字符串 字母加数字或符号的组合，不能单独使用数字、字母或字符，长度不小于8位 1:1 表A.4 SM4 密钥获取请求配置参数名称 英文名 短名 定义 数据类型 值域 多重性 服务 Service service 服务名称 字符串 GDI 1:1 版本号 Version version 服务版本号 字符串 m.n.k，如：1.0.0 1:1 操作 Operation operation SM4密钥获取操作 字符串 GetSM4Key 1:1 GUID验证字符串 GUID guid 身份验证字符串 字符串 自由文本 1:1 表A.5 数据推送请求配置参数名称 英文名 短名 定义 数据类型 值域 多重性 服务 Service service 服务名称 字符串 GDI 1:1 版本号 Version version 服务版本号 字符串 m.n.k，如：1.0.0 1:1 操作 Operation operation 数据推送操作 字符串 PushData 1:1 数据集 Dataset dataset 数据集 按DB35/T 1777描述数据 默认XML 1:1 验证字符串 Verifying String guid 返回的验证字符串 字符串 GUID类型 1:1 扩展参数 Parameter Extension pextension 数据请求的参数 extension 0:1 状态代码 代码说明 00 操作成功 01 XML格式不正确 02 数据库操作失败：具体错误信息 03 guid已过期 04 目录中不存在主键，无法删除 表 A.6 数据推送返回结果格式及代码说明（续）状态代码 代码说明 05 每次推送数据不能超过最大记录数 注： 返回结果格式如下： true,false 状态代码，代码说明 . 附 录 B（资料性） 推送服务示例B.1 SM2 公钥请求示例操作名：SM2公钥获取请求SOAP请求： B.2 用户身份验证请求示例操作名：汇聚用户身份验证请求 SOAP请求： test * B.3 SM4 密钥获取请求示例操作名：SM4密钥获取请求SOAP请求： 2AAA12CD-008F-4571-BB48-43FE83780BDA B.4 数据推送请求示例操作名：数据推送SOAP请求： xmlns:xsi=http:/www.w3.org/2001/XMLSchema-instance xmlns:gdi=http:/www.myserver.org:port/path/1.0 xmlns:soapenv=http:/schemas.xmlsoap.org/soap/envelope/ XML格式，按DB35/T 1777进行描述 2AAA12CD-008F-4571-BB48-43FE83780BDA soapenv:Envelope xsi:schemaLocation=http:/www.myserver.org:port/path? http:/www.myserver.org:port/path/All.xsd 参 考 文 献1 GB/T 21063.32007 政务信息资源目录体系 第3部分：核心元数据2 DB35/T 6522006 数字福建政务信息 元数据 3 DB35/T 9182009 电子政务信息数据交换 4 W3C REC-xml-20081126 Extensible Markup Language XML/1.0 5 W3C REC-xmlschema11-1-20120405 Schema Definition Language - XSD/1.1 Part 1: Structures 6 W3C REC-xmlschema11-2-20120405 Schema Definition Language - XSD/1.1 Part 2: Datatypes