流程模板签署服务API接入指南

名词解释

概念	解释
流程模板	模板是适用于合同中某些内容需要针对不同的人填写不同值的情况，比如：甲乙方姓名、身份证、地址等。需要在合同上设置填写控件生成模板，再通过控件填写不同的内容形成最终签署的合同。 流程模板中除了具备普通模板的填写控件外，还支持在模板中设置填写方、签署方、参与顺序、抄送方、合同附件、签署区控件等内容，也就是可以和后续发起签署的信息相关联。 流程模板是归属于企业用户的资源，与 e签宝SaaS官网 的模板通用（点击查看 e签宝SaaS官网如何创建模板），官网模板设置下的模板编号即为接口中的流程模板ID（signTemplateId）。 （开发者使用非自身企业的流程模板时，需要通过 用户授权 获取企业资源的管理权限）
合同拟定	流程模板制作后，用户可通过e签宝页面填写具体内容形成最终签署合同的过程就是合同拟定的过程。 开发者系统每发起一次合同拟定，会返回一个新的流程标识signFlowId，signFlowId标记当前这笔任务的全阶段流程，建议开发者保存。
签署流程	当合同拟定过程完成后，会进入到用户的签署流程中，合同拟定和签署流程通过流程标识signFlowId绑定。

接入流程

接口调用示例Demo下载

点击下载 SaaS_API_V3_流程模板Postman脚本

点击下载 SaaS_API_V3流程模板Java版本Demo

接口列表

接口说明与页面效果

一.企业资源的管理权限获取

当需要获取非应用ID所属的自身企业的流程模板管理的权限时，需要提前对企业进行授权。企业需授权给开发者自身的应用ID的资源管理权限。

获取机构认证&授权页面链接 接口获取的企业授权链接打开效果如下：

企业用户授权操作页面效果：点击查看 企业认证｜授权操作手册

授权通过后开发者可直接通过 授权完成通知 接收企业用户的账号ID（orgId）和经办人的个人账号ID（psnId），或者通过 查询机构认证信息 接口查询企业用户的账号ID（orgId），再通过 查询企业成员列表 查询企业的成员信息，需要确认经办人个人账号ID（psnId）有模板管理权限（如果成员没有权限需要通过 添加成员角色 接口去添加模板管理权限），建议经办人直接用管理员或者法定代表人账号，无需单独分配权限。（应用ID所属的平台自身企业账号无需单独做授权）

二.流程模板的制作

获取《创建流程模板》页面链接 接口获取的链接打开后操作效果展示如下：

可以通过 获取《创建流程模板》页面链接 接口中开发者自定义的重定向跳转地址获取此次模板制作的流程模板ID（signTemplateId），再通过 查询流程模板详情 接口获取流程模板制作的参与方信息（participants）、控件列表（components）等信息。

后续如果需要做模板列表展示时可以通过 查询流程模板列表 接口查询企业下全部的模板信息。需要编辑模板时，需要先 停用流程模板 再 获取《编辑流程模板》页面链接 进行模板的修改。再次使用前需要 开启流程模板 才可以发起合同拟定和签署流程。

三.用户的填写与签署

通过流程模板创建合同拟定和签署流程 接口发起合同拟定（用户填写）和签署流程后，如果发起时设置了通知方式，e签宝会自动给用户发送短信/邮件，通知用户填写合同内容，开发者也可以通过接口获取用户的填写链接。

获取填写页面链接 接口获取的用户填写链接打开效果如下（与短信/邮件通知里的链接打开效果一样）：

当单方、双方或者多方用户填写完成后，合同拟定完成（用户每次填写后会触发 流程填写人填写状态通知 所有人填写完成后触发 合同拟定结果通知 ，开发者可以在回调通知中接受具体的节点信息），合同拟定完成后流程将进入签署阶段。如果发起时设置了通知方式，e签宝会自动给用户发送短信/邮件，通知用户进行签署，开发者也可以通过接口获取用户的签署链接。

获取签署页面链接 接口获取的用户签署链接打开效果如下（与短信/邮件通知里的链接打开效果一样）：

用户签署操作页面效果：点击查看 SaaS API V3版用户签署页操作手册

用户签署操作视频演示：签署演示视频.mp4

整个过程建议开发者接入查询接口查询流程的具体信息：

查询合同拟定和签署流程状态 接口可以查询流程处于什么阶段。

查询合同拟定详情 接口查询合同拟定阶段的具体信息。

查询签署流程详情 接口查询签署阶段的具体信息。

当用户签署完成后，开发者可以进行最终签署合同的下载：下载已签署文件及附属材料（当发起流程时没有设置自动完结时，需要调用 完结签署流程 接口进行签署流程的完结，流程完结后签署完的合同才允许下载）。

四.企业如何自动落章

流程模板是根据模板来发起合同拟定和签署的，如果模板配置开启了自动落章，接口会自动识别到配置，签署接口无需额外的参数来控制。

点击查看 流程模板如何自动落章