接口描述
使用事件证书对文档进行签署,此签署过程不将文档上传至e签宝平台,只传递文档摘要信息。注:事件证书具有单次有效性,即使用证书完成签署后,此证书立即失效,不可重复使用。
注:文件一旦签名盖章就不可以再进行任何填写或修改操作,否则在验证签署文件有效性时会显示文件被篡改,请在签章前完成所有内容填充。
文件涉及2个及以上签章时,请注意保留待签署文件和每次签署后的文件(含中间过程生成的文件),方便在签署过程中出现失败时如何选择基于哪份文件进行重签。
接口
http://ip:port/tech-sdkwrapper/timevale/sign/eventFileSign
请求方式
POST
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | 示例值 | |
signType | string | 是 | 签章类型, Single(单页签章) Multi(多页签章) Edges(签骑缝章) Key(关键字签章) | ||
certId | int | 是 | 事件证书标识 | ||
sealData | string | 是 | 印章图片base64 | ||
![]() | object | 是 | 签署区信息 | ||
![]() | int | 否 | 定位类型,0坐标定位,1关键字定位,默认0(若为关键字定位,签章类型(signType)必须指定为关键字定位才生效) | ||
![]() | string | 否 | 签署页码, 若为多页签章,支持页码格式“1-3,5,8“, 坐标定位时不可空 | ||
![]() | float | 否 | 签署位置X坐标 | ||
![]() | float | 否 | 签署位置Y坐标 | ||
![]() | string | 否 | 关键字 | ||
![]() | float | 否 | 印章展现宽度 | ||
![]() | boolean | 否 | 是否是作废签签署,默认为false | ||
![]() | boolean | 否 | 是否是 二维码签署,默认为false。二维码签署不支持骑缝签和多页签 | ||
![]() | object | 是 | 签署文件信息 | ||
![]() | string | 是 | 待签署PDF文档本地路径 | ||
![]() | string | 否 | 签署后PDF文档本地路径(不传则返回签署后的文件流) | ||
![]() | string | 否 | 文档名称 | ||
![]() | string | 否 | 文档编辑密码 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
errCode | int | 是 | 错误码 | |
msg | string | 否 | 错误信息 | |
errShow | boolean | 否 | 错误信息是否显示 | |
signServiceId | string | 否 | 签署记录id | |
stream | string | 否 | 签署后的文件base64(dstPdfFile未传入时返回) | |
dstFilePath | string | 否 | 签署完成的pdf文件绝对路径 1、dstPdfFile传入的是文件绝对路径,该文件所在目录存在,返回dstPdfFile 2、dstPdfFile传入的是文件夹绝对路径,该目录存在,签署后的文件流写入 e签宝随机命名的pdf文件,并返回该pdf文件的绝对路径 3、dstPdfFile传入的是但所在目录不存在的文件或者文件夹路径,返回空并报错 | |
filePath | string | 否 | 预留字段 | |
signDetailUrl | string | 否 | 签署详情链接 |
请求示例
请求参数示例:具体根据实际业务场景进行传参,此处仅为参考
请求数据采用json格式、UTF-8编码,请求数据类型Content-Type=application/json POST http://localhost:8080/tech-sdkwrapper/timevale/sign/eventFileSign localhost:8080这里参考https://qianxiaoxia.yuque.com/docs/share/7c96dfbc-1e53-4de3-b1f6-46e10eda67b4 { "signType": "Single", "accountId": "1446040AF85440348C650779852C8B4E", "sealData": "", "certId":"1000001695", "file": { "srcPdfFile": "D:/test-template.pdf", "dstPdfFile": "D:/abc/c.pdf" }, "signPos": { "posPage":"1" } }
响应示例
{ "msg": "成功", "dstFilePath": "D:\\abc\\c.pdf", "signDetailUrl": "https://smlweb.tsign.cn/e.html?id=1182257236924252169", "stream": "", "errCode": 0, "errShow": false, "signServiceId": "1182257236924252169" }
错误码
错误码 | 错误描述 | 解决方案 |