DB41T 2735-2024综合法人库数据服务和应用接口规范.docx
ICS35.240CCSL67
41
河南省地方标准
DB41/T2735—2024
综合法人库数据服务和应用接口规范
2024-08-26发布2024-11-25实施
河南省市场监督管理局发布
DB41/T2735—2024
I
目次
前言 II
1范围 1
2规范性引用文件 1
3术语和定义 1
4缩略语 1
5设计原则 1
6技术要求 2
7开发要求 2
8发布要求 2
9安全和审计要求 2
附录A(规范性)接口调用返回码 4
DB41/T2735—2024
II
前言
本文件按照GB/T1.1—2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。
本文件由河南省行政审批和政务信息管理局提出。
本文件由河南省大数据标准化技术委员会(HN/TC26)归口。
本文件起草单位:正数网络技术有限公司、河南省政务大数据中心、河南省平台经济发展指导中心。
本文件主要起草人:郭强、张震、杨帆、申光宇、岳正飞、周旭阳、张祥、贾吴帆、时洪飞、孟祥宾、张夏雯。
DB41/T2735—2024
综合法人库数据服务和应用接口规范
1范围
本文件规定了综合法人库数据服务和应用接口的设计原则、技术要求、开发要求、发布要求、安全和审计要求。
本文件适用于省、市综合法人库服务和应用接口的设计、开发和实施。
2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T22239—2019信息安全技术网络安全等级保护基本要求
GB/T35273—2020信息安全技术个人信息安全规范
3术语和定义
下列术语和定义适用于本文件。
3.1
接口
信息系统为开放特定业务功能而发布的可供其他系统调用的应用编程函数。
[来源:GB/T42877—2023,3.2]3.2
服务
提供给用户并满足其应用需求的有形或无形的活动。
[来源:GB/T34077.5—2020,3.1]
4缩略语
下列缩略语适用于本文件。
JSON:JavaScript对象简谱(JavaScriptObjectNotation)
REST:表述性状态传递(RepresentationalStateTransfer)
UTF-8:针对Unicode的可变长度字符编码(8-bitUnicodeTransformationFormat)
XML:可扩展标记语言(ExtensibleMarkupLanguage)
5设计原则
设计原则包括但不限于以下原则:
a)安全性原则:应提供多种安全可靠的技术手段,保证接口数据的安全;
b)开放性原则:应采用通用的接口设计标准,保证与其他系统的互联互通;
1
DB41/T2735—2024
c)稳定性原则:应保证接口稳定,避免频繁的修改和不必要的改动;
d)松耦合原则:应避免提供方的业务系统对接口服务实现的依赖性;
e)可审计原则:应提供支持多种规则,实现对服务接口使用情况形成全面准确的日志审计功能。
6技术要求
接口技术要求包括但不限于:
a)应采用HTTP/HTTPS作为传输协议;
b)应采用JSON或XML作为消息的封装格式;
c)应提供服务请求成功、失败等各种情况的调用返回码;
d)应支持对请求的合法性和数据进行验证。
7开发要求
开发的接口应由需求方提出申请,提供方提供接口地址、用户名、密码、接口功能名称等信息,并由接口开发人员编写需求文档。
接口开发要求包括但不限于:
a)接口命名:应采用大小写混合的形式,以小写字母开头,名称中其他单词的首字母以大写字母开头,不宜使用下划线分割单词;
b)接口方式:一般包括WebService和REST两种方式。若为REST方式,应标明REST操作;
c)接口测试:接口应提供开放测试权限,并提供测试用例;
d)接口参数:REST类型的服务接口,应在Header里传入授权验证相关的参数;WebService类型的服务接口,应在HTTP的Bod