SDK 3.0对接指南

更新时间:2025-04-29 10:01:38

请在阅读《电子签名SDK 3.0-产品介绍》文档后,再参考本对接指南。

电子合同示意图

业务流程参考

以下接口跳转以Java语言版本为例,非Java语言版本可以参考接口列表自行进行跳转

一、核实个人/经办人用户身份

核实个人/经办人用户身份,使用 个人核身认证服务(可以选用纯API版或者网页版),以下三种认证方式用户选择其一认证即可(建议开发者接入至少两种供用户备选)

  • 认证方式一:人脸识别(对姓名、身份证进行公安库信息核对,并进行人脸活体+相似度比对)

如果用纯API方式自己做页面:【人脸识别认证】个人核身查询个人刷脸状态

如果用网页版方式自带e签宝页面:获取个人核身认证地址,如下图:

(以下是支付宝刷脸方式演示(必须用手机端操作),纯API方式发起直接到这步,无外层e签宝页面封装)

  • 认证方式二:手机认证(对姓名、身份证、手机号进行三要素核验,并回填验证码)

如果用纯API方式自己做页面:【手机号认证】运营商3要素核身【手机号认证】短信验证码校验

如果用网页版方式自带e签宝页面:获取个人核身认证地址,如下图:

  • 认证方式三:银行卡认证(对姓名、身份证、银行卡、银行预留手机号进行四要素核验,并回填验证码)

如果用纯API方式自己做页面:【银行卡认证】银行卡4要素核身【银行卡认证】预留手机号校验

如果用网页版方式自带e签宝页面:获取个人核身认证地址,如下图:

二、创建用户签署账号

发起e签宝电子签名前需要先给签署用户创建签署账号,生成数字证书,需要让用户勾选相关协议,具体页面展示,由贵司自主开发。(无e签宝页面)

1、相关协议请参考:电子签名使用合规性处理说明(协议具体如何展示由贵司自己业务决定);

2、根据用户信息(名字、证件号)生成e签宝签署账号:创建个人签署账号创建企业签署账号

三、生成待签署文件和用户印章

生成待签署文件并展示给用户,并根据用户名字生成模板印章或者自行采集用户手写签名。(无e签宝页面)

1、待签署文件的生成与签署位置的指定需要贵司自行开发实现并通过页面展示给用户,如果需要使用模板文件(点击了解 模板文件),可以用SDK接口填充数据:填充本地PDF模板文件

2、e签宝模板印章的生成:创建个人模板印章创建企业模板印章

【注】采集个人用户手写签名需要贵司自行实现,也可另外采购e签宝独立产品实现:备注图片制作服务API,右下图的手机端手写页面即是通过备注图片接口获取(e签宝提供手写页面进行内嵌)

四、个人签署前核身认证、企业签署前授权认证

个人用户每次签署都需要进行核身认证(第一步的个人认证如果和签署是一起的,可以在30分钟内免认证完成签署)

企业用户签署前必须操作授权书签署,授权给开发者平台可以使用其印章。授权分为两种模式:企业授权给经办人场景,后续该企业每次盖章都需要授权的经办人进行个人核身认证才能代企业签署;企业仅授权给平台场景,后续开发者平台可以直接调用企业印章进行自动签署文件。(企业授权流程使用e签宝页面)

1、个人/经办人 核身认证参考 步骤一

2、企业用户 需要提前做:企业签署授权服务,企业用户把授权协议签署后,平台后续才能使用其印章进行盖章。

五、调用签署接口进行文件签署

认证完成后调用签署相关接口进行文件签署(无e签宝页面)

以下演示平台/企业用户自动签署 + 个人用户签署(点击了解 多方签署流程):

1、平台自动签署:平台自身PDF文件签署(appId所属平台方企业可直接自动盖章);

2、企业用户签署:企业用户PDF文件签署(如需企业用户签署,授权后才可以调用签署接口进行企业用户盖章);

3、个人用户签署:个人用户PDF文件签署(需要将第三步核身认证获取到的认证流程id传入该接口进行盖章);

4、签署后的文件可以提供预览/下载给到用户,也可自主加入文件的验签环节:核验文件签名有效性

接入流程

以下为接口思维导图,如需时序图请参考 电子签名SDK 3.0时序图

接口列表

接口分为Java语言版本(本地引入Jar包)和非Java语言(本地War包HTTP请求)版本,除蓝色字接口跳转不同,其余流程与逻辑均一致。

Java语言版本

接口模块

接口文档(点击直接跳转相关文档)

接口说明(点击直接跳转相关文档)

集成说明

初始化SDK

