《《广东省电子证照技术规范 第3部分：接口规范》》由会员分享，可在线阅读，更多相关《《广东省电子证照技术规范 第3部分：接口规范》（34页珍藏版）》请在金锄头文库上搜索。
1、ICS35.240.01L 67DB44广东省地方标准DB 44/ XXXXXXXXX广东省电子证照技术规范第3部分:接口规范Electronic certificate technical specificationPart 3:Interface specification（本稿完成日期：2018-04-23）XXXX - XX - XX发布XXXX - XX - XX实施广东省市场监督管理局发布DBXX/ XXXXXXXXX目次前言II1范围12系统接口概述12.1接口组成12.2接口技术要求12.3接口使用13接口模型及参数23.1请求模型23.2返回模型33.3接口参数4附录A（规范
2、性附录）接口及其参数说明5附录B（规范性附录）公共参数及数据类型22附录C（规范性附录）错误分类代码27参考文献30前言DB44/T xxxx广东省电子证照技术规范分为5个部分： 第1部分：总体构架； 第2部分：数据规范； 第3部分：接口规范； 第4部分：应用规范； 第5部分：技术管理要求。本部分为DB44/T xxxx的第3部分。本部分按照GB/T 1.1-2009给出的规则起草。本部分的附录A、附录B、附录C为规范性附录。本部分由广东省经济和信息化委员会提出。本部分由广东省信息技术标准化技术委员会归口。本部分的主要起草单位：工业和信息化部电子第五研究所、广东省信息中心、广东省标准化研究院。
3、本部分主要起草人：周春华、王韬、王贵虎、丁曙初、马晓镌、梁宏、何铤、肖晓赟、黎东初。29广东省电子证照技术规范 第3部分 接口规范1 范围DB 44/T xxxx的本部分规定了其他电子政务系统与电子证照系统进行对接的接口规范。本部分适用于与政务电子证照系统的对接。2 系统接口概述2.1 接口组成电子证照系统应包括电子证照目录查询接口、电子证照信息管理接口、安全会话接口和用证服务接口。a) 电子证照目录查询接口应提供电子证照全省目录、地区和部门应开通目录查询功能。b) 证照信息管理接口应提供电子证照制证、签发、更新、废止等功能。c) 安全会话接口应提供对接入应用和用户身份进行合法性验证等功能。d
4、) 用证服务接口应提供对电子证照进行查询、调用和有效性、归档等功能。2.2 接口技术要求a) 采用基于Web Service技术服务接口；b) 接口的请求和返回结果采用JSON格式；c) 应支持跨系统、跨平台调用；d) 传输的数据应采用加密和防篡改技术保证数据的完整有效性。2.3 接口使用接口使用前，应对使用接口的应用系统进行身份认证，确保访问接口的应用都经过授权。认证方式可采用app_key和app_secret方式或CA证书方式。以下给出app_key和app_secret认证方式接口使用可参考流程：图1 接口使用流程图1) 其他电子政务系统向电子证照系统进行应用注册和申请授权；2) 审核
5、通过后返回应用唯一标识（app_key）和密钥（app_secret）；3) 其他电子政务系统调用登录接口，在参数中加入app_key和app_secret，创建会话；4) 电子证照系统返回接入令牌（access_token）；5) 在会话有效期内通过加入access_token参数进行接口调用；6) 电子证照系统返回相应数据；7) 会话超时或通过注销接口结束调用。3 接口模型及参数3.1 请求模型图2 接口请求模型数据结构接口请求模型（RequestModel）由接口名称（InterfaceName）、请求参数集（RequestParameterSet）、附件集（AttachmentSet）
6、组成，实线连接内容为必选项，虚线连接内容为可选项。 接口名称。接口名称指定将要调用的接口。 参数集。结构化请求参数集，登录接口必须包含app_key和app_secret，其它接口必须至少包含请求公共参数。每个参数由参数名（Name）和参数值（Value）、参数类型（Type）组成。 附件集不含或含一个及以上附件。每个附件由附件名（Name）、附件链接地址（URL）、附件类型（Type）、附件内容（Content）和附件描述（Despription）组成，附件链接地址和附件内容至少包含一项。3.2 返回模型图3 接口返回模型数据结构接口返回模型（ResponseModel）由返回结果参数集（R
7、esponseParameterSet）、附件集（AttachmentSet）组成。 返回结果参数集结构化的返回结果参数集，应至少包括返回公共参数。每个参数由参数名（Name）和参数值（Value）、参数类型（Type）组成。 附件集附件集为可选内容，不含或含一个以上附件，定义与接口请求模型相同。3.3 接口参数接口的具体请求和返回参数应符合附录A要求。请求公共参数和返回公共参数应符合附录B.1要求。附录A （规范性附录）接口及其参数说明A.1 安全会话接口A.1.1 登录登录是接口系统调用的第一个方法。通过调用登录接口进行身份验证，验证成功后创建一个会话，所有对数据和附件的管理操作都必须在有
8、效的会话内进行，会话应有失效时间。此接口不包含公用参数。请求参数： 表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，失败FAILUREerrors是String 无错误时为空
9、，有错误返回错误信息access_token 是 String 登录成功则返回安全会话访问令牌（一天有效）A.1.2 注销注销当前会话。请求参数：无。（仅包含请求公共参数）返回结果：无。（仅包含返回公共参数）。A.1.3 获取当前已登录用户信息获取当前已登录用户的信息。请求参数：无。（仅包含请求公共参数）返回结果：表A.3 注销返回结果参数参数名是否必选类型说明data 是 UserInfo 用户信息 A.2 电子证照目录接口A.2.1 查询全省目录列举出全省目录清单。请求参数：表A.4 查询全省目录请求参数参数名是否必选类型说明page_index 否Integer返回第几页数据。默认值1p
10、age_size 否Integer返回数据的每页大小。默认值10，最大值150keyword否 String查询关键字（证照名称，目录编制部门） status否LicenseItemStatus证照状态（默认查询已发布，多个时中间以逗号（,）分割）is_open否Boolean开通状态（默认已开通）注： 为兼容现有系统，在接口参数中，使用license英文单词替代certificate使用，下同。返回结果：表A.5 查询全省目录返回结果参数名是否必选类型说明data是 List证照目录A.2.2 查询地区应开通目录列举出一个地区的应用开通目录清单。请求参数：表A.6 查询地区应开通目录请求参数
11、参数名是否必选类型说明page_index 否Integer返回第几页数据。默认值1page_size 否Integer返回数据的每页大小。默认值10，最大值150keyword否 String查询关键字（证照名称，目录编制部门） is_service否Boolean纳入情况返回结果：表A.7 查询地区应开通目录返回结果参数名是否必选类型说明data是 List证照目录A.2.3 查询部门应开通目录列举出一个部门的应用开通目录清单。请求参数：表A.8 查询部门应开通目录请求参数 参数名是否必选类型说明page_index 否Integer返回第几页数据。默认值1page_size 否Integ
12、er返回数据的每页大小。默认值10，最大值150keyword否 String查询关键字（证照名称，目录编制部门） is_service否Boolean纳入情况返回结果：表A.9 查询部门应开通目录返回结果参数名是否必选类型说明data 否 List 证照列表 A.3 电子证照制证接口A.3.1 创建制证数据接口按照数据标准，提交证照信息，制作一个电子证照。如果证照带有附件，需要另外调用附件相关接口操作。请求参数：表A.10 创建制证数据请求参数参数名是否必选类型说明data_fields是 String证照数据内容operator是UserInfo制证操作人信息 service_item_c
13、ode是String事项编码service_item_name是String事项名称biz_num否String对应的办件业务流水号license_group否String照面模板组别名称seal_code否String印章编码返回结果：表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印章编码返回结果：无。（仅包含返回公共参数）
