企业证明类文件签署场景最佳实践

更新时间:2021/06/17 17:56:53

一、最佳实践概述

   适用场景

适用于在企业办公系统中集成电子签章。本实践可指引企业开发者快速接入电子签名产品,实现企业员工快速获取通过企业内部盖章后的办公类文件

   适用产品

二、开发前准备步骤

开发者在对接时,需注意:

  • 代开发能力:开发者对应的企业在e签宝官网进行实名注册,并成为e签宝的“生态伙伴”后,即具备代其他企业客户开发的能力,开发者可以基于其他企业客户的业务场景进行对接开发,请点击参考对接
  • 自研开发能力:开发者对应的企业在e签宝官网进行实名注册后,即具备自研开发能力,开发者可以基于自己企业的业务场景进行对接开发。

   沙箱环境使用说明

1、开通沙箱环境

使用e签宝企业账号登录e签宝开放平台(https://open.esign.cn),进入【控制台】-【沙箱服务】后即可开通沙箱环境,获取沙箱环境开发调试权限。

2、创建沙箱应用

开发者登录e签宝开放平台,进入【沙箱服务】创建沙箱应用,用于开发调试。

3、配置沙箱应用IP白名单

开发者登录e签宝开放平台,进入【沙箱服务】找到对应沙箱应用配置IP白名单。沙箱应用配置IP白名单后即可进行API接口集成和调试。


   转正式环境使用说明

点击查看 转正式环境操作说明

4、创建正式应用(正式环境上线前准备)

API接口集成调试完毕,开发者登录e签宝开放平台,进入【正式服务】创建正式应用,用于线上生产使用。

5、配置正式应用IP白名单(正式环境上线前准备)

开发者登录e签宝开放平台,进入【正式服务】找到对应正式应用配置IP白名单。正式应用配置IP白名单后即可在线上生产使用。

6、激活套餐正式上线(正式环境上线前准备)

在计划上线日的前2天开发者应联系e签宝工作人员进行报备,以便e签宝安排人员协助上线操作配置套餐。

三、企业证明类文件签署流程

1、企业员工登录企业办公系统,并申请获取证明类文件;

2、企业员工在提交自己的个人信息之后,经过办公系统内部业务审核流程;

3、内部审核流程结束后,办公系统直接发起证明类文件签署任务;

4、签署任务流程开启后,企业自动盖章签署;

5、e签宝在获取到企业自动盖章签署完成状态后,触发异步回调通知,将签署完成的状态信息发送到企业办公系统;

6、企业办公系统在接收到异步回调之后,手动关闭(完结)签署流程,或者在发起签署任务时,设置自动关闭;

7、e签宝在获取到签署流程关闭(完结)的状态后,自动触发异步回调通知,将签署流程关闭(完结)的状态信息发送到企业办公系统;

8、企业办公系统在接收到异步回调之后,下载签署后的文件信息,并将签署后的文件提供给企业员工进行查阅和下载。

<企业办公类文件签署流程>

四、电子签名SaaS API 标准版接入概述

步骤一:创建待签署文件

-----创建待签署文件API接口-时序图-----

1、通过上传方式创建文件

接口说明:开发者通过接口为待签署文件创建fileId和用于上传文件的uploadUrl。同一个待签署文件只需要创建一次且只需要上传一次,请妥善保管待签署文件fileId。

API接口文档链接:通过上传方式创建文件

2、文件上传

接口说明:通过上述接口返回的uploadUrl作为请求地址,将文件上传到e签宝服务端,用于后续接口发起签署流程时使用。

API接口文档链接:文件流上传方法

3、查询文件实际上传状态

接口说明:开发者通过接口可以查询文件的实际上传状态,根据接口响应的status判断。

API接口文档链接:查询文件状态

步骤二:发起签署流程

-----发起签署流程API接口-时序图-----

1、一步发起签署

接口说明:开发者通过该接口为自身企业发起签署。此接口为整合接口,聚合了签署流程创建,关联待签署PDF文件以及附件,设置签署区等分步的接口。支持多方签署,签署方信息以及签署文件信息都是数组可以添加多个。支持设置流程自动开启、自动归档。

API接口文档链接:一步发起签署

签署完成异步通知参数说明:签署人签署完成回调通知

注意:

1.建议设置自动开启流程,autoInitiate设置true,如未设置则需要单独调用【签署流程开启】接口。

2.建议设置自动归档流程,autoArchive设置true,如未设置则需要单独调用【签署流程归档】接口。


2、流程文档下载

接口说明:开发者接收到前述流程结束(归档后触发)的异步通知状态后,可调用该接口下载签署后的文件。

签署流程结束异步通知参数说明:流程结束回调通知

API接口文档链接:流程文档下载

五、注意事项

1、通过一步发起签署添加的签署文件,将按照正常计费模式扣除合同份额;如果添加的文件只是给签署人阅读,不做签署,建议将该文件以附件的形式进行添加。

2、如果文件有一些不固定内容需要客户或者内部填写,比如:甲乙方姓名、身份证、时间等信息,那么签署文件需要使用模版方式生成,具体参考 《PDF模板文件3种制作说明文档》

3、《关于“电子签名 SaaS API 标准版”文件名称新增特殊字符限制的通知》

4、《关于“电子签名 SaaS API 标准版”发起的签署流程所支持的文件大小规则说明》