DB44/T 2167.3-2019 广东省电子证照技术规范 第3部分：接口规范

ICS35.240.01

L67

DB44

广东省地方标准

DB44/T2167.3—2019

广东省电子证照技术规范

第3部分：接口规范

Electroniccertificatetechnicalspecification

Part3:Interfacespecification

2019-07-12发布2019-10-01实施

广东省市场监督管理局发布

DB44/T2167.3—2019

目次

前言II

1范围1

2系统接口概述1

2.1接口组成1

2.2接口技术要求1

2.3接口使用1

3接口模型及参数2

3.1请求模型2

3.2返回模型3

3.3接口参数4

附录A（规范性附录）接口及其参数说明5

附录B（规范性附录）公共参数及数据类型22

附录C（规范性附录）错误分类代码27

参考文献30

I

DB44/T2167.3—2019

前言

DB44/T2167《广东省电子证照技术规范》分为4个部分：

——第1部分：总体构架；

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

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

——第4部分：应用与技术管理要求。

本部分为DB44/T2167的第3部分。

本部分按照GB/T1.1-2009给出的规则起草。

本部分的附录A、附录B、附录C为规范性附录。

本部分由广东省工业和信息化厅提出。

本部分由广东省信息技术标准化技术委员会归口。

本部分的主要起草单位：工业和信息化部电子第五研究所、广东省信息中心、广东省标准化研究院。

本部分主要起草人：周春华、王贵虎、王韬、丁曙初、马晓镌、梁宏、何铤、肖晓赟、黎东初。

II

DB44/T2167.3—2019

广东省电子证照技术规范

第3部分：接口规范

1范围

DB44/T2167的本部分规定了其他电子政务系统与电子证照系统进行对接的接口规范。

本部分适用于与政务电子证照系统的对接。

2系统接口概述

2.1接口组成

电子证照系统应包括电子证照目录查询接口、电子证照信息管理接口、安全会话接口和用证服务

接口。

a)电子证照目录查询接口

应提供电子证照全省目录、地区和部门应开通目录查询功能。

b)证照信息管理接口

应提供电子证照制证、签发、更新、废止等功能。

c)安全会话接口

应提供对接入应用和用户身份进行合法性验证等功能。

d)用证服务接口

应提供对电子证照进行查询、调用和有效性、归档等功能。

2.2接口技术要求

a)采用基于WebService技术服务接口；

b)接口的请求和返回结果采用JSON格式；

c)应支持跨系统、跨平台调用；

d)传输的数据应采用加密和防篡改技术保证数据的完整有效性。

2.3接口使用

接口使用前，应对使用接口的应用系统进行身份认证，确保访问接口的应用都经过授权。认证方式

可采用app_key和app_secret方式或CA证书方式。以下给出app_key和app_secret认证方式接口使用可参

考流程：

1

DB44/T2167.3—2019

其他电子政务系统电子证照系统

1注册和申请授权

2返回app_key和app_secret

以和

3app_keyapp_secret

为参数调用登录接口

4返回access_token

5带access_token参数数据访问

6返回相应数据

7结束调用

图1接口使用流程图

1)其他电子政务系统向电子证照系统进行应用注册和申请授权；

2)审核通过后返回应用唯一标识（app_key）和密钥（app_secret）；

3)其他电子政务系统调用登录接口，在参数中加入app_key和app_secret，创建会话；

4)电子证照系统返回接入令牌（access_token）；

5)在会话有效期内通过加入access_token参数进行接口调用；

6)电子证照系统返回相应数据；

7)会话超时或通过注销接口结束调用。

3接口模型及参数

3.1请求模型

2

DB44/T2167.3—2019

图2接口请求模型数据结构

接口请求模型（RequestModel）由接口名称（InterfaceName）、请求参数集（RequestParameterSet）、

附件集（AttachmentSet）组成，实线连接内容为必选项，虚线连接内容为可选项。

——接口名称。

接口名称指定将要调用的接口。

——参数集。

结构化请求参数集，登录接口必须包含app_key和app_secret，其它接口必须至少包含请求

公共参数。每个参数由参数名（Name）和参数值（Value）、参数类型（Type）组成。

——附件集

不含或含一个及以上附件。每个附件由附件名（Name）、附件链接地址（URL）、附件类型（Type）、

