政务与社会数据融合治理 第2部分：服务接口技术要求

ICS 35.080 CCS L70 15 内 蒙 古 自 治 区 地 方 标 准 DB15/T 2240.2—2021 政务与社会数据融合治理 第 2 部分：服务接口技术要求 Government affairs and social data fusion governance—Part 2：Service interface technical requirements 2021-07-23 发布 2021-08-23 实施 内蒙古自治区市场监督管理局 发 布 DB15/T 2240.2—2021 目 次 前言 ................................................................................. II 1 范围 ............................................................................... 1 2 规范性引用文件 ..................................................................... 1 3 术语和定义 ......................................................................... 1 4 缩略语 ............................................................................. 1 5 服务接口 ........................................................................... 2 5.1 概述 ........................................................................... 2 5.2 服务接口设计原则 ............................................................... 2 5.3 服务接口基本要求 ............................................................... 2 6 服务接口基本能力要求 ............................................................... 4 6.1 6.2 6.3 6.4 6.5 能力概述 ....................................................................... 能力分类 ....................................................................... 接口发布能力要求 ............................................................... 文件发布能力要求 ............................................................... 数据集发布能力要求 ............................................................. 4 5 5 5 6 7 服务接口对接流程 ................................................................... 6 8 服务接口使用流程 ................................................................... 7 9 服务接口安全要求 ................................................................... 7 10 服务接口审计要求 .................................................................. 7 附录 A（规范性）接口调用返回码定义 ..................................................... 8 参考文献 .............................................................................. 9 I DB15/T 2240.2—2021 前 言 本文件按照GB/T 1.1—2020 《标准化工作导则 第1部分：标准化文件的结构和起草规则》的规定 起草。 本文件是 DB15/T 2240《政务与社会数据融合治理》的第 2 部分。DB15/T 2240 已经发布了以下部 分： ——第 1 部分：总体要求； ——第 2 部分：服务接口技术要求。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本文件由内蒙古自治区大数据中心提出并归口。 本文件起草单位：内蒙古自治区大数据中心、内蒙古自治区政务服务局、内蒙古自治区质量和标准 化研究院、内蒙古大学、内蒙古工业大学、内蒙古晨跃科技有限公司、新华三技术有限公司、内蒙古金 融科技有限公司、内蒙古华昕科技有限公司。 本文件主要起草人：张世铭、应智强、徐晓强、翟瑞霞、张建军、全鑫、朱晓春、蒋柠、崔连伟、 李华、李孝雷、孙晓辉、杨康、李欢、周佳琪、孙健、陈威升、李耀鑫、黄迪。 II DB15/T 2240.2—2021 政务与社会数据融合治理第 2 部分：服务接口技术要求 1 范围 本文件规定了政务数据与社会数据融合治理中，提供数据服务时服务接口的基本要求。 本文件适用于政务数据与社会数据融合治理及对相关应用的支撑。 2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件， 仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本 文件。 GB/T 35274 信息安全技术 大数据服务安全能力要求 DB15/T 1875 政务信息资源代码规范 DB15/T 2240.1 政务与社会数据融合治理 第1部分：总体要求 3 术语和定义 DB15/T 2240.1-2021 界定的以及下列术语和定义适用于本文件。 3.1 数据资源代码 data resource code 用于唯一标识政务数据资源的一组字符。 3.2 顺序码 sequential code 由阿拉伯数字或拉丁字母的先后顺序来标识编码对象的代码。 4 缩略语 下列缩略语适用于本文件。 HTTP：超文本传输协议(Hypertext Transfer Protocol) HTTPS：超文本传输安全协议(Hyper Text Transfer Protocol over SecureSocket Layer Hyper Text Transfer Protocol over SecureSocket Layer) REST：表述性状态传递(Representational State Transfer) SOAP：简单对象访问协议(Simple Object Access Protocol) Utf-8：针对Unicode的可变长度字符编码(Universal Character Set/Unicode Transformation Format) WSDL：网络服务描述语言(Web Services Description Language) 1 DB15/T 2240.2—2021 5 服务接口 5.1 概述 服务接口是政务数据资源或社会数据资源提供方和政务信息资源需求方通过数据融合治理平台或 第三方数据共享交换平台实现数据资源交换或功能调用的中间件。服务接口适用于实时性和灵活性要求 较高的数据交换。 5.2 服务接口设计原则 服务接口设计的基本原则包括但不限于： ——安全性原则：应提供多种安全可靠的技术手段，保证接口数据的安全； ——开放性原则：应采用通用的接口设计标准，保证与其他系统的互联互通； ——灵活性原则：应能根据业务变化，灵活调整接口容量与性能； ——松耦合原则：应避免提供方的业务系统对接口服务实现的依赖性； ——可审计原则：应提供支持多种规则，实现对服务接口使用情况形成全面准确日志审计的功能。 5.3 服务接口基本要求 5.3.1 接口名称 接口名称应采用中文名称，由提供方名称、数据资源名称和接口分类三部分组成。政务数据提供方 名称宜使用国家规定的部门简称，如内蒙古自治区民政厅简称为自治区民政厅。 5.3.2 接口分类 服务接口分为查询类、验证类、下载类、数据传输类及其他类，接口分类代码见表1。 表1 服务接口分类代码 代码 分类名称 1 查询类 2 验证类 3 下载类 4 数据传输类 5 其他类 5.3.3 服务接口代码 服务接口代码由接口提供方代码、数据资源代码、接口分类代码和接口顺序码四部分组成，代码结 构见图1。 2 DB15/T 2240.2—2021 X XXXXXXXXXXXXXXXXXXXXXXXX X XX 2位接口顺序吗 1位接口分类代码 24位数据资源代码 1位接口提供方代码 图1 服务接口代码结构 5.3.3.1 接口提供方代码 接口提供方代码，使用 1 位大写英文字母表示，“T”标识资源提供方开发接口，“P”标识共享 交换平台统一开发接口。 5.3.3.2 数据资源代码 提供政务数据资源，数据资源代码使用24位阿拉伯数字表示，采用DB15/T 1875规定的政务数据资 源代码结构。提供社会数据资源，数据资源代码使用24位阿拉伯数字表示，其中前18位为对应企业或组 织的统一社会信用代码，后6位由提供方自行定义。 5.3.3.3 接口分类代码 接口分类代码，使用1位阿拉伯数字表示，编码范围为1～5，分类代码见5.3.2。 5.3.3.4 接口顺序码 接口顺序码，使用2位阿拉伯数字表示，用于标识同一接口分类下的接口顺序，编码范围为01～99。 5.3.4 服务接口技术要求 服务接口技术要求包括但不限于： a) 服务传输协议：应符合 HTTP/HTTPS 1.0/1.1/2.0 标准； b) 服务消息协议：WebService 服务消息封装应符合 SOAP 1.1/1.2 标准；REST 服务消息封装应 符合 HTTP 1.0/1.1/2.0 标准； c) 服务描述要求：服务描述的内容格式应符合 WSDL 1.1/2.0、SOAP 1.1/1.2 标准。 5.3.5 服务接口开发要求 服务接口包括数据融合治理平台或第三方数据共享交换平台和提供方开发的接口。平台开发的接口 应由需求方提出申请，提供方提供系统IP地址、用户名、密码、接口功能名称等信息，并由平台接口开 发人员编写需求文档。 服务接口开发要求包括但不限于： a) 接口名称：接口的中文名称应符合 5.3.1 的规定； b) 接口方式：一般包括 WebService 和 REST 两种方式，若为 REST 方式，应标明 REST 操作； c) 接口方法：命名应采用大小写混合的形式，以小写字母开头，名称中其他单词的首字母以大 写字母开头，不宜使用下划线分割单词； 3 DB15/T 2240.2—2021 d) e) f) g) 接口测试：接口应对共享交换平台开放测试权限，并提供测试用例； 接口授权：提供方授权的接口应明确管控参数 ApiKey； 接口参数： 1) REST 类型的服务接口，仅允许在 Header 里传入授权验证相关的参数，不允许使用数据融 合治理平台或第三方数据共享交换平台保留的参数名 AppKey、AppSecret、ApiKey、 ApiSecret，POST 方式的接口支持在 Body 中传递 Application/JSON 格式的参数； 2) WebService 类型的服务接口，不允许在 Header 传递参数，应在 Body 中进行传递； 3) 传递参数为中文字符时，应采用 Utf-8 编码。 返回数据： 1) 接口注册时应标明接口的返回格式； 2) 返回数据应采用固定的格式封装，一般为 xml、JSON 等； 3) 接口调用不通过，可通过返回码返回数据，接口调用返回码定义见附录 A。 5.3.6 服务接口发布要求 服务接口发布时，要准确填写接口描述信息。接口描述信息包括但不限于接口概述、接口名称、接 口分类、接口方式、接口地址、接口授权、接口方法、输入输出参数，以及接口实例。接口主要描述信 息填写要求包括但不限于： a) 接口概述：应描述出接口的提供方和功能； b) 接口授权：应明确服务授权方，服务授权方包括共享交换平台和提供方； c) 输入参数：针对每个接口方法，应给出参数名、参数说明、类型、约束等输入信息； d) 输出参数：针对每个接口方法，应给出返回值格式等输出信息； e) 接口实例：提供方应提供服务接口实例，并标注返回参数含义等信息； f) 数据留存声明：提供方提供数据时，对调用方是否可以留存数据，以及对留存数据管理要求 应进行明确。 5.3.7 服务接口更新 提供方若因业务变更，需对交换数据进行变更时，应在不影响使用的原则下对已发布的服务接口更 新，接口更新时应保留原版本。服务接口更新要求包括但不限于： a) 应提前在本级共享交换平台进行更新备案，说明服务更新的计划停止时间、重新启动时间、 变更内容等； b) 应避免在工作时间内进行服务接口更新； c) 应避免变更输入、输出参数。 5.3.8 授权验证 应通过数据融合治理平台或第三方数据共享交换平台分配的接口密钥、访问令牌等方式对调用服务 申请进行授权验证。 6 服务接口基本能力要求 6.1 能力概述 服务接口作为政务数据或社会数据提供方和数据资源需求方通过数据融合治理平台或第三方数据 共享交换平台实现数据资源的交换或功能调用的中间件，应以开放、共享、方便、便捷为设计原则，需 具备多种数据源发布及服务的能力。 4 DB15/T 2240.2—2021 6.2 能力分类 服务接口基本能力应至少满足以下三类： a) 接口发布能力； b) 文件发布能力； c) 数据集发布能力。 6.3 接口发布能力要求 6.3.1 功能性要求 接口发布能力应需具体以下功能： a) 支持接入 Webservice、RESTful 方式的接口； b) 支持包括 HTTP 1.0、HTTP1.1、HTTP2.0、HTTPS1.0、HTTPS1.1 、HTTPS2.0 标准传输协议的 接口； c) 请求方式应满足 GET、POST、DELETE，并接口协议中需要明确标识请求方式； d) 支持接口编排，轻松实现多个接口的功能集成； e) 提供图形化管理界面，用于接口数据存储位置、操作用户、目标存储位置的配置； f) 应提供完善的日志和审计能力，可以记录接口数据配置及数据抽取操作配置、运行时发生的 各种事件； g) 应具备限制机制，保证服务整体可用，是接口访问异常情况下的处理策略； h) 支撑接口认证安全机制，确保接口访问应是在接口认证成功情况下访问。 6.3.2 性能效率要求 接口发布能力应满足以下性能效率要求： a) 数据写入速率：在千兆带宽的网络条件下,数据抽取吞吐量不少于 30 MB/秒； b) 操作并发数：并发数大于 200 个/秒； c) 具备良好的可扩展性。 6.4 文件发布能力要求 6.4.1 功能性要求 文件发布能力应满足以下基本功能要求： a) 至少支持 HTTP、HTTPS、FTP、SFTP 多种传输协议； b) 应支持顺序型断点续传功能，支持外部文件存储断点续传能力的自动识别及模式匹配； c) 应支持文件压缩传输，提供文件压缩规则设置； d) 应支持文件加密传输，提供文件加密传输规则设置； e) 应支持设置文件同步、异步拉取，支持设置拉取并行度； f) 应支持指定目标文件存储位置、文件名，提供文件类型转换规则，支持常见类型转换； g) 应支持全量文件采集，支持外部数据一次性初始化导入； h) 应支持定时轮询文件采集，采集新增的文件，支持文件列表规则过滤； i) 应支持图形管理功能，支持连接配置、文件源配置、文件目标存储配置、文件压缩和加密传 输规则配置、文件同步/异步传输规则配置、文件传输并行度配置、文件定时及实时策略配置、 文件采集过滤配置； j) 应支持顺序型断点续传功能； k) 应支持对接收文件的完整性校验； 5 DB15/T 2240.2—2021 l) 应支持对客户端进行认证。 6.4.2 性能效率要求 文件发布能力应满足以下性能效率要求： a) 在千兆带宽的网络条件下，数据抽取吞吐量不少于 50 MB/秒； b) 具备良好的可扩展性； c) 具备限制机制。 6.5 数据集发布能力要求 6.5.1 功能性要求 数据集发布能力应满足以下功能要求： a) 支持结构化、半结构化及非结构化数据集的发布能力； b) 结构化数据集支持对主流的关系数据库进行数据服务的抽取及发布；支持对数据库中常用的 数据类型进行数据抽取，至少包括数值型、字符型、日期/时间型等数据类型； c) 支持“全量”和“定制”两种发布模式；“全量”模式是指一次性将数据提供方提供的数据 集通过共享交换平台需求方提供服务。“定制”模式是指根据需求方的数据需求条件筛选数据 集提供方符合条件的数据进行服务； d) 支持立即执行、定时调度运行。定时调度运行应提供多种调度策略，至少包括固定时间间隔 运行、指定时间点运行、指定时间范围运行、一次或指定次数运行等策略； e) 应提供图形化管理界面，应提供数据集模式设置、数据集提供者、提供方式、服务者、服务 方式以及运行策略配置等操作界面； f) 应提供完善的日志和审计能力，可以记录数据集操作配置、运行时发生的各种事件； g) 应提供完善的监控机制，运行过程中出现异常可快速的定位及解决。 6.5.2 性能效率要求 数据集发布能力应满足以下性能效率要求： a) 对于结构化数据集处理速度：不少于 5000 条/秒； b) 对于非结构化数据集处理速度：在千兆带宽的网络条件下，数据抽取吞吐量不少于 100 MB/ 秒。 7 服务接口对接流程 基于数据融合治理平台或第三方数据共享交换平台的服务接口对接流程： a) 提供方整理可共享交换的资源，完成资源目录的编目与报送； b) 提供方在数据融合治理平台或第三方数据共享交换平台完成资源发布； c) 需求方通过数据融合治理平台或第三方数据共享交换平台进行检索，对所需的资源进行申请： 1) 对于无条件共享的资源，需求方在数据融合治理平台或第三方数据共享交换平台备案后 获取资源； 2) 对于有条件共享的资源，需由提供方进行审核，审核通过后完成资源获取。 d) 提供方通过数据融合治理平台或第三方数据共享交换平台以接口交换方式提供需求方所需资 源； e) 需求方获取资源； f) 需求方对获取资源进行校验及反馈： 6 DB15/T 2240.2—2021 1) 若提供资源与所需资源一致，需求方可直接获取使用； 2) 若提供资源与所需资源不一致，需求方应通过共享交换平台提交纠错意见，并提供政务信 息资源目录、信息资源格式类型、信息资源名称、问题描述、联系人、联系电话、联系人 邮箱等信息，提供方通过数据融合治理平台或第三方数据共享交换平台查看纠错意见，并 将意见反馈给需求方，需求方可重新申请资源。 8 服务接口使用流程 服务接口使用流程包括但不限于： ——资源发布：  提供方登录数据融合治理平台或第三方数据共享交换平台，按照服务注册要求填报注册信 息；  注册完成后，数据融合治理平台或第三方数据共享交换平台审核通过后发布服务接口，并 实现代理运行。 ——接口申请：  需求方通过数据融合治理平台或第三方数据共享交换平台的服务接口列表、分类检索和接 口搜索等功能进行服务信息的查找，获得服务接口注册信息；  需求方对资源进行申请，填写申请部门、申请时间、调用频率、用途说明等相关信息，获 取授权。 ——接口授权：对于需求方提交的服务接口申请，提供方对其进行授权； ——接口调用：获得授权后，需求方使用授权码进行服务接口调用。 9 服务接口安全要求 服务接口安全性要求应符合GB/T 35274中规定的数据服务接口安全能力要求。 10 服务接口审计要求 服务接口的审计要求包括但不限于： a) 应明确可用的审计规则； b) 明确审计的流程及记录信息的内容； c) 审计信息的准确性是可审核的； d) 具备指定专门用户负责审计日志信息查阅的功能； e) 审计信息可按照用户指定的周期进行备份。 7 DB15/T 2240.2—2021 A A 附 录 A （规范性） 接口调用返回码定义 服务接口调用返回码定义见表A.1。 表A.1 接口调用返回码定义 序号 返回码 1 200 请求成功，请求所希望的响应头或数据体将随此响应返回。 2 300 请求失败，程序执行异常或失败，无法返回正确的响应结果。 3 400 错误请求。 4 403 请求成功，服务器已经理解请求，但无权限而拒绝执行它。 5 404 请求失败，请求所希望得到的资源未被在服务器上发现。 6 500 请求失败，服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。 7 504 请求超时。 8 返回码描述 DB15/T 2240.2—2021 参 考 文 献 [1] 《政务信息资源共享管理暂行办法》（国发〔2016〕51号） [2] 《政务信息系统整合共享实施方案》（国办发〔2017〕39 号） [3] 《内蒙古自治区政务信息资源共享管理暂行办法》（内政发〔2018〕23号） 9