附录四 天印签章系统SDK接口说明

内部用户（JAVA版本）

SDK介绍

SDK编译环境：JDK1.7

SDK接口说明

初始化

功能说明

初始化SDK，初始化信息包含有：项目配置、与服务端通讯的http配置。其中，颗粒机项目配置是项目管理员预先在天印签章后台管理系统中创建项目时产生的，请向项目管理员索要。初始化成功后，SDK会存储初始化结果，无需重复初始化。

接口说明

接口：com.timevale.esign.sdk.颗粒机esignpro.service.SDKService

类：com.timevale.esign.sdk.esignpro.service.impl.SDKServiceImpl

工厂类：com.time颗粒机vale.esign.sdk.esignpro.service.factory.SDKServiceFactory

原型：Result init(ProjectConfig projectConfig,颗粒机 httpConnectConfig)

请求参数说明

返回结果说明

，详见对象解释。

PDF后台签署

PDF后台签署（意愿认证）

功能说明

账号意愿认证通过后，根据获取到的意愿认证标识使用该账号对PDF文档进行后台颗粒机自动签署。签署过程中文档在本地操作，不传递至签署服务器，只传递摘要信息，支持二维码印章功能

接口说明

接口：com.timevale.esign.sdk.esignpro.service.BackSign颗粒机Service

类：com.timevale.esign.sdk.esignpro.service.impl.BackSignServiceImpl

工厂类：

com.timevale.esign.sdk.颗粒机esignpro.service.factory.BackSignServiceFactory

原型：FileDigestSignResult pdfSign( signer, file, pos,Qr颗粒机CodeBean qrCodeBean，ExtensionInfo extensionInfo)

请求参数说明

返回结果说明

，详见对象解释。

PDF后台签署（无意愿认证）

功能说明

支持无意愿认证情况下对Pdf颗粒机文档进行后台自动签署。签署过程中文档在本地操作，不传递至签署服务器，只传递摘要信息，支持二维码功能。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.Bac颗粒机kSignService

类：com.timevale.esign.sdk.esignpro.service.impl.BackSignServiceImpl

工厂类：

com.timevale.esign颗粒机.sdk.esignpro.service.factory.BackSignServiceFactory

原型：FileDigestSignResult pdfSign( signer, file, p颗粒机os，QrCodeBean qrCodeBean，ExtensionInfo extensionInfo)

请求参数说明

返回结果说明

，详见对象解释。

PDF前台签署

需要将待签署文档上传至天印签章系统，访问颗粒机天印签章系统的文档签署页面完成签署。用户可以通过登录天印签章系统查看所有待签署文档完成签署；或者通过业务系统内访问文档签署页面进行签署。

签署文档上传

功能说明

将待签署文档上传至天印签章系统。

接口说明

接口颗粒机：com.timevale.esign.sdk.esignpro.service.DocService

类：com.timevale.esign.sdk.esignpro.service.impl.Do颗粒机cServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.DocServiceFactory

原型：UploadResult doc颗粒机Upload(String docFilePath, DocType docType)

请求参数说明

返回结果说明

，详见对象解释。

保存信封信息／创建签署请求

功能说明

待签署文档上传后，创建签署请求，指定签署颗粒机者信息、位置信息等，签署请求即信封，一个签署请求只能对应一个文档。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.EnvelopeService

类：com颗粒机.timevale.esign.sdk.esignpro.service.impl.EnvelopeServiceImpl

工厂类：

com.timevale.esign.sdk.esignpro.ser颗粒机vice.factory.EnvelopeServiceFactory

原型：SaveEnvelopeResult saveEnvelopeInfo(EnvelopeInfo envelopeInfo,颗粒机 docInfo, List<> personRecipientsInfos, List< > departRecipientsInfos);

请求参数说明

返回结果说明

，详见对象解释。

获取签署Url

功能颗粒机说明