附件内容（Content）和附件描述（Despription）组成，附件链接地址和附件内容至少包含一项。

3.2返回模型

3

DB44/T2167.3—2019

图3接口返回模型数据结构

接口返回模型（ResponseModel）由返回结果参数集（ResponseParameterSet）、附件集

（AttachmentSet）组成。

——返回结果参数集

结构化的返回结果参数集，应至少包括返回公共参数。每个参数由参数名（Name）和参数值

（Value）、参数类型（Type）组成。

——附件集

附件集为可选内容，不含或含一个以上附件，定义与接口请求模型相同。

3.3接口参数

接口的具体请求和返回参数应符合附录A要求。请求公共参数和返回公共参数应符合附录B.1要求。

4

DB44/T2167.3—2019

附录A

（规范性附录）

接口及其参数说明

A.1安全会话接口

A.1.1登录

登录是接口系统调用的第一个方法。通过调用登录接口进行身份验证，验证成功后创建一个会话，

所有对数据和附件的管理操作都必须在有效的会话内进行，会话应有失效时间。此接口不包含公用参数。

请求参数：

表A.1登录请求参数

参数名是否必选类型说明

app_key是String分配给应用程序的唯一标识app_key

app_secret是String分配给应用程序的密钥app_secret

account是String用户账户名称

password是String用户账户密码

org_code否String以指定的部门管理员身份登录

返回结果：

表A.2登录返回结果参数

参数名是否必选类型说明

ack_code是String成功：SUCCESS，失败FAILURE

errors是String无错误时为空，有错误返回错误信息

access_token是String登录成功则返回安全会话访问令牌（一天有效）

A.1.2注销

注销当前会话。

请求参数：

无。（仅包含请求公共参数）

返回结果：

无。（仅包含返回公共参数）。

A.1.3获取当前已登录用户信息

获取当前已登录用户的信息。

请求参数：

5

DB44/T2167.3—2019

无。（仅包含请求公共参数）

返回结果：

表A.3注销返回结果参数

参数名是否必选类型说明

data是UserInfo用户信息

A.2电子证照目录接口

A.2.1查询全省目录

列举出全省目录清单。

请求参数：

表A.4查询全省目录请求参数

参数名是否必选类型说明

page_index否Integer返回第几页数据。默认值1

page_size否Integer返回数据的每页大小。默认值10，最大值150

keyword否String查询关键字（证照名称，目录编制部门）

status否LicenseItemStatus证照状态（默认查询已发布，多个时中间以逗号（,）分割）

is_open否Boolean开通状态（默认已开通）

注：为兼容现有系统，在接口参数中，使用license英文单词替代certificate使用，下同。

返回结果：

表A.5查询全省目录返回结果

参数名是否必选类型说明

data是List<LicenseItem>证照目录

A.2.2查询地区应开通目录

列举出一个地区的应用开通目录清单。

请求参数：

表A.6查询地区应开通目录请求参数

参数名是否必选类型说明

page_index否Integer返回第几页数据。默认值1

page_size否Integer返回数据的每页大小。默认值10，最大值150

keyword否String查询关键字（证照名称，目录编制部门）

is_service否Boolean纳入情况

返回结果：

6

DB44/T2167.3—2019

表A.7查询地区应开通目录返回结果

参数名是否必选类型说明

data是List<LicenseItem>证照目录

A.2.3查询部门应开通目录

列举出一个部门的应用开通目录清单。

请求参数：

表A.8查询部门应开通目录请求参数

参数名是否必选类型说明

page_index否Integer返回第几页数据。默认值1

page_size否Integer返回数据的每页大小。默认值10，最大值150

keyword否String查询关键字（证照名称，目录编制部门）

is_service否Boolean纳入情况

返回结果：

表A.9查询部门应开通目录返回结果

参数名是否必选类型说明

data否List<LicenseItem>证照列表

A.3电子证照制证接口

A.3.1创建制证数据接口

按照数据标准，提交证照信息，制作一个电子证照。如果证照带有附件，需要另外调用附件相关

接口操作。

请求参数：

表A.10创建制证数据请求参数

参数名是否必选类型说明

data_fields是String证照数据内容

operator是UserInfo制证操作人信息

service_item_code是String事项编码

service_item_name是String事项名称

biz_num否String对应的办件业务流水号

license_group否String照面模板组别名称

seal_code否String印章编码

