DB4403T383.4-2023电子印章 第4部分:应用服务接口_第1页
DB4403T383.4-2023电子印章 第4部分:应用服务接口_第2页
DB4403T383.4-2023电子印章 第4部分:应用服务接口_第3页
DB4403T383.4-2023电子印章 第4部分:应用服务接口_第4页
DB4403T383.4-2023电子印章 第4部分:应用服务接口_第5页
已阅读5页,还剩45页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

ICS35.240.01CCSL67 DB4403CCSL67深 圳 市 地 方 标 准DB4403/T383.4—2023电子印章4Electronicseal—Electronicseal—Part4:Applicationprogramminginterface2023-11-02发布2023-12-01深圳市市场监督管理局发布DB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023目 次前言 III1范围 12规范性引用文件 13术语和定义 14缩略语 15应用接口技术要求 16应用接口清单 27基础功能 37.1概述 3获取可用印章列表接口 4文件格式转换接口 68系统登录 88.1概述 8获取扫码登录或签名接口 11获取扫码状态接口 13获取扫码登录或扫码签名结果接口 14USBKey介质登录或签名接口 169通用签章 169.1概述 169.2生成摘要接口 18智能移动终端证书摘要签名接口 22USBKey证书签名接口 22服务器密码机证书签名接口 229.6签章合成接口 2210验章 2410.1概述 2410.2已签文件验证接口 2510.3印章验证接口 2711集中签章 2911.1概述 2911.2文件上传接口 3211.3签章接口 3311.4文件下载接口 36I附录A(规范性)电子印章应用服务接口参数编码 38A.1证件类型编码 38A.2使用场景编码 38A.3扫码状态编码 38附录B(规范性)电子印章应用服务接口异常信息表 40附录C(规范性)电子印章应用服务接口通用数据结构 42C.1坐标规则结构 42C.2关键字规则结构 42C.3骑缝章规则结构 42参考文献 44IIII前 言本文件按照GB/T1.1—2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定起草。DB4403/T383—20234DB4403/T383—202312——第3部分:业务办理和应用指南;——第4部分:应用服务接口;——第5部分:第三方应用接入要求和测试方法;67本文件由深圳市政务服务数据管理局提出并归口。本文件主要起草人:王志勇、肖永舒、李苏、姚逸滨、谢明康、张报建、罗菁春、黄立、董安波、III(深圳本文件主要起草人:王志勇、肖永舒、李苏、姚逸滨、谢明康、张报建、罗菁春、黄立、董安波、IIIDB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023电子印章第4部分:应用服务接口范围定义等。印章。规范性引用文件(包括所有的修改单适用于本文件。GB/T38540—2020信息安全技术安全电子签章密码技术规范DB4403/T383.1—2023电子印章第1部分:通用要求DB4403/T383.3—2023电子印章第3部分:业务办理和应用指南GB/T38540—2020信息安全技术安全电子签章密码技术规范DB4403/T383.1—2023电子印章第1部分:通用要求DB4403/T383.3—2023电子印章第3部分:业务办理和应用指南3术语和定义DB4403/T383.1—2023和DB4403/T383.3—2023界定的术语和定义适用于本文件。4缩略语下列缩略语适用于本文件。SDK:软件开发工具包(SoftwareDevelopmentKit)HTTP:超文本传输协议(HyperTextTransferProtocol)HTTPS:HTTP(HyperTextTransferProtocoloverSecureSocketLayer)JSON:JS对象标记(JavaScriptObjectNotation)URL:统一资源定位符(UniformResourceLocator)CA:证书认证机构(certificateauthority)PDF:可携带文档格式(PortableDocumentFormat)OFD:开放式版式文档(OpenFixed-layoutDocument)5应用接口技术要求1应用接口按照HTTPS方式访问,采用UTF-8编码,通过HTTPS协议的POST/GET方法提交请求,报文内容采用SM4CBC加密,接口专用参数通过请求正文,按照JSON格式封装提供。应用接口清单应用接口清单见表1。表1应用接口清单分类编号分类接口编号接口名称函数接口说明01基础功能BASISFUN-01获取可用印章列表genGetSealInfoList获取可用电子印章图像数据。BASISFUN-02文件格式转换genFormatFile将word、excel、html等不同格式电子文档,统一转换为PDF或OFD格式。02系统登录LOGIN-01获取扫码登录或签名genGetLoginQRCode获取扫码登录或扫码签名的二维码,然后使用移动端应用程序扫描,完成登录确认或签名确认。LOGIN-02获取扫码状态genGetScanStatusById获取用户在电子印章系统的移动端应用程序扫码时的操作状态。LOGIN-03获取扫码登录或扫码签名结果genGetTaskResult获取在电子印章系统的移动端应用程序扫码登录或扫码签名的结果。LOGIN-04USBKey介质登录或签名与GB/T35291—2017的规定保持一致使用USBKey03通用签章GENSIGN-01生成摘要genCalculateFileHash生成待签章文件的摘要信息。GENSIGN-02智能移动终端证书摘要签名与LOGIN-01接口一致调用智能移动终端证书对摘要进行签名。GENSIGN-03USBKey证书摘要签名与GB/T35291—2017的规定保持一致调用USBKey证书对摘要进行签名。GENSIGN-04服务器密码机证书摘要签名与GB/T35291—2017的规定保持一致调用服务器密码机证书对摘要进行签名。GENSIGN-05签章合成genDetachedFile使用时间戳、加密加签等处理方式,合成签章文件。04验章VERIFY-01已签文件验证genFileVerify及已签文档中所有电子印章或数字签名的签章记录。VERIFY-02印章验证genRecognizeRegionalsSeal验证印章编码、印章类型、发放单位、发放时间等信息。22DB4403/T383.4—2023DB4403/T383.4—20231(续)DB4403/T383.4—2023DB4403/T383.4—20238、重新封装输出参数8、重新封装输出参数响输出 分类编号分类接口编号接口名称函数接口说明05集中签章CENTRALIZED-01文件上传genFileUplode上传PDF或OFD格式待签章文件。CENTRALIZED-02签章genCentralizedSignature查询可用印章接口,获取用户ID和印章编码信息,传入文件数据和签章位置参数,完成签章操作。CENTRALIZED-03文件下载genFileDownload下载已签章文件。基础功能部分包含以下两个接口:号等请求参数,返回用户可用电子印章图像数据。使用流程见图1;SDK深圳统一电子印章管理平台1、准备参数2、调用接口API-SEAL-BASISFUN-013、校验接口入参SDK深圳统一电子印章管理平台1、准备参数2、调用接口API-SEAL-BASISFUN-013、校验接口入参46、记录调用日志7、响应输出结果10、解1获取可用印章列表流程3第三方应用系统/用户2文件格式转换流程获取可用印章列表接口请求参数说明获取可用印章列表接口请求参数说明见表2,请求参数样例见示例。表2获取可用印章列表接口请求参数说明4深圳统一电子印章管理平台深圳统一电子印章管理平台参准参准备参SDK第三方应用系统/用户、 数2、调用接口API-SEAL-BASISFUN-02换处理8、重新封装输出参数9、响应输出结果10、解析输出参数5、6、记录调用日志7、响应输出结果参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记DB4403/T383.4—2023DB4403/T383.4—20232(续)DB4403/T383.4—2023DB4403/T383.4—2023参数编码描述类型是否可空是否唯一备注contentgrantCode注册授权码String否是用户被授权时获取的注册授权码organizationCode统一社会信用代码String否是电子印章所属用户的统一社会信用代码systemID第三方应用系统编号String否是用户在电子印章系统注册的系统编号sealType印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求。或多个印章类型是否可用。示例:单个印章:1多个印章:1|2|3|4idCardMark商事主体数据准确性验标记String否是对商事主体法定代表人或负责人证件类型+证件号组合计算的摘要值。证件类型应符合表A.1的要求示例:示例:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13"","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842", "organizationCode":"91440300000000166W","systemID":"CIS2021-7-27","sealType":"1|2|3|4","idCardMark":"g9kk06a1498c418594d5864rrrr359842"}]}7.2.2返回参数说明获取可用印章列表接口返回参数见表3,返回参数样例见示例。5表3获取可用印章列表接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String否是非空:数据已加密空:数据未加密asign签名值String否是数据完整性验证datasealList印章列表String否是JSONArray格式sealType印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求sealImg印章样章图片String否是Base64格式sealStatus可用状态String否是Y:可用N:不可用示例:返回参数样例JSON格式。{"code":"T000000","msg"appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{"sealDataList":[{"sealType":"1""sealImg":"KzPIcWdA1A73DCNG1X4OBxfIUtnaDEwAev0kHyRageYzQT9Xp/+jYJ5f. ","sealStatus":"Y"}]}]}文件格式转换接口请求参数说明见表4,请求参数样例见示例。6DB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023DB4403/T383.4—2023表4文件格式转换接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记contentsourceFileType输入文件类型String是是word、excel、html等文件格式fileB64输入文件的Base64String是是-destFileType输出文件类型String是是可选格式:PDF、OFD示例:请求参数样例JSON格式。{"sourceFileType":"word","fileB64":" 4u"sourceFileType":"word","fileB64":" 4u+Kq+F0veRmX6hREFjp+e/mtH1FEley. ""destFileType":"OFD"}]}7.3.2返回参数说明文件格式转换接口返回参数说明见表5,返回参数样例见示例。表5文件格式转换接口返回参数说明7参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-datadestfileB64输出文件Base64格式String否是-destFileType输出文件类型String否是可选格式:PDF、OFD示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":{"destfileB64":"4suE+ZKxq/m+HFM0qvEeDSRQmNT1WgjqbeerXg6ChSkRrE0lZbxPbFL ","destFileType":"OFD"}}系统登录部分包含以下4个接口:过验证后,返回任务ID、二维码的字符串等参数。使用流程见图3;子印章系统的移动端应用程序的扫码状态。使用流程见图4;——获取扫码登录或扫码签名结果接口:输入注册授权码、第三方应用系统ID、任务ID子印章系统的移动端应用程序的扫码状态。使用流程见图4;——获取扫码登录或扫码签名结果接口:输入注册授权码、第三方应用系统ID、任务ID——USBKey介质登录或签名接口:与GB/T35291—2017的规定保持一致。8深圳统一电子印章管理平台深圳统一电子印章管理平台准SDK第三方应用系统/用户准SDK第三方应用系统/用户1、备参数2、调用接口API-SEAL-LOGIN-013、校验接口入参8、重新封装输出参数9、响应输出结果10、解析输出参数4、5、获取数据,组装输出参数6、记录调用日志7、响应输出结果3获取扫码登录或签名流程9深圳统一电子印章管理平台深圳统一电子印章管理平台准SDK第三方应用系统/用户准SDK第三方应用系统/用户1、备参数2、调用接口API-SEAL-LOGIN-023、校验接口入参8、重新封装输出参数9、响应输出结果10、解析输出参数4、5、获取数据,组装输出参数6、记录调用日志7、响应输出结果4获取扫码状态流程10图5获取扫码登录或扫码签名结果流程图5获取扫码登录或扫码签名结果流程获取扫码登录或签名接口请求参数说明获取扫码登录或签名接口请求参数说明见表6,请求参数样例见示例。表6获取扫码登录或签名接口请求参数说明11深圳统一电子印章管理平台深圳统一电子印章管理平台准SDK第三方应用系统/用户准SDK第三方应用系统/用户1、备参数2、调用接口API-SEAL-LOGIN-033、校验接口入参8、重新封装输出参数9、响应输出结果10、解析输出参数4、5、获取数据,组装输出参数6、记录调用日志7、响应输出结果参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记contentgrantCode注册授权码String否是用户被授权时获取的注册授权码表6(续)参数编码描述类型是否可空是否唯一备注contentsystemID第三方应用系统编号String否是用户在电子印章系统注册的系统编号scene使用场景编码String否是应符合表A.2的要求data待签名的摘要值String否是待签名的摘要值,若不为空值,则为智能移动终端证书签名场景,且取值来源于GENSIGN-01接口输出示例:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842","systemID":"CIS2021-7-27","scene":"01",}]}8.2.2返回参数说明获取扫码登录或签名接口返回参数见表7,返回参数样例见示例。表7获取扫码登录或签名接口返回参数说明}]}8.2.2返回参数说明获取扫码登录或签名接口返回参数见表7,返回参数样例见示例。表7获取扫码登录或签名接口返回参数说明示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13",12参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是数据完整性验证datasignTaskId任务IDLong否是本次业务分配的任务IDqrCode二维码String否是用于电子印章系统的移动端应用程序扫码使用"code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{"signTaskId":"611606252505817088","qrCode":"PYvRTzaT9ZFN11KDbBKzqXD4CWpkYN8UvHWvdmiwmOAjP3EF "}]}获取扫码状态接口请求参数见表8,请求参数样例见示例。表8获取扫码状态接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentgrantCode授权码String否是用户被授权时获取的注册授权码systemID第三方应用系统IDString否是用户在电子印章系统注册的系统编号signTaskId任务IDLong否是本次业务分配的任务ID示例:示例:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842","systemID":"CIS2021-7-27","signTaskId":"611606252505817088"}]}8.3.2返回参数说明获取扫码状态接口返回参数见表9,返回参数样例见示例。13表9获取扫码状态接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString是是来源于入参请求IDcode返回代码String是是应符合表B.1的要求msg返回消息String是是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String是是-datascanStatus扫码状态String是是应符合表A.3的要求示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{}]}获取扫码登录或扫码签名结果接口}]}获取扫码登录或扫码签名结果接口请求参数说明获取扫码登录或扫码签名结果接口请求参数说明见表10,请求参数样例见示例。表10获取扫码登录或扫码签名结果接口请求参数说明示例:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13",14参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentgrantCode授权码String否是用户被授权时获取的注册授权码systemID第三方平台系统IDString否是用户在电子印章系统注册的系统编号signTaskId签名任务IDLong否是本次业务分配的任务ID"appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842","systemID":"CIS2021-7-27","signTaskId":"611606252505817088"}]}8.4.2返回参数说明获取扫码登录或扫码签名结果接口返回参数说明见表11,返回参数样例见示例。表11获取登录结果或签名结果接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-dataname登录人姓名String否是-organizationCode登录人所属商事主体的统一社会信用代码String否是-sealType印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求signValue签名值String否是摘要的签名值示例:示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":{"sealImg":"DJFLKSJFJSKXCNV. ","name":"张*","organizationCode":"914403*****000166W","sealType":"1",}}158.5USBKey介质登录或签名接口按GB/T35291—2017的规定提供。通用签章接口的调用顺序见图6,包含以下5个接口:ID(文档的摘要值、文件ID、文件标题等信息。使用流程见图7;——智能移动终端证书摘要签名接口:与LOGIN-01接口一致;——USBKey证书摘要签名接口:与GB/T35291—2017的规定保持一致;——服务器密码机证书摘要签名接口:与GB/T35291—2017的规定保持一致;ID件。使用流程见图8。第一步:API‐SEAL‐GENSIGN‐01第一步:API‐SEAL‐GENSIGN‐01(生成摘要)接口第二步,根据印章介质类型,选择以下接口之一:接口接口接口接口图6通用签章接口调用顺序16第三方应用系统/用户 SDK 深圳统一电子印章管理平台第三方应用系统/用户SDK深圳统一电子印章管理平台准备参、 数准备参参参

文件列表规则定义6、调用平台接口7、校验用户身份及权限8、获取用户电子印章结构体9、组装输出参数,记录调用日志10、响应输出结果11、解析印章结构体12、根据单位规则及规则定义,合成新的PDF/OFD文档13、计算新PDF/OFD文档摘要14、组装输出参数15、响应输出结果16、解析输出参数,完成接口调用图7生成摘要流程17第三方应用系统/用户 SDK 深圳统一电子印章管理平台第三方应用系统/用户SDK深圳统一电子印章管理平台准备参、 数准备参2、调用接口API-SEAL-GENSIGN-053、校验接口入参4、校验待签文件列表5、调用平台接口

6、校验用户身份及权限7、获取用户电子印章结构体8、组装输出参数,记录调用日志9、响应输出结果12、调用平台接口12、调用平台接口13、校验用户身份及权限14、时间戳签名处理15、组装输出参数,记录调用日志16、响应输出结果19、响应输出结果20、解析输出参数,完成接口调用8签章合成流程生成摘要接口请求参数说明生成摘要接口请求参数说明见表12,请求参数样例见示例。18表12生成摘要接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId应用IDString否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是数据完整性验证标记contentgrantCode授权码String否是用户被授权时获取的注册授权码organizationCode用户统一社会信用代码String否是电子印章所属用户的统一社会信用代码systemID第三方平台系统IDString否是第三方平台注册深圳市电子印章系统时留存的平台编号scene使用场景编码String否是应符合表A.2的要求sealDataList待签数据集合String否是待签数据集合,说明如下:可支持批量文件摘要计算,批3030Mscene01fileStr待签章文件String否是PDF或OFD文件转BASE64格式sealType电子印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求version版本号String否是默认值:1.0ruleType规则类型String是是RECTANGLE:坐标定位KEYWORD:关键字定位rectangleRule坐标规则rectangleRule结构否是若ruleTypeRECTANGLE应符合表C.1的要求keyWordRule关键字规则keyWordRule结构否是若ruleType为KEYWORD,则必传;应符合表C.2的要求acrossRule骑缝章规则acrossRule结构否是应符合表C.3的要求fileUniqueId文件唯一IDString否是返回文件的唯一ID,非空则由用户自定义,否则系统自定义。title每个文件的标题String否是用户自定义文件场景描述fileStr待签章文件String否是文件转Base64格式(若传了此字段则sealDataList所有的fileStr都将被覆盖)sealType电子印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求1919示例:示例:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842","organizationCode":"91440300000000166W","systemID":"CIS2021-7-27","fileStr"2QQmMCIp2VBXIiSyCKWpU9SZaLKDJleZjm2OHJrmMyfu4dDIE ","sealType":"1","ruleInfo":[{"version":"01","ruleType":"RECTANGLE",20表12(续)content参数编码描述类型是否可空是否唯一备注ruleInfoString否是此字段仅仅适用于ruleType=RECTANGLE方式定位;若传了此字段则sealDataList所有的releinfo对应的字段将被覆盖version版本号String否是默认值为1.0ruleType规则类型String否是RECTANGLE坐标rectangleRule坐标规则rectangleRule结构否是应符合表C.1的要求searchType介质类型String否是01:智能移动终端介质02:USBKey介质03:服务器密码机介质默认值为01ukeyNoUSBKey编号String否是searchType02置为-1ukeyProviderUSBKey提供商String否是当searchType02USBKey提供商的标识;否则,设置为-1mediaNoUSBKey序列号或加密机型号String否是当searchType02USBKeysearchType03-1clientSource终端标识String否是1:微信小程序2:USBKey3:服务器密码机4:i深圳App"rectangleRule":[{……}],"keyWordRule":[{……}],"acrossRule":[{……}]}],"searchType":"01","ukeyNo":"0000001","ukeyProvider":"BJCA","mediaNo":"0000005","clientSource":"miniProgram"}]}9.2.2返回参数说明生成摘要接口返回参数说明见表13,返回参数样例见示例。示例:返回参数样例JSON格式。{示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{"fileHashList":[{"fileHash":"DFGSD=SDFSFSF-S=SFSDF+SDFSFSFSFSFSF9SFDSF6SFSFD5SDFKJS565…","fileUniqueId":"u8GN1CHqrrhZT56YXf3Gl5eeePq5Nwdro4bpTnDqwR5f/9Li","title":"测试文件"}]}]}21参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-datafileHashList文件摘要集合String否是-fileHash文件摘要String否是-fileUniqueId文件唯一IDString否是-title文件标题String否是-智能移动终端证书摘要签名接口应与8.2节的规定一致。USBKey应与GB/T35291—2017的规定一致。服务器密码机证书签名接口应与GB/T35291—2017的规定一致。签章合成接口请求参数说明签章合成接口请求参数说明见表14,请求参数样例见示例。表14签章合成接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentgrantCode授权码String否是用户被授权时获取的注册授权码organizationCode用户统一社会信用代码String否是电子印章所属用户的统一社会信用代码systemID第三方平台系统IDString否是第三方平台注册深圳市电子印章系统时留存的平台编号scene智能移动终端介质用章场景String否是应符合表A.2的要求sealDataList待签数据集合String否是待签数据集合。注意:1)3030M2)scene为01不支持批量sealType电子印章类型String否是印章类型应符合DB4403/T383.1—2023中4.2的要求fileUniqueId文件唯一IDString否是-signTaskId签名任务IDLong否是-signValue签名值String否是当不为空值时,则为智能移动终端证书签名场景示例:示例:请求参数样例JSON格式。22{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"grantCode":"f9eb06a1498c418594d5864ccd359842","organizationCode":"91440300000000166W","systemID":"CIS2021-7-27","scene":"01","sealDataList":[{"sealType":"1","fileUniqueId":"u8GN1CHqrrhZT56YXf3Gl5eeePq5Nwdro4bpTnDqwR5f/9Li"}],"signTaskId":"611606252505817088","signValue":"sC2QQmMCIp2VBXIiSyCKWpU9SZaLKDJleZjm2OHJrmMyfu4d67D9GdMkE……",}]}返回参数说明签章合成接口返回说明参数见表15,返回参数样例见示例。表15合成已签章文件接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-data返回数据体JSON否是-datafileList合成后的文件集合JSONArray否是-fileUniqueId文件唯一IDString否是-fileB64文件Base64格式String否是签章后的PDF或OFD文件示例:示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{"fileList":[{23"fileUniqueId":"u8GN1CHqrrhZT56YXf3Gl5eeePq5Nwdro4bpTnDqwR5f/9Li","fileB64":"sC2QQmMCIp2VBXIiSyCKWpU9SZaLKDJleZjm2OHJrmMyfu4d67D9 "}]}]}验章概述验章部分包含以下2个接口:章签发单位等。使用流程见图9;第三方应用系统/用户SDK深圳统一电子印章管理平台——印章验证接口:输入印章结构体请求参数,返回印章的验证信息,包括印章编码、印章类型、发放单位、发放时间等。使用流程见图10。第三方应用系统/用户SDK深圳统一电子印章管理平台1、备参数223、校验接口入参6、校验用户身份及权限11、组装返回参数9已签文件验证流程24第三方应用系统/用户 SDK 深圳统一电子印章管理平台第三方应用系统/用户SDK深圳统一电子印章管理平台准备参、 数准备参2、调用接口API-SEAL-VERIFY-013、校验接口入参4、解析待验证文档5、分析解析数据,如签名有效性电子印章数据、时间戳、电子签名等6、调用平台接口