保存信封后，可以获取信封当前签署节点的签署页面URL地址，在业务系统内部展现此地址引导用户完成签署。获取的链接地址有一定时效，超过时效需要重新获取。

接口说明

接口：com.timevale.esig颗粒机n.sdk.esignpro.service.EnvelopeService

类：com.timevale.esign.sdk.esignpro.service.impl.EnvelopeService颗粒机Impl

工厂类：

com.timevale.esign.sdk.esignpro.service.factory.EnvelopeServiceFactory

原型：SignUrlReslut getSi颗粒机gnUrl(String envelopeUUID);

请求参数说明

返回结果说明

,详见对象解释。

获取当前签署URL

功能说明

保存信封后，可以获取信封当前签署节点的签署页面URL地址，去签署的时候通过签署地颗粒机址跳到doc-web去签署。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.EnvelopeService

类：com.timevale.esign.sdk颗粒机.esignpro.service.impl.EnvelopeServiceImpl

工厂类：

com.timevale.esign.sdk.esignpro.service.factory.Envelo颗粒机peServiceFactory

原型：SignUrlReslut getCurrentSignUrl(CurrentSignBean currentSignInfo);

请求参数说明

返回结果说明

,详见对颗粒机象解释。

获取信封信息／获取签署过程信息

功能说明

签署请求创建完成后的任何时候， 获取签署的信封信息，通过该接口获取信封签署流程及当前签署状态。

接口说明

接口：com.timevale.esign.sdk.颗粒机esignpro.service.EnvelopeService

类：com.timevale.esign.sdk.esignpro.service.impl.EnvelopeServiceImpl

工厂颗粒机类：

com.timevale.esign.sdk.esignpro.service.factory.EnvelopeServiceFactory

原型：EnvelopInfoResult getEnve颗粒机lopeInfo(String envelopeUUID);

请求参数说明

返回结果说明

,详见对象解释。

获取签署后文档

功能说明

获取签署完成后签署后文档下载地址URL。 用于用户业务系统下载签署后的pdf文颗粒机档。获取的链接地址有一定时效，超过时效需要重新获取。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.EnvelopeService

类：com.timeva颗粒机le.esign.sdk.esignpro.service.impl.EnvelopeServiceImpl

工厂类：

com.timevale.esign.sdk.esignpro.service.fa颗粒机ctory.EnvelopeServiceFactory

原型：FinishDocUrlResult getFinishDocUrl (String envelopeUUID);

请求参数说明

返回结果说明颗粒机

,详见对象解释。

用户管理

创建内部个人用户

功能说明

创建内部用户，返回内部用户ID

接口说明

接口：com.timevale.esign.sdk.esignpro.service.AccountService颗粒机

类：com.timevale.esign.sdk.esignpro.service.impl. AccountServiceImpl

工厂类：com.timevale.esign.sdk.esignpr颗粒机o.service.factory. AccountServiceFactory

原型： createAccount(PersonalBean personalBean);

请求参数说明

返回结果说明

,详见对颗粒机象解释。

删除内部用户

功能说明

根据用户Id删除用户。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.AccountService

类：com.timevale颗粒机.esign.sdk.esignpro.service.impl.AccountServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.facto颗粒机ry.AccountServiceFactory

原型：Result deleteAccount(String accountId);

请求参数说明

返回结果说明

，详见对象解释。

更新内部用户数据

功能说明

修改颗粒机内部用户数据。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.AccountService

类：com.timevale.esign.sdk.esignpr颗粒机o.service.impl.AccountServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.AccountServiceF颗粒机actory

原型：Result updateAccountInfo(String accountId, List<DeleteList> delList, UpdateInnerData update颗粒机Data);

请求参数说明

返回结果说明

，详见对象解释。

证书管理

为用户创建云证书

功能说明

为内部用户创建云证书接口，支持同时设置为默认证书，返回证书ID

接口说明

接口：com.timevale.esign.s颗粒机dk.esignpro.service.CertService

类：com.timevale.esign.sdk.esignpro.service.impl.CertServiceImpl

