DB44∕T 2167.3-2019 广东省电子证照技术规范 第3部分:接口规范(广东省).pdf
《DB44∕T 2167.3-2019 广东省电子证照技术规范 第3部分:接口规范(广东省).pdf》由会员分享,可在线阅读,更多相关《DB44∕T 2167.3-2019 广东省电子证照技术规范 第3部分:接口规范(广东省).pdf(36页珍藏版)》请在咨信网上搜索。
1、ICS 35.240.01 L 67 DB44 广东省地方标准 DB44/T 2167.32019 广东省电子证照技术规范 第 3 部分:接口规范 Electronic certificate technical specification Part 3:Interface specification 2019 - 07 - 12 发布 2019 - 10 - 01 实施 广东省市场监督管理局 发 布 DB44/T 2167.32019 I 目 次 前言 . II 1 范围 . 1 2 系统接口概述 . 1 2.1 接口组成 . 1 2.2 接口技术要求 . 1 2.3 接口使用 . 1 3
2、接口模型及参数 . 2 3.1 请求模型 . 2 3.2 返回模型 . 3 3.3 接口参数 . 4 附录 A(规范性附录) 接口及其参数说明 . 5 附录 B(规范性附录) 公共参数及数据类型 . 22 附录 C(规范性附录) 错误分类代码 . 27 参 考 文 献 . 30 DB44/T 2167.32019 II 前 言 DB44/T 2167广东省电子证照技术规范分为4个部分: 第 1 部分:总体构架; 第 2 部分:数据规范; 第 3 部分:接口规范; 第 4 部分:应用与技术管理要求。 本部分为DB44/T 2167的第3部分。 本部分按照GB/T 1.1-2009给出的规则起草。
3、 本部分的附录A、附录B、附录C为规范性附录。 本部分由广东省工业和信息化厅提出。 本部分由广东省信息技术标准化技术委员会归口。 本部分的主要起草单位: 工业和信息化部电子第五研究所、 广东省信息中心、 广东省标准化研究院。 本部分主要起草人:周春华、王贵虎、王韬、丁曙初、马晓镌、梁宏、何铤、肖晓赟、黎东初。 DB44/T 2167.32019 1 广东省电子证照技术规范 第 3 部分:接口规范 1 范围 DB44/T 2167的本部分规定了其他电子政务系统与电子证照系统进行对接的接口规范。 本部分适用于与政务电子证照系统的对接。 2 系统接口概述 2.1 接口组成 电子证照系统应包括电子证照
4、目录查询接口、 电子证照信息管理接口、 安全会话接口和用证服务接口。 a) 电子证照目录查询接口 应提供电子证照全省目录、地区和部门应开通目录查询功能。 b) 证照信息管理接口 应提供电子证照制证、签发、更新、废止等功能。 c) 安全会话接口 应提供对接入应用和用户身份进行合法性验证等功能。 d) 用证服务接口 应提供对电子证照进行查询、调用和有效性、归档等功能。 2.2 接口技术要求 a) 采用基于 Web Service 技术服务接口; b) 接口的请求和返回结果采用 JSON 格式; c) 应支持跨系统、跨平台调用; d) 传输的数据应采用加密和防篡改技术保证数据的完整有效性。 2.3
5、接口使用 接口使用前,应对使用接口的应用系统进行身份认证,确保访问接口的应用都经过授权。认证方式可采用app_key和app_secret方式或CA证书方式。 以下给出app_key和app_secret认证方式接口使用可参考流程: DB44/T 2167.32019 2 其他电子政务系统电子证照系统以app_key和app_secret为参数调用登录接口返回access_token带access_token参数数据访问返回相应数据结束调用返回app_key和app_secret注册和申请授权1234567 图1 接口使用流程图 1) 其他电子政务系统向电子证照系统进行应用注册和申请授权; 2
6、) 审核通过后返回应用唯一标识(app_key)和密钥(app_secret); 3) 其他电子政务系统调用登录接口,在参数中加入 app_key 和 app_secret,创建会话; 4) 电子证照系统返回接入令牌(access_token); 5) 在会话有效期内通过加入 access_token 参数进行接口调用; 6) 电子证照系统返回相应数据; 7) 会话超时或通过注销接口结束调用。 3 接口模型及参数 3.1 请求模型 DB44/T 2167.32019 3 图2 接口请求模型数据结构 接口请求模型 (RequestModel) 由接口名称 (InterfaceName) 、 请求
7、参数集 (RequestParameterSet) 、附件集(AttachmentSet)组成,实线连接内容为必选项,虚线连接内容为可选项。 接口名称。 接口名称指定将要调用的接口。 参数集。 结构化请求参数集,登录接口必须包含 app_key 和 app_secret,其它接口必须至少包含请求公共参数。每个参数由参数名(Name)和参数值(Value)、参数类型(Type)组成。 附件集 不含或含一个及以上附件。 每个附件由附件名 (Name) 、 附件链接地址 (URL) 、 附件类型 (Type) 、附件内容(Content)和附件描述(Despription)组成,附件链接地址和附件内
8、容至少包含一项。 3.2 返回模型 DB44/T 2167.32019 4 图3 接口返回模型数据结构 接口返回模型(ResponseModel)由返回结果参数集(ResponseParameterSet)、附件集(AttachmentSet)组成。 返回结果参数集 结构化的返回结果参数集,应至少包括返回公共参数。每个参数由参数名(Name)和参数值(Value) 、参数类型(Type)组成。 附件集 附件集为可选内容,不含或含一个以上附件,定义与接口请求模型相同。 3.3 接口参数 接口的具体请求和返回参数应符合附录A要求。请求公共参数和返回公共参数应符合附录B.1要求。DB44/T 216
9、7.32019 5 附 录 A (规范性附录) 接口及其参数说明 A.1 安全会话接口 A.1.1 登录 登录是接口系统调用的第一个方法。通过调用登录接口进行身份验证,验证成功后创建一个会话,所有对数据和附件的管理操作都必须在有效的会话内进行, 会话应有失效时间。 此接口不包含公用参数。 请求参数: 表 A.1 登录请求参数 参数名 是否必选 类型 说明 app_key 是 String 分配给应用程序的唯一标识 app_key app_secret 是 String 分配给应用程序的密钥 app_secret account 是 String 用户账户名称 password 是 String
10、 用户账户密码 org_code 否 String 以指定的部门管理员身份登录 返回结果: 表 A.2 登录返回结果参数 参数名 是否必选 类型 说明 ack_code 是 String 成功:SUCCESS,失败 FAILURE errors 是 String 无错误时为空,有错误返回错误信息 access_token 是 String 登录成功则返回安全会话访问令牌(一天有效) A.1.2 注销 注销当前会话。 请求参数: 无。 (仅包含请求公共参数) 返回结果: 无。 (仅包含返回公共参数) 。 A.1.3 获取当前已登录用户信息 获取当前已登录用户的信息。 请求参数: DB44/T 2
11、167.32019 6 无。 (仅包含请求公共参数) 返回结果: 表 A.3 注销返回结果参数 参数名 是否必选 类型 说明 data 是 UserInfo 用户信息 A.2 电子证照目录接口 A.2.1 查询全省目录 列举出全省目录清单。 请求参数: 表 A.4 查询全省目录请求参数 参数名 是否必选 类型 说明 page_index 否 Integer 返回第几页数据。默认值 1 page_size 否 Integer 返回数据的每页大小。默认值 10,最大值 150 keyword 否 String 查询关键字(证照名称,目录编制部门) status 否 LicenseItemStatu
12、s 证照状态(默认查询已发布,多个时中间以逗号(,)分割) is_open 否 Boolean 开通状态(默认已开通) 注:为兼容现有系统,在接口参数中,使用license英文单词替代certificate使用,下同。 返回结果: 表 A.5 查询全省目录返回结果 参数名 是否必选 类型 说明 data 是 List 证照目录 A.2.2 查询地区应开通目录 列举出一个地区的应用开通目录清单。 请求参数: 表 A.6 查询地区应开通目录请求参数 参数名 是否必选 类型 说明 page_index 否 Integer 返回第几页数据。默认值 1 page_size 否 Integer 返回数据的
13、每页大小。默认值 10,最大值 150 keyword 否 String 查询关键字(证照名称,目录编制部门) is_service 否 Boolean 纳入情况 返回结果: DB44/T 2167.32019 7 表 A.7 查询地区应开通目录返回结果 参数名 是否必选 类型 说明 data 是 List 证照目录 A.2.3 查询部门应开通目录 列举出一个部门的应用开通目录清单。 请求参数: 表 A.8 查询部门应开通目录请求参数 参数名 是否必选 类型 说明 page_index 否 Integer 返回第几页数据。默认值 1 page_size 否 Integer 返回数据的每页大小。
14、默认值 10,最大值 150 keyword 否 String 查询关键字(证照名称,目录编制部门) is_service 否 Boolean 纳入情况 返回结果: 表 A.9 查询部门应开通目录返回结果 参数名 是否必选 类型 说明 data 否 List 证照列表 A.3 电子证照制证接口 A.3.1 创建制证数据接口 按照数据标准,提交证照信息,制作一个电子证照。如果证照带有附件,需要另外调用附件相关接口操作。 请求参数: 表 A.10 创建制证数据请求参数 参数名 是否必选 类型 说明 data_fields 是 String 证照数据内容 operator 是 UserInfo 制证
15、操作人信息 service_item_code 是 String 事项编码 service_item_name 是 String 事项名称 biz_num 否 String 对应的办件业务流水号 license_group 否 String 照面模板组别名称 seal_code 否 String 印章编码 返回结果: DB44/T 2167.32019 8 表 A.11 创建制证数据返回结果 参数名 是否必选 类型 说明 license_code 是 String 电子证照标识码 auth_code 是 String 证照查验码 A.3.2 修改制证数据 修改电子证照制证数据。 请求参数: 表
16、 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 删除制证数据
17、删除电子证照制证数据。 请求参数: 表 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不能同时为空。 返回结果: 无。 (仅包含返回公共参数) DB44/T 2167.32019 9 A.3.4
18、下载单个附件 根据附件唯一标识获取单个附件数据。 请求参数: 表 A.14 下载单个附件请求参数 参数名 是否必选 类型 说明 attachment_code 是 String 附件唯一标识 返回结果: 表 A.15 下载单个附件返回结果 参数名 是否必选 类型 说明 data 是 Attachment 证件附件信息 A.3.5 下载多个附件 根据电子证照标识码获取证照附件数据。 请求参数: 表 A.16 下载多个附件请求参数 参数名 是否必选 类型 说明 license_code 是 String 电子证照标识码 返回结果: 表 A.17 下载多个附件返回结果 参数名 是否必选 类型 说明
19、data 是 List 证件附件信息 A.3.6 添加附件数据 添加电子证照附件数据。 请求参数: 表 A.18 添加附件数据请求参数 参数名 是否必选 类型 说明 license_code 是 String 电子证照标识码 name 是 String 附件名称 file_type 是 String 附件类型(文件后缀) file_data 是 String 附件数据(base64 转码) DB44/T 2167.32019 10 表 A.18 添加附件数据请求参数(续) 参数名 是否必选 类型 说明 is_license_image 否 Boolean 是否作为证照电子影像(默认否) des
20、cription 否 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
21、转码) is_license_image 否 Boolean 是否作为证照电子影像(默认否) description 否 String 附件描述 注:attachment_code不能为空。 返回结果: 无。 (仅包含返回公共参数) A.3.8 删除附件数据 删除电子证照附件数据。 请求参数: 表 A.21 删除附件数据请求参数 参数名 是否必选 类型 说明 license_code 是 String 电子证照标识码 attachment_code 是 String 附件唯一标识 返回结果: DB44/T 2167.32019 11 无。 (仅包含返回公共参数) A.4 电子证照信息管理接口
22、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存在多条记录,默认获取已制证的电子证照,如
23、果存在多条制证的电子证照,则提示报错。此种情况只能通过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 废止操作人信
24、息 注:(1)license_code和id_code不能同时为空; (2)如果id_code存在多条记录,默认获取已签发的电子证照,如果存在多条签发的电子证照,则提示报错。此种情况只能通过license_code的方式进行操作。 返回结果: DB44/T 2167.32019 12 无。(仅包含返回公共参数) A.4.3 变更一张证照 变更一张证照。 请求参数: 表 A.24 变更一张证照请求参数 参数名 是否必选 类型 说明 license_code 否 String 原电子证照标识码 id_code 否 String 原证照号码 data_fields 是 String 变更后的证照数据
25、内容,用于签发新证 service_item_code 是 String 事项编码 service_item_name 是 String 事项名称 biz_num 否 String 对应办件的业务流水号 operator 是 UserInfo 变更操作人信息 注:(1)license_code和id_code不能同时为空; (2)如果id_code存在多条记录,默认获取已签发的电子证照,如果存在多条签发的电子证照,则提示报错。此种情况只能通过license_code的方式进行操作。 返回结果: 表 A.25 变更一张证照返回结果 参数名 是否必选 类型 说明 license_code 是 St
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- DB44T 2167.3-2019 广东省电子证照技术规范 第3部分:接口规范广东省 DB44 2167.3 2019 广东省 电子 证照 技术规范 部分 接口 规范
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【曲****】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【曲****】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。
链接地址:https://www.zixin.com.cn/doc/153417.html