注册客户端

全局注册一次,包含应用配置、服务端通讯配置等信息

必需

获取客户端

每个接口调用前需要获取客户端信息,通过客户端可获取SDK提供的各种服务。

必需

签署账号的

生成与管理

个人核身认证服务
创建个人签署账号

个人用户必须进行核实身份,进行个人核身认证(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一)

个人用户

签署必需

个人用户签署前必须进行创建个人签署账号

创建企业签署账号

企业用户签署前必须创建企业签署账号

企业用户

签署必需

更新个人签署账号信息

更新企业签署账号信息

根据证件号查询签署账号信息

根据账号ID查询签署账号信息

注销签署账号

账号辅助接口用于后续签署用户的的更新、查询和注销

建议必须接入(否则后续有更名或者账号信息有误等场景无法管理账号信息)

用户管理

必需

印章的创建

创建个人模板印章

根据e签宝个人印章样式生成签署印章Base64编码

需要e签宝

印章样式

必需

创建企业模板印章

根据e签宝企业印章样式生成签署印章Base64编码

需要e签宝

印章样式

必需

模板文件的

创建与填充

PDF模板文件制作说明

使用线下Adobe软件制作模板创建文本域

需要e签宝模板填充

必需

填充本地PDF模板文件

传入待填充的模板文本域Key-Value,生成最终待签署的PDF文件

签署服务

平台自身PDF文件签署

对接平台自身企业自动盖章(appId所属企业)

需要平台

自身签署

必需

个人核身认证服务

个人用户PDF文件签署

个人用户每次签署前需要做个人核身认证(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一)

需要个人

用户签署

必需

认证后即可调用接口完成个人用户签署

发起企业授权书签署任务

获取授权签署任务链接

企业用户PDF文件签署

企业用户签署前需要签署授权协议:

(1)授权给平台:在授权书有效期内平台即可自动加盖企业用户的印章

(2)授权给经办人:企业用户每次签署前需要经办人做 个人核身认证服务(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一,步骤同个人用户一致)

需要企业

用户签署

必需

授权完成后即可调用接口完成企业用户签署

验签服务

核验文件签名有效性

验证签名和文件是否篡改以及文件内包含的CA数字证书等信息

按需


非Java语言版本

接口模块

接口文档(点击直接跳转相关文档)

接口说明(点击直接跳转相关文档)

集成说明

初始化SDK

初始化SDK

服务启动后,SDK全局初始化一次

初始化包含:应用配置、服务端通讯配置等信息

必需

签署账号的

生成与管理

个人核身认证服务
创建个人签署账号

个人用户必须进行核实身份,进行个人核身认证(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一)

个人用户

签署必需

个人用户签署前必须进行创建个人签署账号

创建企业签署账号

企业用户签署前必须创建企业签署账号

企业用户

签署必需

更新个人签署账号信息

更新企业签署账号信息

根据证件号查询签署账号信息

根据账号ID查询签署账号信息

注销签署账号

账号辅助接口用于后续签署用户的的更新、查询和注销

建议必须接入(否则后续有更名或者账号信息有误等场景无法管理账号信息)

用户管理

必需

印章的创建

创建个人模板印章

根据e签宝个人印章样式生成签署印章Base64编码

需要e签宝

印章样式

必需

创建企业模板印章

根据e签宝企业印章样式生成签署印章Base64编码

需要e签宝

印章样式

必需

模板文件的

创建与填充

PDF模板文件制作说明

使用线下Adobe软件制作模板创建文本域

需要e签宝模板填充

必需

填充本地PDF模板文件

传入待填充的模板文本域Key-Value,生成最终待签署的PDF文件

签署服务

平台自身PDF文件签署

对接平台自身企业自动盖章(appId所属企业)

需要平台

自身签署

必需

个人核身认证服务

个人用户PDF文件签署

个人用户每次签署前需要做个人核身认证(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一)

需要个人

用户签署

必需

认证后即可调用接口完成个人用户签署

发起企业授权书签署任务

获取授权签署任务链接

企业用户PDF文件签署

企业用户签署前需要签署授权协议:

(1)授权给平台:在授权书有效期内平台即可自动加盖企业用户的印章

(2)授权给经办人:企业用户每次签署前需要经办人做 个人核身认证服务(刷脸认证、手机号短信认证、银行卡预留手机号短信认证任选其一,步骤同个人用户一致)

需要企业

用户签署

必需

授权完成后即可调用接口完成企业用户签署

验签服务

核验文件签名有效性

验证签名和文件是否篡改以及文件内包含的CA数字证书等信息

按需



我要纠错