工厂类：com颗粒机.timevale.esign.sdk.esignpro.service.factory. CertServiceFactory

原型：createCert (String accountId,bool颗粒机ean isDefault);

请求参数说明

返回结果说明

,详见对象解释。

印章管理

为用户创建模板印章

功能说明

为内部用户创建模板印章接口，支持同时设置为默认印章，返回印章ID

接口说明

接口：com.timev颗粒机ale.esign.sdk.esignpro.service.SealService

类：com.timevale.esign.sdk.esignpro.service.impl.SealService颗粒机Impl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.SealServiceFactory

原型：createSeal (String acco颗粒机untId, sealBean，boolean isDefault);

请求参数说明

返回结果说明

,详见对象解释。

文档管理

获取指定模板详情

功能说明

根据模板编号获取模板详情

接口说明

接口：com.timeva颗粒机le.esign.sdk.esignpro.service.TemplateService

类：com.timevale.esign.sdk.esignpro.service.impl. Templat颗粒机eServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.TemplateService Factory

原型：TemplateIn颗粒机foResult getTemplateInfo(String templateId);

请求参数说明

返回结果说明

，详见对象解释。

使用模板填充文档

功能说明

通过模板详情接口返回的模板填充文档

接口说明

接口：颗粒机com.timevale.esign.sdk.esignpro.service.TemplateService

类：com.timevale.esign.sdk.esignpro.service.imp颗粒机l. TemplateService Impl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.TemplateService Factory

原型颗粒机：TemplateDocInfoResult buildTemplateDoc(String templateId,List<TemplateFormValue> templateFormValues颗粒机);

请求参数说明

返回结果说明

，详见对象解释。

获取文档下载地址

功能说明

根据fileKey获取文档下载地址

接口说明

接口：com.timevale.esign.sdk.esignpro.service.Do颗粒机cService

类：com.timevale.esign.sdk.esignpro.service.impl.DocServiceImpl

工厂类：com.timevale.esign.sdk.esig颗粒机npro.service.factory.DocServiceFactory

原型：DownloadUrlResult getDownloadUrl(String fileKey);

请求参数说明

返回结果颗粒机说明

，详见对象解释。

获取扩展信息名称列表

功能说明

获取所有的扩展信息名称列表

接口说明

接口：com.timevale.esign.sdk.esignpro.service.EventCertService颗粒机

类：com.timevale.esign.sdk.esignpro.service.impl.EventCertServiceImpl

工厂类：com.timevale.esign.sdk.esignp颗粒机ro.service.factory.EventCertService Factory

原型：ExtensionNameResult getExtensionNames();

请求参数说明

返回结果说明

，详颗粒机见对象解释。

事件证书

创建事件证书

功能说明

创建事件证书，将签署者与行为绑定在一起，并固化至数字证书中，从而形成数字证书，事件证书证明了事件本身。事件证书具有单次有效性，即使用证书完成签署后，此证书立即失颗粒机效。事件证书可以关联多个签署者。

接口说明

接口：com.timevale.esign.sdk.esignpro.service.EventCertService

类：com.timevale.esign.颗粒机sdk.esignpro.service.impl.EventCertServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.Ev颗粒机entCertService Factory

原型：EventCertResult createEventCert (String content, String eventName, List<Eve颗粒机ntTargetInfo> eventTargets);

请求参数说明

返回结果说明

详见对象解释.

事件证书PDF签署（后台）

功能说明

使用事件证书对文档进行签署，事件证书签署后即失效，不可重复使用

接口说明

接颗粒机口：com.timevale.esign.sdk.esignpro.service.EventCertService

类：com.timevale.esign.sdk.esignpro.service.颗粒机impl.EventCertServiceImpl

工厂类：com.timevale.esign.sdk.esignpro.service.factory.EventCertService Factor颗粒机y

