DB44_T 2167.3-2019 广东省电子证照技术规范 第3部分：接口规范.docx

《DB44_T 2167.3-2019 广东省电子证照技术规范 第3部分：接口规范.docx》由会员分享，可在线阅读，更多相关《DB44_T 2167.3-2019 广东省电子证照技术规范 第3部分：接口规范.docx（33页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、ICS35.240.01L67DB44广东省地方标准DB44/T2167.32019广东省电子证照技术规范第3部分：接口规范ElectroniccertificatetechnicalspecificationPart3:Interfacespecification2019-07-12发布2019-10-01实施广东省市场监督管理局发布DB44/T2167.32019目次前言.II1范围.12系统接口概述.12.1接口组成.12.2接口技术要求.12.3接口使用.13接口模型及参数.23.1请求模型.23.2返回模型.33.3接口参数.4附录A（规范性附录）接口及其参数说明.5附录B（规范性附

2、录）公共参数及数据类型.22附录C（规范性附录）错误分类代码.27参考文献.30IDB44/T2167.32019前言DB44/T2167广东省电子证照技术规范分为4个部分：第1部分：总体构架；第2部分：数据规范；第3部分：接口规范；第4部分：应用与技术管理要求。本部分为DB44/T2167的第3部分。本部分按照GB/T1.1-2009给出的规则起草。本部分的附录A、附录B、附录C为规范性附录。本部分由广东省工业和信息化厅提出。本部分由广东省信息技术标准化技术委员会归口。本部分的主要起草单位：工业和信息化部电子第五研究所、广东省信息中心、广东省标准化研究院。本部分主要起草人：周春华、王贵虎、王

3、韬、丁曙初、马晓镌、梁宏、何铤、肖晓赟、黎东初。IIDB44/T2167.32019广东省电子证照技术规范第3部分：接口规范1范围DB44/T2167的本部分规定了其他电子政务系统与电子证照系统进行对接的接口规范。本部分适用于与政务电子证照系统的对接。2系统接口概述2.1接口组成电子证照系统应包括电子证照目录查询接口、电子证照信息管理接口、安全会话接口和用证服务接口。a)电子证照目录查询接口应提供电子证照全省目录、地区和部门应开通目录查询功能。b)证照信息管理接口应提供电子证照制证、签发、更新、废止等功能。c)安全会话接口应提供对接入应用和用户身份进行合法性验证等功能。d)用证服务接口应提供对

4、电子证照进行查询、调用和有效性、归档等功能。2.2接口技术要求a)采用基于WebService技术服务接口；b)接口的请求和返回结果采用JSON格式；c)应支持跨系统、跨平台调用；d)传输的数据应采用加密和防篡改技术保证数据的完整有效性。2.3接口使用接口使用前，应对使用接口的应用系统进行身份认证，确保访问接口的应用都经过授权。认证方式可采用app_key和app_secret方式或CA证书方式。以下给出app_key和app_secret认证方式接口使用可参考流程：1DB44/T2167.32019其他电子政务系统电子证照系统1234567注册和申请授权返回app_key和app_secre

5、t以app_key和app_secret为参数调用登录接口返回access_token带access_token参数数据访问返回相应数据结束调用图1接口使用流程图1)其他电子政务系统向电子证照系统进行应用注册和申请授权；2)审核通过后返回应用唯一标识（app_key）和密钥（app_secret）；3)其他电子政务系统调用登录接口，在参数中加入app_key和app_secret，创建会话；4)电子证照系统返回接入令牌（access_token）；5)在会话有效期内通过加入access_token参数进行接口调用；6)电子证照系统返回相应数据；7)会话超时或通过注销接口结束调用。3接口模型及参

