《DB4403_T 383.4-2023 电子印章 第4部分:应用服务接口.docx》由会员分享,可在线阅读,更多相关《DB4403_T 383.4-2023 电子印章 第4部分:应用服务接口.docx(48页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、ICS35.240.01CCSL67DB4403深圳市地方标准DB4403/T383.42023电子印章第4部分:应用服务接口ElectronicsealPart4:Applicationprogramminginterface2023-11-02发布2023-12-01实施深圳市市场监督管理局发布DB4403/T383.42023目次前言.III1范围.12规范性引用文件.13术语和定义.14缩略语.15应用接口技术要求.16应用接口清单.27基础功能.37.1概述.37.2获取可用印章列表接口.47.3文件格式转换接口.68系统登录.88.1概述.88.2获取扫码登录或签名接口.118.3
2、获取扫码状态接口.138.4获取扫码登录或扫码签名结果接口.148.5USBKey介质登录或签名接口.169通用签章.169.1概述.169.2生成摘要接口.189.3智能移动终端证书摘要签名接口.229.4USBKey证书签名接口.229.5服务器密码机证书签名接口.229.6签章合成接口.2210验章.2410.1概述.2410.2已签文件验证接口.2510.3印章验证接口.2711集中签章.2911.1概述.2911.2文件上传接口.3211.3签章接口.3311.4文件下载接口.36IDB4403/T383.42023附录A(规范性)电子印章应用服务接口参数编码.38A.1证件类型编码
3、.38A.2使用场景编码.38A.3扫码状态编码.38附录B(规范性)电子印章应用服务接口异常信息表.40附录C(规范性)电子印章应用服务接口通用数据结构.42C.1坐标规则结构.42C.2关键字规则结构.42C.3骑缝章规则结构.42参考文献.44IIDB4403/T383.42023前言本文件按照GB/T1.12020标准化工作导则第1部分:标准化文件的结构和起草规则的规定起草。本文件是DB4403/T3832023电子印章的第4部分。DB4403/T3832023已经发布了以下部分:第1部分:通用要求;第2部分:数字证书;第3部分:业务办理和应用指南;第4部分:应用服务接口;第5部分:第
4、三方应用接入要求和测试方法;第6部分:商事主体电子印章图像;第7部分:商事主体电子印章备案。本文件由深圳市政务服务数据管理局提出并归口。本文件起草单位:深圳市政务服务数据管理局、深圳市市场监督管理局、深圳市信息安全管理中心、深圳市标准技术研究院、北京数字认证股份有限公司、平安科技(深圳)有限公司、广州金格数安科技有限公司、北京国脉信安科技有限公司、广东省电子商务认证有限公司、中移动信息技术有限公司。本文件主要起草人:王志勇、肖永舒、李苏、姚逸滨、谢明康、张报建、罗菁春、黄立、董安波、谷鹏、简超、周鑫、刘家雄、饶文刚、林宇群、张雯、周佩雯、穆端端、林雄杰、程小茁、唐先海、何红、杨志强、蒋楠、林少
5、柳、蔡志翔、王惠惠、赖慧诗、俞科、曾勇、陈慧铧、陈胜、周维、李玮。IIIDB4403/T383.42023电子印章第4部分:应用服务接口1范围本文件规定了深圳市电子印章系统为第三方应用系统提供的应用服务接口的分类、使用方法、参数定义等。本文件适用于党政机关、商事主体以及其他机构对其系统进行改造,以使用户在其系统中使用电子印章。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件。不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T352912017信息安全技术智能密码钥匙应用接口规范GB/T3
6、85402020信息安全技术安全电子签章密码技术规范DB4403/T383.12023电子印章第1部分:通用要求DB4403/T383.32023电子印章第3部分:业务办理和应用指南3术语和定义DB4403/T383.12023和DB4403/T383.32023界定的术语和定义适用于本文件。4缩略语下列缩略语适用于本文件。SDK:软件开发工具包(SoftwareDevelopmentKit)HTTP:超文本传输协议(HyperTextTransferProtocol)HTTPS:以安全为目标的HTTP通道(HyperTextTransferProtocoloverSecureSocketLa
7、yer)JSON:JS对象标记(JavaScriptObjectNotation)URL:统一资源定位符(UniformResourceLocator)CA:证书认证机构(certificateauthority)PDF:可携带文档格式(PortableDocumentFormat)OFD:开放式版式文档(OpenFixed-layoutDocument)5应用接口技术要求1分类编号分类接口编号接口名称函数接口说明01基础功能BASISFUN-01获取可用印章列表genGetSealInfoList获取可用电子印章图像数据。BASISFUN-02文件格式转换genFormatFile将word
8、、excel、html等不同格式电子文档,统一转换为PDF或OFD格式。02系统登录LOGIN-01获取扫码登录或签名genGetLoginQRCode获取扫码登录或扫码签名的二维码,然后使用移动端应用程序扫描,完成登录确认或签名确认。LOGIN-02获取扫码状态genGetScanStatusById获取用户在电子印章系统的移动端应用程序扫码时的操作状态。LOGIN-03获取扫码登录或扫码签名结果genGetTaskResult获取在电子印章系统的移动端应用程序扫码登录或扫码签名的结果。LOGIN-04USBKey介质登录或签名与GB/T352912017的规定保持一致使用USBKey介质进
9、行授权登录或签名。03通用签章GENSIGN-01生成摘要genCalculateFileHash生成待签章文件的摘要信息。GENSIGN-02智能移动终端证书摘要签名与LOGIN-01接口一致调用智能移动终端证书对摘要进行签名。GENSIGN-03USBKey证书摘要签名与GB/T352912017的规定保持一致调用USBKey证书对摘要进行签名。GENSIGN-04服务器密码机证书摘要签名与GB/T352912017的规定保持一致调用服务器密码机证书对摘要进行签名。GENSIGN-05签章合成genDetachedFile使用时间戳、加密加签等处理方式,合成签章文件。04验章VERIFY-
10、01已签文件验证genFileVerify对已签署文件进行验证,包含验证时间戳、已签文档中某个电子印章或数字签名的有效性、已签文档中某个电子印章或数字签名所签署内容是否被篡改,以及已签文档中所有电子印章或数字签名的签章记录。VERIFY-02印章验证genRecognizeRegionalsSeal验证印章编码、印章类型、发放单位、发放时间等信息。DB4403/T383.42023应用接口按照HTTPS方式访问,采用UTF-8编码,通过HTTPS协议的POST/GET方法提交请求,报文内容采用SM4CBC加密,接口专用参数通过请求正文,按照JSON格式封装提供。6应用接口清单应用接口清单见表1
11、。表1应用接口清单2分类编号分类接口编号接口名称函数接口说明05集中签章CENTRALIZED-01文件上传genFileUplode上传PDF或OFD格式待签章文件。CENTRALIZED-02签章genCentralizedSignature查询可用印章接口,获取用户ID和印章编码信息,传入文件数据和签章位置参数,完成签章操作。CENTRALIZED-03文件下载genFileDownload下载已签章文件。DB4403/T383.42023表1(续)7基础功能7.1概述基础功能部分包含以下两个接口:获取可用印章列表接口:输入印章类型、注册授权码、统一社会信用代码、第三方应用系统编号等请求
12、参数,返回用户可用电子印章图像数据。使用流程见图1;文件格式转换接口:输入word、excel、html等不同格式电子文档,返回PDF或OFD格式文件。使用流程见图2。第三方应用系统/用户SDK深圳统一电子印章管理平台1、准备参数2、调用接口API-SEAL-BASISFUN-013、校验接口入参4、调用平台接口获取信息5、校验接口入参,获取数据,组装输出参数6、记录调用日志7、响应输出结果8、重新封装输出参数9、响应输出结果10、解析输出参数,完成接口调用图1获取可用印章列表流程3参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号
13、String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记DB4403/T383.42023第三方应用系统/用户SDK1、准备参数2、调用接口API-SEAL-BASISFUN-023、校验接口入参4、文件格式识别及转换处理8、重新封装输出参数深圳统一电子印章管理平台5、调用平台接口6、记录调用日志7、响应输出结果9、响应输出结果10、解析输出参数,完成接口调用图2文件格式转换流程7.2获取可用印章列表接口7.2.1请求参数说明获取可用印章列表接口请求参数说明见表2,请求参数样例见示例。表2获取可用印章列表接口请求参数说明4参数编码描述类型是否可空是否唯一备
14、注contentgrantCode注册授权码String否是用户被授权时获取的注册授权码organizationCode统一社会信用代码String否是电子印章所属用户的统一社会信用代码systemID第三方应用系统编号String否是用户在电子印章系统注册的系统编号sealType印章类型String否是印章类型应符合DB4403/T383.12023中4.2的要求。参数格式:输入欲查询印章类型编码,可查询一个或多个印章类型是否可用。示例:单个印章:1多个印章:1|2|3|4idCardMark商事主体数据准确性验标记String否是对商事主体法定代表人或负责人证件类型+证件号组合计算的摘要
15、值。证件类型应符合表A.1的要求DB4403/T383.42023表2(续)示例:请求参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,appKey:472b6491a5b04ca2ac140218215f80ba,bsign:FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=,content:grantCode:f9eb06a1498c418594d5864ccd359842,organizationCode:91440300000000166W,systemID:CIS2021-7-27,sea
16、lType:1|2|3|4,idCardMark:g9kk06a1498c418594d5864rrrr3598427.2.2返回参数说明获取可用印章列表接口返回参数见表3,返回参数样例见示例。5参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String否是非空:数据已加密空:数据未加密asign签名值String否是数据完整性验证datasealList印章列表String否是JSONArray格式sealType印
17、章类型String否是印章类型应符合DB4403/T383.12023中4.2的要求sealImg印章样章图片String否是Base64格式sealStatus可用状态String否是Y:可用N:不可用DB4403/T383.42023表3获取可用印章列表接口返回参数说明示例:返回参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,code:T000000,msg:操作成功,appKey:472b6491a5b04ca2ac140218215f80ba,asign:YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm
18、/gMboEs=,data:sealDataList:sealType:1sealImg:KzPIcWdA1A73DCNG1X4OBxfIUtnaDEwAev0kHyRageYzQT9Xp/+jYJ5f.,sealStatus:Y7.3文件格式转换接口7.3.1请求参数说明文件格式转换接口请求参数说明见表4,请求参数样例见示例。6参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记contentsourceFileType输入文件类型Stri
19、ng是是word、excel、html等文件格式fileB64输入文件的Base64格式String是是-destFileType输出文件类型String是是可选格式:PDF、OFD参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-datadestfileB64输出文件Base64格式String否是-destFileType输出文件类型St
20、ring否是可选格式:PDF、OFDDB4403/T383.42023表4文件格式转换接口请求参数说明示例:请求参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,appKey:472b6491a5b04ca2ac140218215f80ba,bsign:FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=,content:sourceFileType:word,fileB64:4suE+ZKxq/m+HFM0qvEeDSRQmNXg6ChSkRrE0FLj6p75+weS/2mytb7HH17FsEP
21、lr/ey.,destFileType:OFD7.3.2返回参数说明文件格式转换接口返回参数说明见表5,返回参数样例见示例。表5文件格式转换接口返回参数说明7DB4403/T383.42023示例:返回参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,code:T000000,msg:成功,appKey:472b6491a5b04ca2ac140218215f80ba,asign:YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=,data:destfileB64:4suE+ZKxq/m+HFM0q
22、vEeDSRQmNT1WgjqbeerXg6ChSkRrE0lZbxPbFL.,destFileType:OFD8系统登录8.1概述系统登录部分包含以下4个接口:获取扫码登录或签名接口:输入使用场景编码、注册授权码、第三方应用系统编号等参数,经过验证后,返回任务ID、二维码的字符串等参数。使用流程见图3;获取扫码状态接口:输入注册授权码、第三方应用系统ID、任务ID等请求参数,返回用户在电子印章系统的移动端应用程序的扫码状态。使用流程见图4;获取扫码登录或扫码签名结果接口:输入注册授权码、第三方应用系统ID、任务ID请求参数,调用本接口,如果是登录,则返回登录人姓名、登录人所属统一社会信用代码
23、、印章类型等信息;如是扫码签名,则返回签名值。使用流程见图5;USBKey介质登录或签名接口:与GB/T352912017的规定保持一致。8第三方应用系统/用户SDK1、准备参数2、调用接口API-SEAL-LOGIN-013、校验接口入参8、重新封装输出参数DB4403/T383.42023深圳统一电子印章管理平台4、调用平台接口5、获取数据,组装输出参数6、记录调用日志7、响应输出结果9、响应输出结果10、解析输出参数,完成接口调用图3获取扫码登录或签名流程9DB4403/T383.42023第三方应用系统/用户SDK1、准备参数2、调用接口API-SEAL-LOGIN-023、校验接口入
24、参8、重新封装输出参数深圳统一电子印章管理平台4、调用平台接口5、获取数据,组装输出参数6、记录调用日志7、响应输出结果9、响应输出结果10、解析输出参数,完成接口调用图4获取扫码状态流程10参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记contentgrantCode注册授权码String否是用户被授权时获取的注册授权码第三方应用系统/用户SDK1、准备参数2、调用接口API-SEAL-LOGIN-033、校验接口入参8、重新封装输出
25、参数DB4403/T383.42023深圳统一电子印章管理平台4、调用平台接口5、获取数据,组装输出参数6、记录调用日志7、响应输出结果9、响应输出结果10、解析输出参数,完成接口调用图5获取扫码登录或扫码签名结果流程8.2获取扫码登录或签名接口8.2.1请求参数说明获取扫码登录或签名接口请求参数说明见表6,请求参数样例见示例。表6获取扫码登录或签名接口请求参数说明11参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号S
26、tring是是非空:数据已加密空:数据未加密asign签名值String否是数据完整性验证datasignTaskId任务IDLong否是本次业务分配的任务IDqrCode二维码String否是请求本次业务的二维码,用于电子印章系统的移动端应用程序扫码使用参数编码描述类型是否可空是否唯一备注contentsystemID第三方应用系统编号String否是用户在电子印章系统注册的系统编号scene使用场景编码String否是应符合表A.2的要求data待签名的摘要值String否是待签名的摘要值,若不为空值,则为智能移动终端证书签名场景,且取值来源于GENSIGN-01接口输出DB4403/T3
27、83.42023表6(续)示例:请求参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,appKey:472b6491a5b04ca2ac140218215f80ba,bsign:FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=,content:grantCode:f9eb06a1498c418594d5864ccd359842,systemID:CIS2021-7-27,scene:01,data:H7vEpHHSN3Gve0mVivJufA2CnHZ6+RkeXNoe6T39a6cL4Nvpdd
28、KgQ.8.2.2返回参数说明获取扫码登录或签名接口返回参数见表7,返回参数样例见示例。表7获取扫码登录或签名接口返回参数说明示例:返回参数样例JSON格式。reqId:17497dc4-9c7f-477d-8faa-1d37e2f2ca13,12参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentgrantCode授权码String否是用户被授权时获取的注册授权码systemID第三方应用系统IDString否是用户在电子印章系统注册的系统编号signTaskId任务IDLong否是本次业务分配的任务IDDB4403/T383.42023code:T000000,msg:操作成功,app