原型：FileDigestSignResult eventCertSign ( eventSigner, file, pos,QrCodeBean qrCodeBean，ExtensionInfo 颗粒机extensionInfo);

请求参数说明

返回结果说明

，详见对象解释。

项目签名

项目签名

功能说明

将请求正文通过摘要算法生成64位的签名值。

接口说明

接口：com.timevale.esign.sdk.es颗粒机ignpro.service.SDKService

类：com.timevale.esign.sdk.esignpro.service.impl.SDKServiceImpl

工厂类：com.timeva颗粒机le.esign.sdk.esignpro.service.factory.SDKServiceFactory

原型：SignatureResult signature(String request)

请颗粒机求参数说明

返回结果说明

com.timevale.esign.sdk.esignpro.bean.result.SignatureResult，详见对象解释。

SDK对象解释

ProjectConfig

类名颗粒机：

com.timevale.esign.sdk.esignpro.bean.ProjectConfig

HttpConnectConfig

类名：

com.timevale.esign.sdk.esignp颗粒机ro.bean.HttpConnectConfig

SignerAuthBean

类名：

com.timevale.esign.sdk.esignpro.bean.SignerAuthBean

SignerA颗粒机utoBean

类名：

com.timevale.esign.sdk.esignpro.bean.SignerAutoBean

SignPDFFileBean

类名：

com.timevale.esign.sd颗粒机k.esignpro.bean.SignPDFFileBean

PositionBean

类名：

com.timevale.esign.sdk.esignpro.bean.PositionBean

EnPos颗粒机itionBean

类名：

com.timevale.esign.sdk.esignpro.bean.EnPositionBean

EnvelopeInfo

类名：

com.timevale.esign.sdk颗粒机.esignpro.bean.EnvelopeInfo

DocInfo

类名：

com.timevale.esign.sdk.esignpro.bean.DocInfo

RecipientsInfoPerso颗粒机n

类名：

com.timevale.esign.sdk.esignpro.bean.RecipientsInfoPerson

RecipientsInfoDepart

类名：

com.timevale.esi颗粒机gn.sdk.esignpro.bean.RecipientsInfoDepart

PersonalBean

类名：

com.timevale.esign.sdk.esignpro.bean.Persona颗粒机lBean

Template

类名：

com.timevale.esign.sdk.esignpro.bean.TemplateSealBean

CurrentSignBean

类名：

com.timevale.颗粒机esign.sdk.esignpro.bean.CurrentSignBean

QrCodeBean

类名：

com.timevale.esign.sdk.esignpro.bean.QrCodeBean

T颗粒机emplateFormValue

类名：

com.timevale.esign.sdk.esignpro.bean.TemplateFormValue

TemplateInfoBean

类名：

com.time颗粒机vale.esign.sdk.esignpro.bean.TemplateInfoBean

TemplateFlowBean

类名：

com.timevale.esign.sdk.esignpro.bean颗粒机.TemplateFlowBean

TemplateFormBean

类名：

com.timevale.esign.sdk.esignpro.bean.TemplateFormBean

PredefineBe颗粒机an

类名：

com.timevale.esign.sdk.esignpro.bean.PredefineBean

EventSignInfo

类名：

com.timevale.esign.sdk.esignp颗粒机ro.bean.EventSignInfo

EventTargetInfo

类名：

com.timevale.esign.sdk.esignpro.bean.EventTargetInfo

EventAuth颗粒机Bean

类名：

com.timevale.esign.sdk.esignpro.bean.EventAuthBean

ExtensionBean

类名：

com.timevale.esign.sdk.esig颗粒机npro.bean.ExtensionBean

ExtensionInfo

类名：

com.timevale.esign.sdk.esignpro.bean.ExtensionInfo

UpdateInner颗粒机Data

类名：

com.timevale.esign.sdk.esignpro.bean.UpdateInnerData

Signatory

类名：

com.timevale.esign.sdk.esignp颗粒机ro.bean.Signatory

SignDate

类名：

