ICS 35.240 CCS L 67 41 河南省 地方标准 DB41/T 2735—2024 综合法人库数据服务和应用接口规范 2024 - 08 - 26发布 2024 - 11 - 25实施 河南省市场监督管理局 发布 DB41/T 2735—2024 I 目次 前言 ................................ ................................ ................. II 1 范围 ................................ ................................ ............... 1 2 规范性引用文件 ................................ ................................ ..... 1 3 术语和定义 ................................ ................................ ......... 1 4 缩略语 ................................ ................................ ............. 1 5 设计原则 ................................ ................................ ........... 1 6 技术要求 ................................ ................................ ........... 2 7 开发要求 ................................ ................................ ........... 2 8 发布要求 ................................ ................................ ........... 2 9 安全和审计要求 ................................ ................................ ..... 2 附录A（规范性） 接口调用返回码 ................................ ....................... 4 DB41/T 2735 —2024 II 前言 本文件按照 GB/T 1.1 —2020《标准化工作导则 第1部分：标准化文件的结构和起草规则》的规定 起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本文件由河南省行政审批和政务信息管理局提出。 本文件由河南省大数据标准化技术委员会 （HN/TC 26）归口。 本文件起草单位： 正数网络技术有限公司、 河南省政务大数据中心、 河南省平台经济发展指导中心。 本文件主要起草人：郭强、张震、杨帆、 申光宇、岳正飞、周旭阳、张祥、贾吴帆、时洪飞、孟祥 宾、张夏雯。 DB41/T 2735 —2024 1 综合法人库数据服务和应用接口规范 1 范围 本文件规定了综合法人库数据服务和应用接口的设计原则、技术要求、开发要求、发布要求、安全 和审计要求。 本文件适用于省、市综合法人库服务和应用接口的设计、开发和实施。 2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。 其中， 注日期的引用文件， 仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的 修改单）适用于本 文件。 GB/T 22239 —2019 信息安全技术 网络安全等级保护基本要求 GB/T 35273 —2020 信息安全技术 个人信息安全规范 3 术语和定义 下列术语和定义适用于本文件。 3.1 接口 信息系统为开放特定业务功能而发布的可供其他系统调用的应用编程函数。 [来源：GB/T 42877 —2023，3.2] 3.2 服务 提供给用户并满足其应用需求的有形或无形的活动。 [来源：GB/T 34077.5—2020，3.1] 4 缩略语 下列缩略语适用于本文件。 JSON ：JavaScript 对象简谱 （JavaScript Object Notation ） REST ：表述性状态传递 （Representational State Transfer ） UTF-8：针对Unicode的可变长度字符编码 （8-bit Unicode Transformation Format ） XML ：可扩展标记语言 （Extensible Markup Language ） 5 设计原则 设计原则包括但不限于以下原则： a) 安全性原则：应提供多种安全可靠的技术手段，保证接口数据的安全； b) 开放性原则：应采用通用的接口设计标准， 保证与其他系统的互联互通； DB41/T 2735 —2024 2 c) 稳定性原则：应保证接口稳定，避免频繁的修改和不必要的改动； d) 松耦合原则：应避免提供方的业务系统对接口服务实现的依赖性； e) 可审计原则： 应提供支持多种规则， 实现对服务接口使用情况形成全面准确的日志审计功能。 6 技术要求 接口技术要求包括但不限于： a） 应采用HTTP/HTTPS 作为传输协议； b） 应采用JSON或XML作为消息的封装格式； c） 应提供服务请求成功、失败等各种情况的调用返回码； d） 应支持对请求的合法性和数据进行验证。 7 开发要求 开发的接口应由需求方提出申请，提供方提供接口地址、用户名、密码、接口功能名称等信息，并 由接口开发人员编写需求文档。 接口开发要求包括但不限于： a） 接口命名：应采用大小写混合的形式，以小写字母开头，名称中其他单词的首字母以大写字母 开头，不宜使用下划线分割单词； b） 接口方式：一般包括 Web Service 和REST两种方式。若为 REST方式，应标明 REST操作； c） 接口测试：接口应提供开放测试权限，并提供测试用例； d） 接口参数： REST类型的服务接口，应在 Header里传入授权验证相关的参数； Web Service 类型 的服务接口，应在 HTTP的Body中进行传递。传递参数为中文字符时，应以 UTF-8编码； e） 返回数据： 应采用固定的格式封装返回数据， 一般为 XML、JSON等；异常时应返回调用返回码， 定义见附录 A。 8 发布要求 接口发布时，要准确填写接口描述信息。接口发布应包括但不限于： a） 接口概述：应正确描述出接口的提供方和功能； b） 接口授权：应明确服务与应用授权方； c） 输入参数：每个接口应给出参数名、参数说明、类型、约束等输入信息； d） 输出参数：每个接口应给出返回值格式； e） 接口实例：提供方应提供服务接口实例，并标注返回参数含义等信息； f） 数据留存声明：提供方应明确调用方是否可以留存数据，以及对留存数据的管理要求。 9 安全和审计要求 安全要求 9.1 安全应符合 GB/T 22239 —2019、GB/T 35273 —2020的规定。 审计要求 9.2 DB41/T 2735 —2024 3 接口的审计要求包括但不限于： a) 应明确可用的审计规则； b) 应明确审计的流程及记录信息的内容； c) 审计信息是可审核的，并按照周期进行备份； d) 应具有指定专门用户负责审计日志信息查阅的功能。 DB41/T 2735 —2024 4 A A 附录 A （规范性） 接口调用返回码 接口调用返回码定义见表 A.1。 表A.1 接口调用返回码定义 序号 返回码 返回码描述 1 200 请求成功，请求所希望的响应头或数据体将随此响应返回 2 300 请求失败，程序执行异常或失败，无法返回正确的响应结果 3 400 错误请求 4 403 请求成功，服务器已经理解请求，但无权限而拒绝执行它 5 404 请求失败，请求所希望得到的资源未被在服务器上发现 6 500 请求失败 ，服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理 7 504 请求超时