一步发起签署接口属于聚合接口,可以一次性传入签署过程所需的数据,快速发起签署任务。
一步发起签署接口涵盖了创建签署流程、流程中追加签署文件、附件、签署区、开启流程、结束流程等接口所需要的数据和功能,可以减少接口的调用数量。
autoInitiate(签署流程自动开启参数)
一步发起签署接口中的 autoInitiate 参数设置true时将在接口调用成功后自动开启签署流程。如果不希望自动开启签署流程,需要将 autoInitiate 参数设置false,并在需要开启签署流程时主动调用签署流程开启接口。
autoArchive(签署流程自动结束参数)
一步发起签署接口中的 autoArchive 参数设置true时将所有签署方签字盖章完成后自动将签署流程结束。流程结束后,不允许再追加签署区。如果不希望自动结束,autoArchive 参数设置false,并在签署文件下载前先调用签署流程结束接口。
signers(签署方列表参数)
signers签署方列表参数设置规则如下:
参数字段\签署场景 | 平台方 自动签署 | 用户手动签署(个人) | 用户自动签署(个人) | 用户手动签署(企业) | 用户自动签署(企业) |
platformSign | true | false | false | false | false |
signerAccountId | 不传 | 个人签署账号ID | 个人签署账号ID | 个人签署账号ID | 不传 |
authorizedAccountId | 不传 | 不传 | 不传 | 机构签署账号ID | 机构签署账号ID |
autoExecute | true | false | true | false | true |
actorIndentityType | 2或不传 | 0或不传 | 0或不传 | 2 | 2 |
签署流程状态查看
企业开发者可以根据e签宝消息通知服务来异步接收签署流程状态变动通知,查看【回调通知接收说明】。
如果长时间未接收到签署流程状态变动的回调通知,企业开发者可以主动调用签署流程查询、流程签署人列表和查询签署区列表接口来获知签署流程当前进展状态。
签署流程撤销
发起签署任务后,如果因某些原因需要将此签署流程进行撤销,企业开发者可以调用签署流程撤销接口。
如果签署流程已被归档,则无法再撤销签署流程。签署流程撤销成功后,基于此签署流程的所有签署都失效。
签署区删除
发起签署任务后,如果发现某个签署方不需要参与签署时,企业开发者可以调用删除签署区接口将其从此签署流程中删除。
如果签署流程已被归档或某签署方已完成签署操作则无法再进行删除。