《电子印章公共服务平台云端集中用印模式政务网、互联网、兼容标准自建用印模式接入接口定义及示例.docx》由会员分享，可在线阅读，更多相关《电子印章公共服务平台云端集中用印模式政务网、互联网、兼容标准自建用印模式接入接口定义及示例.docx（32页珍藏版）》请在三一办公上搜索。
1、附录A（规范性）云端集中用印模式政务网接入接口定义及示例A.1创建个人页面签署A.1.1接口说明接口协议：HTTPS协议。请求方式：POSToContent-Type：multipart/form-data;charset=UTF-8。接口地址：sync/create/personaloA.1.2请求消息请求消息说明见表A.1。表A.1名称类型是否必填描述fileFile是pdf/ofd文档（30M限制）titleString否电子文档名称PersonNameString是用户姓名contactString是联系方式，手机号cardnoString否身份证号，标识用户身份，尽量传入SealDa
2、taString否Base64印章数据（根据contact进行查询，若查询到印章数据则使用平台内印章，若没查询到印章数据则使用传入的SealData）StamperStrString否签署位置预设置，如：x:0.4JyjO.4,pageZ2needVerifyBoolean否是否需要校验身份，默认true,校验身份SuccessPageString否签署成功后的页面跳转地址（前端跳转地址）注意：需添加请求协议A.1.3签署位置参数(StamperStr)A.1.3.1根据坐标指定签署位置，参数说明见表A.2：表A.2名称类型是否必填描述XDouble是印章横坐标占比，左下角为原点（Ofd签署时
3、，左上角为原点）yDouble是印章纵坐标占比，左下角为原点（Ofd签署时，左上角为原点）pageDouble是印章签署所在页参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）x：0.4,V：0.4,page:1A.1.3.2根据关键字指定签署位置，参数说明见表A.3。表A.3名称类型是否必填描述keywordString是关键字offsetXDouble否关键字X坐标偏移量（占页宽比）offsetYDouble否关键字Y坐标偏移量（占页高比）keyIndexint否关键字索引（关键字在全文出现多次，选择出现的位置，默认1为第一次出现的位置,0为所有关键字出现的位置）参数示例：（全文搜
4、索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的0.1,向下偏移页高长度的0.1）。keyword:申万，“offsetX”:-0.1,“offsetY”:-0.1,“keylndcx”:2）创建多个签署位置参数示例。x：0.4,V：0.4,lpage:1）,（keyword:申万，offsetX”:-0.1,offsetY”:-0.1,“keyindex”:2code”:O,/0：成功，其余失败documentId:2545462971542704132”,文档idmessage:SUCCESS”,成功失败信息签署页面地址）A.2创建印章页面签署A.2.1接口说明接口协议：HnPS
5、协议。请求方式：POSTeContent-Type：multipart/form-data;charset=UTF-8。接口地址：sync/create/company0A.2.2请求消息请求消息说明见表A.4o表A.4名称类型是否必填描述fileFile是PDF/OFD文档（30M限制）titleString否电子文档名称contactString是联系方式，手机号，用于签署时校验身份（使用零信任签署人工确认时校验方式为确认人手机号，可不传，确认人为Ukey时需要插入Ukey确认签署）StamperStrString否签署位置预设置，如：x”:0.4,/:0.4,page:2needVeri
6、fyBoolean否是否需要校验身份，默认IrUe,校验身份SuccessPageString否签署成功后的页面跳转地址（前端跳转地址）sealIdsString否服务端印章编号，可从门户系统获取印章编号，格式：1222222222,333333322222（注比:1、Ofd签署时,相应印章需要有对应国办印章2、使用零信任接口签署，系统确认，人工确认授权功能的时候,不支持传入多个不同的印章，且同步签署不支持使用人工确认方式的印章）SerialNumString否零信任接口签署系统权限校验流水号（与权限校验token同时传入）PermissionTokenString否零信任接II签署系统确认权
7、限校验tokenA.2.3签署位置参数（StamperStr）A.2.3.1根据坐标指定签署位置，参数说明见表A.5。表A.5名称类型是否必填描述XDouble是印章横坐标占比，左下角为原点（Ofd签署时，左上角为原点）yDouble是印章纵坐标占比，左下角为原点（Ofd签署时，左上角为原点）pageDouble是印章签署所在页参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）x:0.4,V：0.4,page:1A.2.3.2根据关键字指定签署位置，参数说明见表A.6。表A.6名称类型是否必填描述keywordString是关键字offsetXDouble否关键字X坐标偏移量（占页宽比
8、）offsetYDouble否关键字Y坐标偏移量（占页高比）keyIndexint否关键字索引（关键字在全文出现多次，选择出现的位置，默认1为第一次出现的位置,0为所有关键字出现的位置）参数示例：（全文搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的0.1,向下偏移页高长度的0.1）keyword:甲方，“offsetX”:-0.1,“offsetY”:-0.1,“keyindex”:2）创建多个签署位置参数示例：x:0.4,V：0.4,page:1）,（keyword:申万，offsetX”:-0.1,“offsetY”:-0.1,“kcylndex”:2A.2.4响应消息（co
9、de:0,/0：成功，其余失败documentId:2545462971542704132”,文档idmessage:SUCCESS”,成功失败信息签署页面地址）A.3创建ukey页面签署A.3.1接口说明接口协议：HnPS协议。请求方式：POST0Content-Type：multipart/form-data;charsct=UTF-8。接口地址：sync/create/ukey（A.3.2请求消息请求消息说明见表A.7。表A.7名称类型是否必填描述fileFile是PDF/OFD文档（30M限制）titleString否电子文档名称StamperStrString否签署位置预设置，如:x
10、:0.4,y”:0.4,pageSuccessPageString否签署成功后的页面跳转地址（前端跳转地址）A.3.3签署位置参数StamPerStrA.3.3.1根据坐标指定签署位置，参数说明见表A.8。表A.8名称类型是否必填描述XDouble是印章横坐标占比，左下角为原点（Ofd签署时，左上角为原点）yDouble是印章纵坐标占比，左下角为原点（Ofd签署时，左上角为原点）pageDouble是印章签署所在页参数示例：（文件第一页，X占页宽04,Y占页高0.4处）（x”:0.4,V：0.4,A.3.3.2根据关键字指定签署位置，参数说明见表A.9。表A.9名称类型是否必填描述keywor
11、dString是关键字offsetXDouble否关键字X坐标偏移量（占页宽比）OffsetYDouble否关键字Y坐标偏移量（占页高比）keyIndexint否关键字索引（关键字在全文出现多次，选择出现的位置，默认1为第一次出现的位置,0为所有关键字出现的位置）参数示例：(全文搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的0.1,向下偏移页高长度的0.1)keyword:申万，offsetX”:-0.1,offsetY”:-0.1,“keyindex”:2U创建多个签署位置参数示例x:0.4,V：0.4,page:1),(keyword:申万，offsetX”:-0.1,off
12、setY”:-0.1,“keyindex”:2)A.3.4响应消息(code:0,/0：成功，其余失败documentId:2545462971542704132”,文档id“message:SUCCESS”,/成功失败信息签署页面地址A.4创建个人静默签署接口协议：HnPS协议。请求方式：POST0Content-Type：multipart/form-data;charset=UTF-8接口地址：synccreatepersonalautosign,A.4.2请求消息请求消息说明见表A.10。表A.10名称类型是否必填描述fileFile是pdf/ofd文档（30M限制）titleStri
13、ng否电子文档名称PersonNameString是用户姓名contactString是联系方式，手机号cardnoString否身份证号，标识用户身份，尽量传入SealDataString否Base64印章数据（根据ContaCt进行查询，若查询到印章数据则使用平台内印章，若没查询到印章数据则使用传入的sealData）StamperStrString是签署位置预设置，如：*x0.4,V:0.4,*page*:2A.4.3签署位置参数StanlPerStrA.4.3.1根据坐标指定签署位置，参数说明见表A.11。表A.11名称类型是否必填描述XDouble是印章横坐标占比，左下角为原点（Of
14、d签署时，左上角为原点）yDouble是印章纵坐标占比，左下角为原点（Ofd签署时:左上角为原点）pageDouble是印章签署所在页参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）x：0.4,V：0.4,page:1）A.4.3.2根据关键字指定签署位置，参数说明见A.12。名称类型是否必填描述keywordString是关键字offsetXDouble否关键字X坐标偏移量（占页宽比）offsetYDouble否关键字丫坐标偏移量（占页高比）keyIndexint否关键字索引（关键字在全文出现多次，选择出现的位置，默认1为第一次出现的位置,0为所有关键字出现的位置）参数示例：（全文
15、搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的0.1,向下偏移页高长度的0.1）keyword:申万，“offsetX”:-0.1,“offsetY”:-0.1,“keylndcx”:2创建多个签署位置参数示例：x:0.4,V：0.4,page:1）,（keyword:申万，“offsetX”:-0.1,“offsetY”:-0.1,“keylndcx”:2UA.4.4响应消息（code”:0,/0：成功，其余失败documentId:2545462971542704132”,文档idmessage:SUCCESS成功失败信息）A.5创建印章静默签署A.5.1接口说明接口协议：H
16、nPS协议。请求方式：POSToContent-Type：multipart/form-data;charset=UTF-8。接口地址：sync/create/company/autosign。请求消息说明见表A.13。表A.13名称类型是否必填描述fileFile是PDF/OFD文档（30M限制）titleString否电子文档名称contactString否联系方式，手机号StamperStrString是签署位置预设置，如：*x*:0.4,y”:0.4,page:2,*sealld*:2562988511221907462（使用零信任接口签署，系统确认，人工确认授权功能的时候,不支持传入
17、多个不同的印章，且同步签署不支持使用人工确认方式的印章）SerialNumString否零信任接口签署系统权限校验流水号（与权限校验token同时传入）PermissionTokenString否零信任接口签署系统确认权限校验tokenA.5.3签署位置参数StamPerStrA.5.3.1根据坐标指定签署位置，参数说明见表A.14。表A.14名称类型是否必填描述XDouble是印章横坐标占比，左卜角为原点（Ofd签署时，左上角为原点）yDouble是印章纵坐标占比，左卜角为原点（Ofd签署时，左上角为原点）pageDouble是印章签署所在页sealidLong是签署使用服务端印章编号，可从
18、门户系统获取。（注意：Ofd签署时，相应印章需要有对应国办印章）sealSpecString否修改签署所用印章尺寸，目前仅支持SQUARE_55_55参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）x：0.4,V：0.4,page:1,sealId”:2562988511221907462A.5.3.2根据关键字指定签署位置，参数说明见表A.15。名称类型是否必填描述keywordString是关键字SealCenterBoolean否印章是否居中，默认为false,按照印章左下角定位，设置为true时印章居中offsetXDouble否关键字X坐标偏移量（占页宽比）OffsetYD
19、ouble否关键字Y坐标偏移量（占页高比）keyIndexint否关键字索引（关键字在全文出现多次，选择出现的位置，默认1为第一次出现的位置,0为所有关键字出现的位置）sealIdLong是签署使用服务端印章编号，可从门户系统获取。sealSpecString否设置签署所用印章尺寸，目前仅支持SQUARE_55_55参数示例：(全文搜索关键字“甲方”,选取第二个甲方”，并向左偏移页宽长度的0.1,向下偏移页富长度的0.1)(keyword:甲方，offsetX”:-0.1,offsetr:-0.1,keyindex”:2,sealid:2562988511221907462)创建多个签署位置参
20、数示例：(x：0.4,V：0.4,page:1,sealId”:2562988511221907462),(keyword:甲方,offsetX:-0.1,offsetYyz:-0.1,“keyindex”:2,sealId”:2562988511221907462A.5.4响应消息(code”:0,/0：成功，其余失败documentld:2545462971542704132”,文档idmessage:SUCCESS”成功失败信息)A.6下载签署后电子文档接口协议：HnPS协议。请求方式：GETo接口地址：document/down1oadoA.6.2请求消息documentId：文档id
21、。A.6.3响应消息返回文件流，响应示例：Content-Disposition:attachment;fileName=file.pdfContent-Type:multipart/form-data;charset=utf-8A.7合同状态查询接口A.7.1接口说明接口协议：HnPS协议。请求方式：GEToContent-Type：multipart/form-data接口地址：/contract/StatUSoA.7.2请求消息请求消息说明见表A.16。表A.16名称类型是否必填描述documentIdLong是文档IdA.7.3响应消息响应消息说明见表A.17o名称描述code接口响应
22、状态：0为成功其余失败message成功失败信息result合同状态（COMPLETE,已完成），（EXPIRED,已过期），（DELETE,已删除），（SlGNING,签署中）“result:COMPLETE”,code”:0,“message:SUCCESS”)A.8验签A.8.1接口说明接口协议：HnPS协议。请求方式：POSTo接口地址：pdfverifieroA.8.2请求消息请求消息说明见表A.18。表A18名称类型是否必填描述fileFile是本地pdf文档A.8.3响应消息响应消息说明见表A.19表A.19名称描述ode接Il响应状态：0为成功其余失败message成功失败信息
23、SignaturesNum签名数量hash文档hash值StatusCode签名校验结果0：文件未被修改1：文件已被修改StatusMsg文件信息signatureinfosList<Signaturelnfo>签名信息SignatureInfo说明见A.20。名称描述msg校验结果signatory签约人signTime签约时间SignReason签约原因organization颁发机构StrAlgName签名算法signatureCoversWholeDocument签名是否覆盖全文hasTimeStamp是否有时间戳timeStamp如果有时间戳显示时间VerifyTimes
24、tamp时间戳校验结果CertDateFrom证书有效期开始msg校验结果CertDateTo证书有效期结束VisibleSignature签名是否可见imgString签名外观以base64编码SignType签署类型（CoMPANY:公章签署；PERSONAL:个人签名）cardNo证件号码（公章签署为统一社会信用代码，个人签名为身份证号）msg校验结果code”:0,statusMsg:文件未被修改，“message:SUCCESS,“signaturesNu:2,hash:b45c069ca247a82506e5de85f6c536c8”,“statusCode”:0,“signatu
25、reinfos”:code”:0,msg：校验成功，signatory:测试印章公共服务平台7”,signTimez,:2019-05-0719:01:16”,“SignReason：我同意签署该文件，并承认数字签名的法律效力。,“organization:SHECAG2(UniTrust)z,zzStrAlgName:SHA256”,z,signatureCoversWho1eDocumentz,:false,z,hasTimeStampz,:true,ztimeStamp:2019-05-0719:01:16，z,verifyTimestampz,:true,certDateFronr:2
26、019-04-1113:53:30”,zcertDateTo:2019-07-1123:59:59”,zrVisibleSignature*:true,imgString:data:image/png;base64,iVBORwOKGgoAAAANSU.z,signType:COMPANY,cardNo:XY139402228301182240),(code”:0,msg:校验成功，signatory:测试印章公共服务平台7”,signTime:2019-05-0719:01:16,“signRcason”:我同意签署该文件，并承认数字签名的法律效力。，“organization”:,SHEC
27、AG2(UniTrust)”,StrAlgName:SHA256”,z,signatureCoversWho1eDocument/z:true,hasTimeStamp”:true,timcStamp：2019-05-0719:01:16,“verifyTimcstamp”:true,CertDateFronT:2019-04-ll13:53:30”,certDateTo*:2019-07-1123:59:59，z,visibleSignaturez,:true,imgString:data:image/png;base64,iVBoRwOKGgoAAAANSUhEU.z,z,SignType
28、zz:COMPANY,cardNo:XY139402228301182240)(*fiIeName*:2(7).ofd”,code”:0,flag:true,statusMsg”:文件未被修改，yzSignatureInfos*:(code”:0,msg：校验成功，signatory”:测试上海亘岩科技网络有限公司6,signTime:2020-06-1206:06:13,z,signatureCoversWholeDocument/z:false,“hasTimeStamp”:true,“verifyTimcstamp”:true,certDateFrom:2019-10-1411:55:2
29、9”,certDateTo:2029-10-1411:55:29，“visibleSignaturc”:true,“imgString:data:image/png;base64,iVBORw.).(code”:0,msg：校验成功，signatory”:测试上海亘岩科技网络有限公司6,“signTimc:2020-06-1206:06:14”,z,signatUreCoversWholeDocument/z:false,“hasTimeStamp”:true,“verifyTimcstamp”:true,certDateFrom:2019-10-1411:55:29”,z,certDateT
30、o*:“2029ToT411:55:29”,“visibleSignature”:true,“imgString”:,data:image/png;base64,iVBO.”),“message:SUCCESS”,z,SignaturesNum*:2,hash:7dba4c37b429405568ad2aaebe44ddc9zz,xzStatusCode*:0)A.9批量验签A. 9.1接口说明接口协议：HnPS协议。请求方式：POST0接口地址：/pdfverifier/zip。B. 9.2请求消息请求消息说明见表A.21。表A.21名称类型是否必填描述fileFile是本地ZiP压缩文件A
31、.9.3响应消息响应消息说明见表.22o表A.22名称描述code接口响应状态：0为成功其余失败fiIeNum包含可验证文件个数message成功失败信息resultList<：AccessResult>：PDF验签信息AccessResult说明见A.23。表A.23名称描述fiIeName文件名称code接口响应状态：O为成功其余失败message成功失败信息SignaturesNum签名数量hash文档hash值StatusCode签名校验结果0：文件未被修改1：文件已被修改StatusMsg文件信息signatureinfosList<SignatUrelnfOAgt;签
32、名信息SignatureInfo说明见A.24。表A.24名称描述code校验结果0：校验成功1：校验失败2：未检验msg校验结果signatory签约人SignTime签约时间SignReason签约原因organization颁发机构StrAlgName签名算法signatureCoversWho1cDocment签名是否覆盖全文hasTimeStamp是否有时间戳timeStamp如果有时间戳显示时间VerifyTimestamp时间戳校验结果CertDateFrom证书有效期开始CertDateTo证书有效期结束VisibleSignature签名是否可见imgString签名外观以b
33、ase64编码SignType签署类型（CoMPAY:公章签署；PERSoAL:个人签名）cardNo证件号码（公章签署为统一社会信用代码，个人签名为身份证号）code”:0,“fiIeNunT:2,message:SUCCESS”,“result”:*fiIeName*:文件.pdf”,code”:0,flag:true,statusMsg:文件未被修改，zjSignatureInfos*:code”:O,msg”：校验成功，,signatory*:刘威”，z,signTimez,:2019-05-0814:15:31”,“signRcason”:我同意签署该文件，并承认数字签名的法律效力。
34、“organization:SHECARapid(UniTrust)”,StrAlgName:SHA256，“signatureCoversWholeDocumentz,:false,“hasTiIneStanlP：true,“timestamp:2019-05-0814:15:31,*verifyTimestamp，/:true,certDateFrom:2019-05-0814:15:28，certDateTo:2019-05-0814:25:28，z,visibleSignaturezz:true,“imgString”:,data:image/png;base64,iVBOR”，“si
35、gnTypc:PERSONAL,cardNo:33900519810515662X),(code”:0,msg”：校验成功，signatory:测试印章公共服务平台9”,z,signTimez,:2019-05-0814:18:26，“signRcason”:我同意签署该文件，并承认数字签名的法律效力,“organization:SHECAG2(UniTrust)”,“StrAlgNamc”:SHA256，“signatureCoVerSWhOIeDOCUmCnt”:true,“hasTim。StanlP：true,timCStamP：2019-05-0814:18:26，“verifyTim
36、cstamp”:true,yyCertDateFrom:2019-04-1113:58:35，certDateTo:2019-07-1123:59:59”,z,visibleSignaturezz:true,“imgString:data:image/png;base64,iVBORwOKG.z,“signTyp。：COMPANY”,“cardNo:XY139402228301182630,“message:SUCCESS,z,SignaturesNum*:2,hash:Of9c762a11f8442c63fc4f4253cd05c6”,yzStatusCode*:O),(fiIeName:新
37、建.pdf”,code”:O,flag:true,statusMsg:文件未被修改”，yzSignatureInfos*:code”:O,msg：校验成功，signatory:刘威，signTime:2019-05-0814:15:31,“signReaso:“我同意签署该文件，并承认数字签名的法律效力。,“organization:SHECARapid(UniTrust)”,StrAlgName7,:“SHA256”,signatureCoversWho1eDocument*:false,“hasTimeStamp”:true,“timcStamp:2019-05-0814:15:31，“v
38、erifyTimcstamp”:true,“CertDateFronT:2019-05-0814:15:28”,certDateTo*:2019-05-0814:25:28”,“visibleSignaturc”:true,“imgString”:z,data:image/png;base64,iVBORwOKG.,signTypezz:PERSONAL”,cardNo:33900519810515662X,message:SUCCESS”,“signaturCSNUm”:1,hash”:z，dfcb92b97bl71a7ab813e5d4d9987890，；“statusCode”:0附录B
39、（规范性）云端集中用印模式互联网接入接口定义及示例B.1创建个人电子文档（页面签）8. 1.1接口说明接口协议：HnPS协议。请求方式：POSToContent-Type：multipart/form-data;charset=UTF-8。接口地址：zwdtcreate/personalo8. 1.2请求消息请求消息说明见表B.U表B.1名称类型是否必填描述fileFile是本地PDF文档（30M限制）tenantNameString是用户姓名contactString是联系方式，手机号cardnoString是身份证号，标识用户身份sealString否Base64印章数据（签名所用的印章图
40、片数据，若不传则根据cardno（身份证号）查询系统内的个人签名图片）StamperStrString否签署位置预设置，如：type:*SEAL-PERSONL*,*x*:0.4,*y*:0.4,page*:2fiIeNameString否文件名称downloadboolean否是否允许个人下载（true：允许下载，false：不允许下载，默认为true）previewboolean否是否预览签署后的文件，默认为truetrue：SuccessPage会打开一个新的窗口false：SUCCeSSPage会在当前页面跳转SuccessPageString否签署成功后的页面跳转地址（前端跳转地址）
41、SealAutoAddboolean否签署位置预设置之后，签署页面印章是否自动加盖在预签署位置（默认false）8. 1.3响应消息(code:0,/0：成功，其余失败“documentId：“2545462971542704132”,文档idmessage:SUCCESS”,/成功失败信息签署页面地址B.2创建个人电子文档（静默签）8. 2.1接口说明接口协议：HnPS协议。请求方式：POST0Content-Type：multipart/form-data;charset=UTF-8。接口地址：zwdtcreate/personal/auto/sync8. 2.2请求消息请求消息说明见表B.2。表B2名称类型是否必填描述fileFile是本地PDF文档（30M限制）tenantNameString是用户姓名contactString否联系方式，手机号cardnoString是身份证号，标识用户身份sealString否Base64印章数据（签名所用的印章图片数据，若不传则根据cardno（身份证号）查询系统内的个人签名图片）StamperStrString是签署位置预设置，如：*type*:*SEAL-PERSONAL*,*x*:0.4,*y*:0.4,*page*:2fiIeNameString否文件名称a
