本文将指导您使用模板通过Sign.Plus 电子签名 API发送文档以进行签署。
按照以下步骤,您将从模板创建信封,设置收件人详情,并发送信封以进行签署。
前提条件
第 1 步:从模板创建信封
- 使用 POST /v2/envelope/from_template/{template_id} 端点,从模板创建一个新的信封。
- 将
{template_id}替换为您现有模板的 ID。
在哪里可以找到我的模板 ID?- 前往 https://app.sign.plus/templates。
- 点击所需的模板名称。
- 从右侧边栏复制 ID。
- 前往 https://app.sign.plus/templates。
- 向
POST /v2/envelope/from_template/{template_id}发送带有以下 JSON 正文的 POST 请求:{"name": "My wonderful envelope from template"} - 在
Authorization请求头中包含您的 API 密钥。 - 成功后,您将收到
an Envelope对象。{"id": "66eb7d0467d2d549b89fcb6d",// ..."signing_steps": [{"recipients": [{"id": "66eb7d0467d2d549b89fcb70","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]},{"recipients": [{"id": "66eb7d0467d2d549b89fcb71","uid": null,"name": "","email": "","role": "RECEIVES_COPY","verification": null},{"id": "66eb7d0467d2d549b89fcb72","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]}],"documents": [// ...],"notification": {// ...}} - 保存返回的
id,用作后续 API 调用的envelope_id。 - 记录每位收件人的
id,以便日后在签署流程中使用。
示例:-
66eb7d0467d2d549b89fcb71:第一个SIGNER(第 1 步) -
66eb7d0467d2d549b89fcb71:RECEIVES_A_COPY(第 1 步) -
66eb7d0467d2d549b89fcb72:第二个SIGNER(第 2 步)
-
第 2 步:设置收件人详情
如果您的模板没有固定的收件人,且您需要设置或更新收件人详情:
- 使用POST /v2/envelope/{envelope_id}/signing_steps端点来更新收件人信息。
- 将
{envelope_id}替换为您在第 1 步中获得的 ID。 - 发送包含以下 JSON 正文的
POST请求:{
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m.twain@example.com",
"role": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j.smith@example.com",
"role": "SIGNER"
}
]
}
]
} - 成功后,您将收到一个
SigningStep对象数组。
第 3 步:发送信封以进行签署
- 使用POST /v2/envelope/{envelope_id}/send端点来发送信封。
- 将
{envelope_id}替换为您在第 1 步中获得的信封 ID。 - 向该端点发送
POST请求。 - 成功后,信封将被发送给收件人以进行签署。
结语
您现在已成功使用 Sign.Plus 电子签名 API 通过模板发送了一份待签署的文档。收件人将收到一封电子邮件通知,其中包含用于签署文档的链接。
使用模板可以显著简化您的文档签署流程,尤其适用于版式和签署要求一致的常用文档。