com.timevale.esign.sdk.esignpro.bean.SignDate

HttpType

类名：

com.timevale.esi颗粒机gn.sdk.esignpro.constants.HttpType

AccountType

类名：

com.timevale.esign.sdk.esignpro.constants.AccountTyp颗粒机e

PosType

类名：

com.timevale.esign.sdk.esignpro.constants.PosType

EnPosType

类名：

com.timevale.esign.sdk.esign颗粒机pro.constants.EnPosType

EnvelopeStatus

类名：

com.timevale.esign.sdk.esignpro.constants.EnvelopeStatus

DocT颗粒机ype

类名：

com.timevale.esign.sdk.esignpro.constants.DocType

LiceneseType

类名：

com.timevale.esign.sdk.esignpr颗粒机o.constants.LicenseType

SendType

类名：

com.timevale.esign.sdk.esignpro.constants.SendType

SignType

类名：

com.t颗粒机imevale.esign.sdk.esignpro.constants.SignType

SealType

类名：

com.timevale.esign.sdk.esignpro.constants.Se颗粒机alType

SealColorType

类名：

com.timevale.esign.sdk.esignpro.constants.SealColorType

TemplateType

类名：

com.time颗粒机vale.esign.sdk.esignpro.constants.TemplateType

RecipientType

类名：

com.timevale.esign.sdk.esignpro.consta颗粒机nts.RecipientType

RecipientStatus

类名：

com.timevale.esign.sdk.esignpro.constants.RecipientStatus

AccountF颗粒机alg

类名：

com.timevale.esign.sdk.esignpro.constants.AccountFlag

ExtAccountType

类名：

com.timevale.esign.sdk.e颗粒机signpro.constants.ExtAccountType

EventLicenseType

类名：

com.timevale.esign.sdk.esignpro.constants.EventLi颗粒机censeType

DeleteList

类名：

com.timevale.esign.sdk.esignpro.constants.DeleteList

Result

类名：

com.timevale.esig颗粒机n.sdk.esignpro.bean.result.Result

FileDigestSignResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.颗粒机FileDigestSignResult

UploadReslut

类名：

com.timevale.esign.sdk.esignpro.bean.result.UploadResult

SaveEnvel颗粒机opeResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.SaveEnvelopeResult

SignUrlResult

类名：

com.timeva颗粒机le.esign.sdk.esignpro.bean.result.SignUrlReslut

EnvelopeInfoResult

类名：

com.timevale.esign.sdk.esignpro.颗粒机bean.result.EnvelopeInfoResult

EnvelopeDataResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.Envel颗粒机opeDataResult

DocInfoResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.DocInfoResult

RecipientsInfo颗粒机PersonResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.RecipientsInfoPersonResult

RecipientsInfoD颗粒机epartResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.RecipientsInfoDepartResult

PositionBeanResu颗粒机lt

类名：

com.timevale.esign.sdk.esignpro.bean.result.PositionBeanResult

FinishDocUrlResult

类名：

com.timevale颗粒机.esign.sdk.esignpro.bean.result.FinishDocUrlResult

AccountResult

类名：

com.timevale.esign.sdk.esignpro.be颗粒机an.result.AccountResult

CertResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.CertResult

SealResult颗粒机

类名：

com.timevale.esign.sdk.esignpro.bean.result.SealResult

TemplateInfoResult

类名：

com.timevale.esign.sdk颗粒机.esignpro.bean.result.TemplateInfoResult

TemplateDocInfoResult

类名：

com.timevale.esign.sdk.esignpro.bean颗粒机.result.TemplateDocInfoResult

DownloadUrlResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.Downloa颗粒机dUrlResult

EventCertResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.EventCertResult.

ExtensionNam颗粒机eResult

类名：

com.timevale.esign.sdk.esignpro.bean.result.ExtensionNameResult.

SignatureResult

类名：

com.time颗粒机vale.esign.sdk.esignpro.bean.result.SignatureResult