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

更新时间:2021/03/04 17:08:58

一、最佳实践概述

   适用场景

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

   适用产品

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

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

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

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

4、签署任务流程开启后,e签宝会根据添加的签署区顺序自动执行签署任务,完成企业自动盖章签署;

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

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

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

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

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

企业证明类文件签署.png

三、开发前准备步骤

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

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

image

   沙箱环境使用说明

1、开通沙箱环境

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


2、创建沙箱应用

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

点击查看 创建沙箱应用步骤


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

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

点击查看 配置沙箱应用IP白名单步骤


   转正式环境使用说明

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

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

点击查看 创建正式应用步骤


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

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

点击查看 配置正式应用IP白名单步骤


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

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

四、电子签名PaaS API接入概述

步骤一:创建签署账号和印章(可选)

-----创建签署账号API接口-时序图-----

证明类文件-创建账号时序图.png

1、创建个人签署账号

接口说明:如果存在子公司等企业主体需要在证明类文件进行自动盖章签署时,开发者需先为子公司等企业主体的操办人创建一个个人签署账号(创建过程即为申请CA数字证书过程,开发者无需另行申请证书),一个员工(同一用户唯一标识、姓名和证件号)仅需要创建一次签署账号即可,请妥善保管个人签署账号AccountId。

API接口文档链接:个人签署账号创建


2、创建机构签署账号

接口说明:如果存在子公司等企业主体需要在证明类文件进行自动盖章签署时,开发者可以通过该接口为子企业创建一个机构签署账号(创建过程即为申请CA数字证书过程,开发者无需另行申请证书),一个企业(同一用户唯一标识、企业名称和证件号仅需要创建一次签署账号即可,请妥善保管企业签署账orgId。

API接口文档链接:创建机构签署账号


3、创建机构模板印章

接口说明:如果存在子公司等企业主体需要在证明类文件进行自动盖章签署时开发者可以通过该接口为子企业创建一个模板印章,一个企业同一用户唯一标识、企业名称和证件号)仅需要创建一次模板印章即可,请妥善保管企业模板印章sealId

API接口文档链接:创建机构模板印章


4、设置静默授权

接口说明:如果存在子公司等企业主体需要在证明类文件进行自动盖章签署时开发者需要在创建完机构签署账号之后,调用该接口对子公司等企业主体进行静默授权,用于后续实现子公司等企业主体自动盖章签署场景。静默授权支持授权一次永久有效,也支持通过字段控制授权的有效期限。

API接口文档链接:设置静默授权

步骤二:创建待签署文件

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

入职材料签署-创建文件时序图.png

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

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

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

注:uploadurl的作用是将待签文件上传到e签宝服务端,用于后续接口发起签署流程时使用,且同一个待签署文件只需要上传一次。

点击参考:文件流上传方法

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

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

API接口文档链接:查询文件详情

步骤三:发起签署流程

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

证明类文件签署-发起签署流程时序图.png

1、创建签署流程

接口说明:开发者通过该接口为待签署员工创建一个签署流程,并获取流程flowId,用于后续添加待签署文档以及签署区信息;同时,开发者通过创建签署流程接口可以设置当前签署流程的通知方式(短信或者邮件接收签署通知)、异步回调地址(接收签署完成回调信息)、重定向跳转地址(签署完成之后指定跳转)等信息。

API接口文档链接:创建签署流程


2、添加待签署文件

接口说明:开发者通过该接口将待签署的文件fileId添加到签署流程中。

API接口文档链接:添加待签署文件


3、添加平台方自动盖章签署区

接口说明:开发者通过该接口将企业自动盖章签署的信息(签章坐标位置、签章日期、签署顺序等)添加到签署流程中。

API接口文档链接:添加平台方自动盖章签署区


4、添加签署方自动盖章签署区(可选)

接口说明:如果存在子公司等企业主体需要进行自动盖章签署时,开发者可通过该接口将企业自动盖章签署的信息(签章坐标位置、签章日期、签署顺序等)添加到签署流程中。

API接口文档链接:添加签署方自动盖章签署区


5、开启签署流程

接口说明:以上待签署文件以及签署区信息添加完成之后,开发者通过该接口开启签署流程。开启后,签署流程将自动按照设置好的签署顺序执行签署任务,企业先完成自动签署后,发送签署通知到员工短信或者邮件。

API接口文档链接:开启签署流程


6、关闭签署流程(可选)

接口说明:开发者接收到员工签署完成的异步通知状态后,可调用该接口关闭(完结)当前签署流程。

API接口文档链接:关闭签署流程

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


7、下载签署后的文件列表

接口说明:开发者接收到前述流程关闭(完结)的异步通知状态后,可调用该接口下载当前签署流程中,签署后的文件列表。

API接口文档链接:下载签署后的文件列表

签署流程关闭异步通知参数说明:签署流程关闭回调通知

五、注意事项

1、通过添加待签署文件接口添加的签署文件,将按照正常计费模式扣除合同份额;如果添加的文件只是给签署人阅读,不做签署,建议将该文件以附件的形式进行添加,参考:签署流程添加附件


2、《关于电子签名API文件名称特殊字符限制通知》


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