techSDK(JAVA语言调用的JAR版)接口列表

更新时间:2020-09-30 10:48:14

产品更名说明

e签宝将于2020年7月1日将产品名称由“悟空SDK”变更为更容易理解的“电子签名服务SDK-techSDK”。本次仅涉及产品名称变更,其接口及参数保持原有不变。


接口说明

以下列表包含该产品所涉及的所有接口,点击接口名可查看接口的业务请求参数,返回参数,请求示例,返回示例以及错误码等。


电子签名服务SDK初始化

接口名称API接口

描述

注册客户端

ServiceClientManager.registClient()

查看文档

获取客户端

ServiceClientManager.get()

查看文档

关闭客户端

ServiceClientManager.shutdown()

查看文档



签署账户生成服务

接口名称API接口

描述

创建个人签署账户

AccountService.addAccount()

查看文档

创建企业签署账户

AccountService.addAccount()

查看文档

更新个人签署账户信息

AccountService.updateAccount()

查看文档

更新企业签署账户信息

AccountService.updateAccount()

查看文档

注销签署账户

AccountService.deleteAccount()

查看文档

根据证件号获取签署账户信息

AccountService.getAccountInfoByIdNo()

查看文档

Tips:

港澳台居民、非中国公民(外籍人士)如何创建签署账户请点击查看个人签署账户证件类型介绍

      中国境内企业、港澳台企业、外国企业如何创建签署账户请点击查看企业签署账户证件类型介绍


模板印章生成服务

接口名称API接口

描述

创建个人模板印章

SealService.addTemplateSeal()

查看文档

创建企业模板印章

SealService.addTemplateSeal()

查看文档

Tips:

如果以上印章格式不满足需求,可自行创建印章图片,转成Base64数据,用于签署。详情可参考【请点击


PDF模板填充服务

接口名称API接口

描述

本地PDF模板文件填充

PdfDocumentService.createFileFromTemplate()

查看文档

本地PDF模板文件填充(可选字体)

PdfDocumentService.createFileFromTemplate()

查看文档

本地PDF模板文件流填充(可选字体)

PdfDocumentService.createFileFromTemplate()

查看文档

本地PDF模板文件流填充

PdfDocumentService.createFileFromTemplate()

查看文档

获取PDF模板文件中所有域信息

DocService.getPdfAllFields()

查看文档



平台用户意愿认证签署服务

接口名称API接口

描述

发送签署短信验证码

MobileService.sendSignMobileCode()

查看文档

发送签署语音验证码

MobileService.sendSignMobileVoice()

查看文档

平台用户PDF文件签署(短信验证)

UserSignService.localSafeSignPDF()

查看文档

平台用户PDF文件流签署(短信验证)

UserSignService.localSafeSignPDF()

查看文档

平台用户PDF文件批量签署(短信验证)

UserSignService.localSafeMultiPureSignPDF()

查看文档

指定手机号发送签署短信验证码

MobileService.sendSignMobileCode3rd()

查看文档

平台用户PDF文件签署(指定手机号短信验证)

UserSignService.localSafeSignPDF3rd()

查看文档

平台用户PDF文件多位置签署(指定手机短信验证)

UserSignService. multiPositionSafeSign3rd()

查看文档

平台用户PDF文件流签署(指定手机号短信验证)

UserSignService.localSafeSignPDF3rd()

查看文档

平台用户PDF文件多位置文件流签署(指定手机短信验证)

UserSignService.multiPositionSafeSign3rd()

查看文档

平台用户PDF文件批量签署(指定手机号短信验证)

UserSignService.localSafeMultiPureSignPDF3rd()

查看文档

独立意愿对接文档

查看文档

平台用户PDF签署(意愿bizId批量签署)

UserSignService.batchSignWithWillness()

查看文档

预置签名域Pdf模板签署(短信验证)

TemplateSignService.timesSignCode();

查看文档

预置签名域Pdf模板签署(指定手机号短信验证)

TemplateSignService. timesSignCode3rd();

查看文档

预置签名域Pdf模板文件流签署(短信验证)

TemplateSignService.timesStreamSignCode();

查看文档

预置签名域Pdf模板文件流签署(指定手机号短信验证)

TemplateSignService.timesStreamSignCode3rd();

查看文档

Tips:

(1)指定手机号发短信验证码,签署的时候必须也要用指定手机号短信验证的接口去签署

(2)平台用户签署推荐用意愿认证签署服务,这种签署会让用户输入验证码来体现用户的一个意愿互动,