6、数3.1请求模型2DB44/T2167.32019图2接口请求模型数据结构接口请求模型（RequestModel）由接口名称（InterfaceName）、请求参数集（RequestParameterSet）、附件集（AttachmentSet）组成，实线连接内容为必选项，虚线连接内容为可选项。接口名称。接口名称指定将要调用的接口。参数集。结构化请求参数集，登录接口必须包含app_key和app_secret，其它接口必须至少包含请求公共参数。每个参数由参数名（Name）和参数值（Value）、参数类型（Type）组成。附件集不含或含一个及以上附件。每个附件由附件名（Name）、附件链接地址（

7、URL）、附件类型（Type）、附件内容（Content）和附件描述（Despription）组成，附件链接地址和附件内容至少包含一项。3.2返回模型3DB44/T2167.32019图3接口返回模型数据结构接口返回模型（ResponseModel）由返回结果参数集（ResponseParameterSet）、附件集（AttachmentSet）组成。返回结果参数集结构化的返回结果参数集，应至少包括返回公共参数。每个参数由参数名（Name）和参数值（Value）、参数类型（Type）组成。附件集附件集为可选内容，不含或含一个以上附件，定义与接口请求模型相同。3.3接口参数接口的具体请求和返回参

8、数应符合附录A要求。请求公共参数和返回公共参数应符合附录B.1要求。4参数名是否必选类型说明app_key是String分配给应用程序的唯一标识app_keyapp_secret是String分配给应用程序的密钥app_secretaccount是String用户账户名称password是String用户账户密码org_code否String以指定的部门管理员身份登录参数名是否必选类型说明ack_code是String成功：SUCCESS，失败FAILUREerrors是String无错误时为空，有错误返回错误信息access_token是String登录成功则返回安全会话访问令牌（一天有效）

9、DB44/T2167.32019附录A（规范性附录）接口及其参数说明A.1安全会话接口A.1.1登录登录是接口系统调用的第一个方法。通过调用登录接口进行身份验证，验证成功后创建一个会话，所有对数据和附件的管理操作都必须在有效的会话内进行，会话应有失效时间。此接口不包含公用参数。请求参数：表A.1登录请求参数返回结果：表A.2登录返回结果参数A.1.2注销注销当前会话。请求参数：无。（仅包含请求公共参数）返回结果：无。（仅包含返回公共参数）。A.1.3获取当前已登录用户信息获取当前已登录用户的信息。请求参数：5参数名是否必选类型说明page_index否Integer返回第几页数据。默认值1pa

10、ge_size否Integer返回数据的每页大小。默认值10，最大值150keyword否String查询关键字（证照名称，目录编制部门）status否LicenseItemStatus证照状态（默认查询已发布，多个时中间以逗号（,）分割）is_open否Boolean开通状态（默认已开通）参数名是否必选类型说明page_index否Integer返回第几页数据。默认值1page_size否Integer返回数据的每页大小。默认值10，最大值150keyword否String查询关键字（证照名称，目录编制部门）is_service否Boolean纳入情况参数名是否必选类型说明data是User

11、Info用户信息参数名是否必选类型说明data是List证照目录DB44/T2167.32019无。（仅包含请求公共参数）返回结果：表A.3注销返回结果参数A.2电子证照目录接口A.2.1查询全省目录列举出全省目录清单。请求参数：表A.4查询全省目录请求参数注：为兼容现有系统，在接口参数中，使用license英文单词替代certificate使用，下同。返回结果：表A.5查询全省目录返回结果A.2.2查询地区应开通目录列举出一个地区的应用开通目录清单。请求参数：表A.6查询地区应开通目录请求参数返回结果：6参数名是否必选类型说明data_fields是String证照数据内容operator是

12、UserInfo制证操作人信息service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应的办件业务流水号license_group否String照面模板组别名称seal_code否String印章编码参数名是否必选类型说明page_index否Integer返回第几页数据。默认值1page_size否Integer返回数据的每页大小。默认值10，最大值150keyword否String查询关键字（证照名称，目录编制部门）is_service否Boolean纳入情况参数名是否必选类型说明data否List证照列

