DB52/T 1541.4-2021 政务数据平台 第4部分：接口规范

ICS01.040.03

A12

DB52

贵州省地方标准

DB52/T1541.4—2021

政务数据平台第4部分：接口规范

Governmentdataplatform——Part4：Interfacespecification

2021-05-17发布2021-09-01实施

贵州省市场监督管理局发布

DB52/T1541.4—2021

目  次

前  言II

1范围1

2规范性引用文件1

3术语和定义1

4缩略语2

5基本要求2

6接口组成2

7接口要求3

8接口安全9

附录A（资料性）认证授权服务接口JSONSchema示例10

附录B（资料性）组织新增接口JSONSchema示例11

附录C（资料性）用户新增接口JSONSchema示例12

附录D（资料性）数据资源目录接口的接口信息JSONSchema示例13

附录E（资料性）数据资源目录接口信息描述对象参数表15

附录F（资料性）数据资源目录接口的目录信息JSONSchema描述示例16

附录G（资料性）数据资源目录描述对象参数表18

附录H（资料性）政务数据平台接口返回JSONSchema示例19

附录I（资料性）政务数据平台接口返回参数表21

I

DB52/T1541.4—2021

前言

本文件按照GB/T1.1-2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起

草。

本文件是DB52/T1541的第4部分。DB52/T1541已经发布一下部分：

——第2部分：数据归集规范；

——第3部分：数据存储规范；

——第4部分：接口规范；

——第6部分：面向全网搜索应用的数据处理规范。

请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。

本文件由贵州省大数据发展管理局提出并归口。

本文件起草单位：贵州省机械电子产品质量检验检测院、贵州中软云上数据技术服务有限公司、贵

州省信息中心、贵州省量子信息和大数据应用技术研究院。

本文件主要起草人：朱小洪、宿睿智、刘彦嘉、王嘉卉、徐凯琳、田野、秦晓东、邵建平、

潘伟杰、韩朱旸、冯丹妮、尚志刚、杨昶、李怡然、吴明娅、石睿、曾映菊、唐昶、张洋、姚茂峰、

陆莹、孙瑾。

II

DB52/T1541.4—2021

政务数据平台第4部分：接口规范

1范围

本文件规定了政务数据平台数据接口的术语和定义、缩略语、基本要求、接口组成、接口要求和接

口安全。

本文件适用于政务数据平台接口的设计和应用。

2规范性引用文件

本文件没有规范性引用文件。

3术语和定义

下列术语和定义适用于本文件。

3.1

接口interface

基于应用程序的服务能力封装成接口，并通过API网关开放给客户端调用。

3.2

数据data

对事实、概念或指令的一种形式化表示，适用于以人工或自动方式进行通信、解释或处理。

[来源：DB52/T1239.1-2017，3.1]

3.3

政务数据资源目录directoryofgovernmentdataresources

通过对政务数据资源依据规范的元数据描述，按照一定的分类方法进行排序和编码的一组信息,用

以描述各个政务数据资源的特征，以便于对政务数据资源的检索、定位与获取。

3.4

政务数据提供方governmentdataprovider

基于统一数据共享交换平台，利用各种技术向其他政务部门、事业单位、企业或公众提供政务数据

的实体。

1

DB52/T1541.4—2021

3.5

访问令牌accesstoken

访问控制操作主体的系统对象。

4缩略语

下列缩略语适用于本文件。

API：应用程序编程接口（ApplicationProgrammingInterface）

HTTP：超文本传输协议（HyperTextTransferProtocol）

HTTPS：超文本传输安全协议（HyperTextTransferProtocoloverSecureSocketLayer）

JSON：轻量级的数据交换格式（JavascriptObjectNotation）

REST：一种网络应用程序的设计风格和开发方式（RepersentationalStateTransfer）

5基本要求

5.1应采用HTTP/HTTPS作为传输协议。

5.2应采用JSON作为消息的封装格式。

5.3应提供服务请求成功、失败等各种情况的接口返回状态码。

5.4应支持跨语言、跨操作系统调用。

6接口组成