《中华人民共和国电子签名法》中指出满足以下四个条件即可认定该电子文 件具有法律效力:

 1、真实签署身份;

 2、真实签署意愿

 3、签署后文档内容未篡改;
 4、签署后签名信息未篡改; 
所以签署的时候体现用户的意愿是很重要的
(3)关键字签署场景,关键字建议不要设置特殊字符,因Adobe无法识别部分符号,某些特殊字符会因解析失败从而导致搜索不到


平台用户PDF无意愿认证签署服务

接口名称API接口

描述

平台用户PDF文件签署

UserSignService.localSignPDF()

查看文档

平台用户PDF文件多位置签署

UserSignService.multiPositionSign()

查看文档

平台用户PDF文件流签署

UserSignService.localSignPDF()

查看文档

平台用户PDF多位置文件流签署

UserSignService.multiPositionSign()

查看文档

预置单个签名域PDF模板文件签署

TemplateSignService.sign()

查看文档

预置单个签名域PDF模板文件流签署

TemplateSignService.streamSign()

查看文档

预置多个签名域PDF模板批量文件签署

TemplateSignService.timesSign()

查看文档

预置多个签名域PDF模板批量文件流签署

TemplateSignService.timesStreamSign()

查看文档

查询签署记录信息

SignService.querySignServiceDetail()

查看文档


平台自身PDF无意愿认证签署服务

接口名称API接口

描述

平台自身PDF文件签署(印章标识)

SelfSignService.localSignPDFV2()

查看文档

平台自身PDF文件签署(印章图片)

SelfSignService.localSignPDF()

查看文档

平台自身PDF多位置签署(印章图片)

SelfSignService.multiPositionSign()

查看文档

平台自身PDF文件流签署(印章标识)

SelfSignService.localSignPDFV2()

查看文档

平台自身PDF文件流签署(印章图片)

SelfSignService.localSignPDF()

查看文档

平台自身PDF多位置文件流签署(印章图片)

SelfSignService.multiPositionSign()

查看文档

平台自身多个签名域PDF文件签署(印章标识)

SelfSignService.localBatchSignPdf()

查看文档

平台自身PDF单文档批量摘要签署(文件流&印章标识)

SelfSignService.localBatchSignPdf()

查看文档



PDF验签服务

接口名称API接口

描述

PDF文档验签

SignService.localVerifyPdf()

查看文档

PDF文档验签(文件流)

SignService.localVerifyPdf()

查看文档


文本签名/验签服务

接口名称API接口

描述

平台自身文本签名

SignService.localTextSign()

查看文档

平台用户文本签名

SignService.localTextSign()

查看文档

平台用户文本签名(短信验证码)

SignService.localSafeTextSign()

查看文档

文本验签服务

SignService.verifySignResult()

查看文档



历史接口

平台用户PDF事件证书签署

接口名称API接口

描述

创建事件证书

EventCertService.addEventCert()

查看文档

事件证书PDF文件签署

EventSignService.localSignPDFByEvent()

查看文档

事件证书PDF文件签署(短信验证)

EventSignService.localSignPDFByEvent()

查看文档

事件证书PDF文件签署(指定手机号短信验证)

EventSignService.localSignPDFByEvent()

查看文档

事件证书PDF文件流签署

EventSignService.localSignPDFByEvent()

查看文档

事件证书PDF文件流签署

(默认手机号短信验证)

EventSignService.localSignPDFByEvent()

查看文档

事件证书PDF文件流签署

(指定手机短信验证)

EventSignService.localSignPDFByEvent()

查看文档

查询事件证书签署详情

SignService.getEventSignInfo()

查看文档


模板印章本地生成服务(SDK内绘制印章图片)

接口名称API接口

描述

创建个人模板印章(本地)

TemplateSealService.createPersonalTemplateSeal()

查看文档

创建企业模板印章(本地)

TemplateSealService.createOfficialTemplateSeal()

查看文档

创建长字符折行个人模板印章(本地)

TemplateSealService.createLongBreakPersonalTemplateSeal()

查看文档


其他类

接口名称API接口

描述

图片替换PDF预置签名域

DocService.replaceSignatureWithImage()

查看文档

保存存证指引信息

UserSignService.saveEvidenceGuideInfo()

查看文档

短信验证码预验接口

MobileService.preverifyCode()

查看文档

指定手机号短信验证码预验接口

MobileService.preverifyMobileCode()

查看文档


我要纠错