13、表参数名是否必选类型说明data是List证照目录DB44/T2167.32019表A.7查询地区应开通目录返回结果A.2.3查询部门应开通目录列举出一个部门的应用开通目录清单。请求参数：表A.8查询部门应开通目录请求参数返回结果：表A.9查询部门应开通目录返回结果A.3电子证照制证接口A.3.1创建制证数据接口按照数据标准，提交证照信息，制作一个电子证照。如果证照带有附件，需要另外调用附件相关接口操作。请求参数：表A.10创建制证数据请求参数返回结果：7参数名是否必选类型说明license_code是String电子证照标识码data_fields是String证照数据内容operator是

14、UserInfo制证操作人信息service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号license_group否String照面模板组别名称seal_code否String印章编码参数名是否必选类型说明license_code否String电子证照标识码id_code否String证照号码operator是UserInfo制证操作人信息service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流

15、水号参数名是否必选类型说明license_code是String电子证照标识码auth_code是String证照查验码DB44/T2167.32019表A.11创建制证数据返回结果A.3.2修改制证数据修改电子证照制证数据。请求参数：表A.12修改制证数据请求参数返回结果：无。（仅包含返回公共参数）A.3.3删除制证数据删除电子证照制证数据。请求参数：表A.13删除制证数据请求参数注：license_code和id_code不能同时为空。返回结果：无。（仅包含返回公共参数）8参数名是否必选类型说明license_code是String电子证照标识码name是String附件名称file_ty

16、pe是String附件类型（文件后缀）file_data是String附件数据（base64转码）参数名是否必选类型说明attachment_code是String附件唯一标识参数名是否必选类型说明license_code是String电子证照标识码参数名是否必选类型说明data是List证件附件信息参数名是否必选类型说明data是Attachment证件附件信息DB44/T2167.32019A.3.4下载单个附件根据附件唯一标识获取单个附件数据。请求参数：表A.14下载单个附件请求参数返回结果：表A.15下载单个附件返回结果A.3.5下载多个附件根据电子证照标识码获取证照附件数据。请求参数

17、：表A.16下载多个附件请求参数返回结果：表A.17下载多个附件返回结果A.3.6添加附件数据添加电子证照附件数据。请求参数：表A.18添加附件数据请求参数9参数名是否必选类型说明attachment_code是String附件唯一标识license_code是String电子证照标识码name是String附件名称file_type是String附件类型（文件后缀）file_data是String附件数据（base64转码）is_license_image否Boolean是否作为证照电子影像（默认否）description否String附件描述参数名是否必选类型说明license_code是

18、String电子证照标识码attachment_code是String附件唯一标识参数名是否必选类型说明is_license_image否Boolean是否作为证照电子影像（默认否）description否String附件描述参数名是否必选类型说明attachment_code是String附件唯一标识DB44/T2167.32019表A.18添加附件数据请求参数（续）返回结果：表A.19添加附件数据返回结果A.3.7修改附件数据修改电子证照附件数据。请求参数：表A.20修改附件数据请求参数注：attachment_code不能为空。返回结果：无。（仅包含返回公共参数）A.3.8删除附件数据删

19、除电子证照附件数据。请求参数：表A.21删除附件数据请求参数返回结果：10参数名是否必选类型说明license_code否String电子证照标识码id_code否String证照号码service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo废止操作人信息参数名是否必选类型说明license_code否String电子证照标识码id_code否String证照号码service_item_code是String事项编码service_item_name是Str

20、ing事项名称biz_num否String对应办件的业务流水号operator是UserInfo签发操作人信息DB44/T2167.32019无。（仅包含返回公共参数）A.4电子证照信息管理接口A.4.1签发一张证照签发一张电子证照。请求参数：表A.22签发一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已制证的电子证照，如果存在多条制证的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：无。（仅包含返回公共参数）A.4.2废止一张证照废止一张电子证照。请求参数：表A.23废止一

21、张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：11参数名是否必选类型说明license_code否String原电子证照标识码id_code否String原证照号码data_fields是String变更后的证照数据内容，用于签发新证service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号op