7、校验用户身份及权限10、响应输出结果11、解析响应参数,获取印章信息12、组装返回参数14、解析输出参数图1014、解析输出参数图10印章验证流程已签文件验证接口请求参数说明已签文件验证接口请求参数说明见表16,请求参数样例见示例。表16已签文件验证接口请求参数说明示例:请求参数样例JSON格式。25参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentfileName文件名称String否是-fileBase64文件Base64格式String否是格式为PDF或OFD{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=", "content":{"fileName":"xxxx文件","fileBase64":"SsISiQlDpgFjJwTgQA7ELid7ZJBNuOBiaAvsjMmNDepmQu0Nlg4VTj9+. " }}10.2.2 返回参数说明已签文件验证接口返回参数说明见表17,返回参数样例见示例。表17已签文件验证接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密标识String否是非空:需要加密空:不加密(对data加密)asign签名值String否是-dataverifyStatus验证结果true:成功false:失败String否是-verifyMsg验证消息String否是-verifyList验证列表String否是-statustrue:有效false:无效String否是-ssuerSealUnit制章者String否是电子印章签发单位sealUnit印章所有者String否是-organizationCode统一信用代码String否是-sealType印章类型String否是-sealName印章名称String否是-sealCode印章编码String否是-sealImg印章图片String否是-sealDate签名/签章时间String否是-version版本号String否是-serialNumber证书序列号String否是-sigAlg算法(如SM2)String否是-2626表17(续)参数编码描述类型是否可空是否唯一备注DataissuerDN证书认证机构String否是-subjectDN证书使用者String否是-notBefore证书有效期起String否是-notAfter证书有效期止String否是-sealNotBefore印章有效期起String否是-sealNotAfter印章有效期止String否是-示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":{ "verifyStatus":"true", "status":"true", "issuerSealUnit "sealUnit "organizationCode":"91440300000000166W", "sealType":"1", "sealName "sealCode":"123456789", "sealDate":"2022-02-1012:00:00", "version":"V3", "serialNumber":"11007f1b0abf9018", "sigAlg":"SM2", "issuerDN":"Gomain", "subjectDN":"44030100001560", "notAfter":"2022-02-2200:58:59", "notBefore":"2021-02-2123:59:59", "sealNotAfter":"2022-02-2200:58:59", "sealNotBefore":"2021-02-2123:59:59"}]}}印章验证接口请求参数说明27印章验证接口请求参数说明见表18,请求参数样例见示例。表18印章验证接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String否是UUIDappKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密bsign签名String否是-contentgbSealData印章结构体String否是印章结构体的Base64格式应符合GB/T38540的要求示例:请求参数样例JSON格式。{"reqId":"61a5d847-8697-4b17-a2f5-b35851370ecb","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"gbSealData":"4dsd6saf4d6fdf54DHFAJKDFHAdjklfj4465dfdshfkjhj. "}]10.3.2 返回参数说明印章验证接口返回参数说明见表19,返回参数样例见示例。表19印章验证接口返回参数说明10.3.2 返回参数说明印章验证接口返回参数说明见表19,返回参数样例见示例。表19印章验证接口返回参数说明示例:返回参数样例JSON格式。{28参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString否是来源于入参请求IDcode返回代码String否是应符合表B.1的要求msg返回消息String否是应符合表B.1的要求appKey传输数据加密密钥编号String是是非空:数据已加密空:数据未加密asign签名值String否是-datasealCode印章编码String否是-sealType印章类型String否是-sealIssueUnit发放单位String否是-sealIssueTime发放时间String否是-sealValidStart有效期(起始)String否是-sealValidEnd有效期(结束)String否是-sealStatus印章状态String否是-sealInvalidReason失效原因String是是-"reqId":"61a5d847-8697-4b17-a2f5-b35851370ecb","code":"T000000","msg":"成功","appKey":"472b6491a5b04ca2ac140218215f80ba","asign":"YYcCHlUJqZz1X6OGc1Zj2HPCoBOR6IR476Xm/gMboEs=","data":[{"sealCode":"20220702369865452545","sealType":"1","sealIssueUnit":"北京","sealIssueTime":"2022-07-02","sealValidStart":"2022-07-02","sealValidEnd":"2023-07-01","sealStatus":"0","sealInvalidReason":"",}]}集中签章概述集中签章部分包含以下3个接口:集中签章部分包含以下3个接口:流程见图11;Base64路径。使用流程见图12;13。29文文深圳统一电子印章管理平台API的文档第三方应用系统/用户2.3.文件上传至印章平台4.文件/PDF5.返回上传件所在的路径11文件上传流程30第三方应用系统/用户第三方应用系统/用户深圳统一电子印章平台章章编码API1.‐签章接口入参,签章接口入参3.文件签章4.生成签路径5.返的文件路径313.4.深圳统一电子印章平台API第三方应用系统/用户文件上传接口请求参数说明文件上传接口请求参数说明见表20,请求参数样例见示例。文件上传接口请求参数说明文件上传接口请求参数说明见表20,请求参数样例见示例。表20文件上传接口请求参数说明示例:请求参数样例JSON格式。{32参数编码描述类型是否可空是否唯一备注reqId请求流水号String是是UUIDappKey传输数据加密标识String是是传输数据加密标识bsign签名String是是数据完整性验证标记contentuserId用户唯一标识String否是用户唯一标识fileBase64待签章文件List是否待签章文件。将文件读取为byte数组后使用BASE64编码为StringfileType文件类型Int是否可支持文件类型:1:PDF2:OFD3:PNG4:JPG5:DOC/DOCX"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appkey":”472b6491a5b04ca2ac140218215f80ba”,"bsign":”FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"userId":"ex89nf0kt0l4q2s8s5fj1g","fileBase64":[{"0":"SsISiQlDpgFjJwTgQA7ELid7ZJBNuOBiaAvs "}], "fileType":"3"}]}11.2.2 返回参数说明文件上传接口返回参数说明见表21,返回参数样例见示例。表21文件上传接口返回参数说明参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString是是来源于入参请求IDcode返回代码String是否应符合表B.1的要求msg返回消息String是否应符合表B.1的要求datalayoutPath待签文件路径String是是-示例:返回参数样例JSON格式。{示例:返回参数样例JSON格式。{"reqId":"33c8c6af-b3c7-4f12-a9e9-b4a80ca3800d","msg":"成功","code":"T000000","data":[{"layoutPath":"esus/api/2022/7/31/f79f0b-74478443.pdf"}]}签章接口请求参数说明签章接口请求参数说明见表22,请求参数样例见示例。表22签章接口请求参数说明33参数编码描述类型是否可空是否唯一备注reqId请求流水号String是是UUIDappKey传输数据加密标识String是否非空:需要加密(对content加密)空:不加密bsign签名String是是-表22(续)参数编码描述类型是否可空是否唯一备注contentoutUserId用章人IDString是是-title为文档设置的标题String100)是否过该参数为每个文档设置不同的标题,以便后续对文档进行检索siteId固定值100Long是否-signatoriesList:多个签章信息签约模板编号pageint是否该签署用户在签约模板中的编号(从1sigerIndex出模板签署用户签署控件列表接口x坐标xfloat否否x坐标y坐标yfloat否否y坐标电子印章编号sealIdString否是该签署用户在签署时使用电子印章编号orderId业务订单号String否是-fileBase64待签文件流String否否待签文件,为BASE64编码格式,与documentPath各选其一documentPath待操作的文件路径String是否layoutPath,与fileBase64示例1:示例1:请求参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"outUserId":"999999", "title":"证照测试","siteId":100,"signatoriesList":[{"x":0.3,"y":0.3,"page":1,"sealId":"11010009030305",}],"orderId":"B8B7F642A6044537A56E274503778B11","fileBase64":"JVBERi0xLjcNCiWhs8XXDQoxIDAgb2JqDQo8PC9UeXB "}]}示例2:请求参数样例JSON格式。34{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appKey":"472b6491a5b04ca2ac140218215f80ba","bsign":"FFW/OV9s5EBLtjAfvhLownl0MxUQTx1URasnJRhU/IU=","content":[{"outUserId":"999999","title":"证照测试", "siteId":10000, "signatoriesList":[{"x":0.3,"y":0.3,"page":1,"sealId":"11010009030305",}],"orderId":"B8B7F642A6044537A56E274503778B11","documentPath":"esus/api/2022/7/31/f79f8443.pdf"}]}签章接口返回参数说明见表23,返回参数样例见示例。表23签章接口返回参数说明示例:签章接口返回参数说明见表23,返回参数样例见示例。表23签章接口返回参数说明示例:返回参数样例JSON格式。{"reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","code":"T000000","msg":"操作成功","appKey":"KFLWYXSAKDLO","asign":"FGG6F4D+4GE","data":{"layoutPath":"esus/common/esus/sign/2022/09/29/1482354850904565.pdf"}}35参数编码描述类型是否可空是否唯一备注reqId唯一请求IDString是是来源于入参请求IDcode返回代码String是否应符合表B.1的要求msg返回消息String是否应符合表B.1的要求appKey传输数据加密标识String是是非空:需要加密空:不加密(对data加密)asign签名值String是是-datalayoutPath已签文件下载路径String是是-文件下载接口请求参数说明文件下载接口请求参数说明见表24,返回参数样例见示例。表24文件下载接口请求参数说明参数编码描述类型是否可空是否唯一备注reqId请求流水号String是是UUIDappKey传输数据加密标识String是是传输数据加密标识bsign签名String是是数据完整性验证标记contentdocumentPath待操作的文档路径String是是签章后的文件下载路径,来源于签章接口返回的layoutPathsiteId分配给业务系统的IDLong是否分配给业务系统的ID示例:请求参数样例JSON格式。{ "reqId":"17497dc4-9c7f-477d-8faa-1d37e2f2ca13","appkey":"472b6491a5b04ca2ac140218215f80ba", "content":{ "content":{"documentPath":"esus/api/2022/8/24/70a-40f7-affb-087bb708.pdf","siteId":"10000" }}11.4.2 返回参数说明文件下载接口返回参数说明见表25,请求参数样例见示例。表25文件下载接口返回参数说明示例:返回参数样例JSON格式。{"reqId":"b1ef7c15-6af9-414b-8bbd-e5aa63508436","code":

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论