从模板创建的Envelope能否用于Embedded Signing?求实现方案
从模板创建信封并实现嵌入式签署的方法
从模板生成的信封完全支持嵌入式签署,问题通常出在信封创建阶段的配置遗漏,以下是完整实现步骤:
1. 带嵌入式签署配置创建信封
调用创建信封API时,必须为每个需要嵌入式签署的签署人添加clientUserId字段,这是区分邮件签署和嵌入式签署的核心标识。
示例请求(JSON格式):
{ "templateId": "YOUR_TEMPLATE_ID", "status": "sent", "templateRoles": [ { "email": "signer@example.com", "name": "John Doe", "roleName": "模板中定义的角色名称", "clientUserId": "YOUR_SYSTEM_USER_ID" // 你的系统内唯一用户标识,非空字符串 } ] }
2. 获取嵌入式签署链接
信封创建成功后,调用创建收件人视图API,传入对应参数生成签署链接:
示例请求(JSON格式):
{ "envelopeId": "CREATED_ENVELOPE_ID", "returnUrl": "https://your-app.com/post-sign", // 签署完成后跳转的页面 "clientUserId": "YOUR_SYSTEM_USER_ID", // 与创建信封时的该签署人clientUserId一致 "authenticationMethod": "none", // 根据安全需求选择,如password、phone等 "email": "signer@example.com", "userName": "John Doe" }
接口返回结果中的url字段就是签署人可直接访问的嵌入式签署入口。
3. 常见问题排查
- 若未设置
clientUserId,信封会默认触发邮件签署流程,无法生成嵌入式链接,需重新创建信封并补充该字段。 - 确保
roleName与模板中定义的角色名称完全匹配,否则签署人无法关联模板内的签署位置。 - 信封状态必须设置为
sent,否则无法生成有效签署链接。
内容的提问来源于stack exchange,提问作者Seraph
相关产品推荐
相关产品推荐