22、erator是UserInfo变更操作人信息参数名是否必选类型说明license_code否String原电子证照标识码id_code否String原证照号码data_fields是String加注后的证照数据内容，用于签发新证service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo加注操作人信息参数名是否必选类型说明license_code是String变更后的电子证照标识码auth_code是String证照查验码DB44/T2167.32019无。（仅

23、包含返回公共参数）A.4.3变更一张证照变更一张证照。请求参数：表A.24变更一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：表A.25变更一张证照返回结果A.4.4加注一张证照加注一张证照。请求参数：表A.26加注一张证照请求参数12参数名是否必选类型说明license_code否String原电子证照标识码id_code否String原证照号码data_fields是String年检后的证照

24、数据内容，用于签发新证service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo年检操作人信息参数名是否必选类型说明license_code是String加注后的电子证照标识码auth_code是String证照查验码参数名是否必选类型说明license_code是String年检后的电子证照标识码auth_code是String证照查验码DB44/T2167.32019注：（1）license_code和id_code不能同时为空；（2）如果id_code存

25、在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：表A.27加注一张证照返回结果A.4.5年检一张证照年检一张证照。请求参数：表A.28年检一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作；返回结果：表A.29年检一张证照返回结果A.4.6换证一张证照换证一张证照。请求参数：13参数名是否必选类型说明license

26、_code否String原电子证照标识码id_code否String原证照号码data_fields是String换证后的证照数据内容，用于签发新证service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo换证操作人信息参数名是否必选类型说明license_code否String原电子证照标识码id_code否String原证照号码service_item_code是String事项编码service_item_name是String事项名称biz_num否S

27、tring对应办件的业务流水号operator是UserInfo挂失操作人信息参数名是否必选类型说明license_code是String换证后的电子证照标识码auth_code是String证照查验码DB44/T2167.32019表A.30换证一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：表A.31换证一张证照返回结果A.4.7挂失一张证照挂失一张证照。请求参数：表A.32挂失一张证照请求

28、参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：无。（仅包含返回公共参数）A.4.8补发一张证照14参数名是否必选类型说明license_code否String原电子证照标识码id_code否String原证照号码data_fields是String补发后的证照数据内容，用于签发新证service_item_code是String事项编码service_item_name是String事项名称biz_num

29、否String对应办件的业务流水号operator是UserInfo补发操作人信息参数名是否必选类型说明license_code否String电子证照标识码id_code否String证照号码service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo吊销操作人信息参数名是否必选类型说明license_code是String补发后的电子证照标识码auth_code是String证照查验码DB44/T2167.32019补发一张证照。请求参数：表A.33补发一张证

30、照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：表A.34补发一张证照返回结果A.4.9吊销一张证照吊销一张证照。请求参数：表A.35吊销一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。15参数名是否必选类型说明

31、license_code否String电子证照标识码id_code否String证照号码service_item_code是String事项编码service_item_name是String事项名称biz_num否String对应办件的业务流水号operator是UserInfo注销操作人信息参数名是否必选类型说明page_index否Integer返回第几页数据。默认值1page_size否Integer返回数据的每页大小。默认值10，最大值150license_status否String电子证照状态。支持多个，多个时用逗号（,）分隔credential是String实名登录凭据token

32、。token_id是String实名登录tokenIdrandom是String实名登录随机数DB44/T2167.32019返回结果：无。（仅包含返回公共参数）A.4.10注销一张证照注销一张证照。请求参数：表A.35注销一张证照请求参数注：（1）license_code和id_code不能同时为空；（2）如果id_code存在多条记录，默认获取已签发的电子证照，如果存在多条签发的电子证照，则提示报错。此种情况只能通过license_code的方式进行操作。返回结果：无。（仅包含返回公共参数）A.5电子证照用证服务接口A.5.1两页系统用证列举一个持证者所有的电子证照清单，同时对结果清单每一项生成用证码。该接口主要用于两页（市民个人网页、企业专属网页）系统使用。使用这个接口必须先登录实名认证系统获取实名登录凭据。请求参数：