如何发送文档以供签署？

本文将引导您了解如何使用 Sign.Plus eSignature API 发送文档以供签署。

按照以下步骤，您将创建一个 envelope、添加一份文档、设置一名收件人、插入签名批注，最后发送该 envelope 以供签署。

前提条件

• 拥有API 套餐的 Sign.Plus 账户
• 您的 Personal Access Token

第 1 步：创建 Envelope

envelope 是一个容器，用于存放需要由收件人签署的文档。

1. 向 POST /v2/envelope 端点发送请求以创建新的 envelope。 {
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
}
2. 在 Authorization 标头中包含您的 API 密钥。

3. 成功后，您将收到一个 Envelope 对象。

   { "id": "<string>" ... }

4. 将 id 保存为 envelope_id

第 2 步：将文档添加到您的 envelope

1. 使用 POST /v2/envelope/{envelope_id}/document 端点添加文档。

2. 将 {envelope_id} 替换为您在第 1 步中收到的 ID。

3. 以 multipart/form-data. 的形式在请求正文中发送文档文件，并发出 POST 请求。

4. 成功后，您将收到一个 Document 对象作为响应。
   { "id": "<string>" ... }

5. 将 id 保存为 document_id，供以后使用。

第 3 步：为您的 envelope 设置收件人

1. 使用 POST /v2/envelope/{envelope_id}/signing_steps 端点添加收件人。

2. 将 {envelope_id} 替换为您的 envelope ID。

3. 使用以下 JSON 正文发送 POST 请求：

   {
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] }

4. 成功后，您将收到一个 SigninStep 数组。

5. 浏览该数组，找到您想要添加签名框（签名批注）的收件人的 id 名称。将此 id 另存为 recipient_id。

第 4 步：在文档中插入签名批注

在添加签名批注之前，请确保您已在Sign.Plus 平台中定义了您的签名。

1. 使用POST /v2/envelope/{envelope_id}/annotation端点添加签名批注。
2. 将{envelope_id}替换为您的 envelope ID。 
3. 使用以下JSON正文发送POST请求：
   {
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}

   将<recipient_id>和<document_id>替换为相应的值。

第 5 步：发送您的 envelope 以供签署

1. 使用POST /v2/envelope/{envelope_id}/send端点发送 envelope。
2. 将{envelope_id}替换为您的 envelope ID。
3. 向此端点发送POST请求。
4. 成功后，envelope 将被发送给收件人以供签署。
   
   

结论

您现在已成功使用 Sign.Plus eSignature API 发送了文档以供签署。收件人将收到一封电子邮件通知，其中包含用于签署文档的链接。

有关此流程中使用的每个 API 端点的更多详细信息，请参阅我们的API 文档。