返回结果：

7

DB44/T2167.3—2019

表A.11创建制证数据返回结果

参数名是否必选类型说明

license_code是String电子证照标识码

auth_code是String证照查验码

A.3.2修改制证数据

修改电子证照制证数据。

请求参数：

表A.12修改制证数据请求参数

参数名是否必选类型说明

license_code是String电子证照标识码

data_fields是String证照数据内容

operator是UserInfo制证操作人信息

service_item_code是String事项编码

service_item_name是String事项名称

biz_num否String对应办件的业务流水号

license_group否String照面模板组别名称

seal_code否String印章编码

返回结果：

无。（仅包含返回公共参数）

A.3.3删除制证数据

删除电子证照制证数据。

请求参数：

表A.13删除制证数据请求参数

参数名是否必选类型说明

license_code否String电子证照标识码

id_code否String证照号码

operator是UserInfo制证操作人信息

service_item_code是String事项编码

service_item_name是String事项名称

biz_num否String对应办件的业务流水号

注：license_code和id_code不能同时为空。

返回结果：

无。（仅包含返回公共参数）

8

DB44/T2167.3—2019

A.3.4下载单个附件

根据附件唯一标识获取单个附件数据。

请求参数：

表A.14下载单个附件请求参数

参数名是否必选类型说明

attachment_code是String附件唯一标识

返回结果：

表A.15下载单个附件返回结果

参数名是否必选类型说明

data是Attachment证件附件信息

A.3.5下载多个附件

根据电子证照标识码获取证照附件数据。

请求参数：

表A.16下载多个附件请求参数

参数名是否必选类型说明

license_code是String电子证照标识码

返回结果：

表A.17下载多个附件返回结果

参数名是否必选类型说明

data是List<Attachment>证件附件信息

A.3.6添加附件数据

添加电子证照附件数据。

请求参数：

表A.18添加附件数据请求参数

参数名是否必选类型说明

license_code是String电子证照标识码

name是String附件名称

file_type是String附件类型（文件后缀）

file_data是String附件数据（base64转码）

9

DB44/T2167.3—2019

表A.18添加附件数据请求参数（续）

参数名是否必选类型说明

is_license_image否Boolean是否作为证照电子影像（默认否）

description否String附件描述

返回结果：

表A.19添加附件数据返回结果

参数名是否必选类型说明

attachment_code是String附件唯一标识

A.3.7修改附件数据

修改电子证照附件数据。

请求参数：

表A.20修改附件数据请求参数

参数名是否必选类型说明

attachment_code是String附件唯一标识

license_code是String电子证照标识码

name是String附件名称

file_type是String附件类型（文件后缀）

file_data是String附件数据（base64转码）

is_license_image否Boolean是否作为证照电子影像（默认否）

description否String附件描述

注：attachment_code不能为空。

返回结果：

无。（仅包含返回公共参数）

A.3.8删除附件数据

删除电子证照附件数据。

请求参数：

表A.21删除附件数据请求参数

参数名是否必选类型说明

license_code是String电子证照标识码

attachment_code是String附件唯一标识

返回结果：

10

DB44/T2167.3—2019

无。（仅包含返回公共参数）

A.4电子证照信息管理接口

A.4.1签发一张证照

签发一张电子证照。

请求参数：

表A.22签发一张证照请求参数

参数名是否必选类型说明

license_code否String电子证照标识码

id_code否String证照号码

service_item_code是String事项编码

service_item_name是String事项名称

biz_num否String对应办件的业务流水号

operator是UserInfo签发操作人信息

注：（1）license_code和id_code不能同时为空；

（2）如果id_code存在多条记录，默认获取已制证的电子证照，如果存在多条制证的电子证照，则提示报错。

此种情况只能通过license_code的方式进行操作。

返回结果：

无。（仅包含返回公共参数）

A.4.2废止一张证照

废止一张电子证照。

请求参数：

表A.23废止一张证照请求参数

参数名是否必选类型说明

license_code否String电子证照标识码

id_code否String证照号码

service_item_code是String事项编码

service_item_name是String事项名称

biz_num否String对应办件的业务流水号

operator是UserInfo废止操作人信息

注：（1）license_code和id_code不能同时为空；

（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。

此种情况只能通过license_code的方式进行操作。

返回结果：

11

DB44/T2167.3—2019

无。（仅