政务数据平台接口主要包括：认证授权服务接口、组织接口、用户接口、数据资源目录接口。政务

数据平台接口组成见图1。

图1政务数据平台接口组成图

2

DB52/T1541.4—2021

7接口要求

7.1认证授权服务接口

接口描述：政务数据提供方接入政务数据平台应调用认证授权服务接口。通过平台认证授权服务接

口进行身份验证，验证成功后接口返回的授权访问令牌，政务数据提供方操作政务数据平台接口应携带

访问令牌，进行正常会话交互。

接口地址：/api/auth_service。

接口类型：post。

请求参数：认证授权服务接口请求参数见表1。

请求示例：见附录A。

返回参数：见附录I表I.1。

返回示例：见附录H。

表1认证授权服务接口请求参数表

参数名称类型是否必填说明

access_keystring是政务数据平台分配给政务数据提供方的唯一标识

access_secretstring是政务数据平台分配给政务数据提供方的密钥

usernamestring是政务数据平台分配给政务数提供方的用户账户名称

passwordstring是政务数据平台分配给政务数据提供方的用户账户密码

7.2组织接口

7.2.1组织新增接口

接口描述：政务数据提供方调用政务数据平台组织新增接口，获取政务数据平台返回的组织ID，根

据组织ID进行政务数据提供方系统和政务数据平台交互。

接口地址：/api/add/organization。

接口类型：post。

请求参数：同步组织机构请求参数见表2。

请求示例：见附录B。

返回参数：见附录I表I.1。

返回示例：见附录H。

表2同步组织机构请求参数表

参数名称类型是否必填说明

addTypeint是操作类型：1表示新增

trustNoint是统一社会信用代码

groupShortNamestring是组织简称

groupNamestring是组织名称

regionNamestring是组织所属地区

orgPostNoint是组织区划编号

group_levelint是级别：401省直，402市州

super_orgint是父级组织编号

3

DB52/T1541.4—2021

7.2.2组织编辑接口

接口描述：编辑组织机构信息。

接口地址：/api/add/organization。

接口类型：post。

请求参数：组织机构编辑请求参数见表3。

请求示例：见附录B。

返回参数：见附录I表I.1。

返回示例：见附录H。

表3组织机构编辑请求参数表

参数名称类型是否必填说明

addTypeint是操作类型：2表示编辑

trustNoint是统一社会信用代码

groupShortNamestring是组织简称

groupNamestring是组织名称

regionNamestring是组织所属地区

orgPostNoint是组织区划编号

group_levelint是级别：401省直，402市州

super_orgint是父级组织编号

7.2.3组织查询接口

接口描述：政务数据提供方查询政务组织机构信息。

接口地址：/api/organization/query。

接口类型：get。

请求参数：组织机构查询接口请求参数见表4。

请求示例：http://ip+port/api/organization/query?org_name=组织名称

&org_id=z6lqTzG3PTPpQIE92Bs0pA3PSyVJmlWM。

返回参数：见附录I表I.1。

返回示例：见附录H。

表4组织机构查询接口请求参数表

参数名称类型是否必填说明

org_idstring是组织id

org_namestring是组织名称

7.3用户接口

7.3.1用户新增接口

接口描述：政务数据提供方调用用户新增接口，同步组织机构用户信息到政务数据平台。

接口地址：/api/add/user。

接口类型：post。

请求参数：组织机构用户新增请求参数见表5。

4

DB52/T1541.4—2021

请求示例：见附录C。

返回参数：见附录I表I.1。

返回示例：见附录H。

表5组织机构用户新增请求参数表

参数名称类型是否必填说明

org_idstring是组织id

addTypeint是操作类型：1表示新增

userNamestring是用户名

trueNamestring是用户真实姓名

roIdsstring否用户角色

mobilestring是联系电话

7.3.2用户编辑接口

接口描述：政务数据提供方编辑政务组织机构用户信息。

接口地址：/api/add/user。

接口类型：post。

请求参数：组织机构用户编辑请求参数见表6。

请求示例：见附录C。

返回参数：见附录I表I.1。

返回示例：见附录H。

表6组织机构用户编辑