Como enviar um documento a partir de um modelo existente?

Este artigo vai guiá-lo através do processo de envio de um documento para assinatura utilizando um modelo com a API de assinatura eletrónica Sign.Plus.

Ao seguir estes passos, vai criar um envelope a partir de um modelo, definir os dados dos destinatários e enviar o envelope para assinatura.

Pré-requisitos

• Uma conta Sign.Plus com um plano de API
• O seu Personal Access Token
• Um modelo existente na sua conta Sign.Plus 

Passo 1: Criar um envelope a partir de um modelo

1. Utilize o endpoint POST /v2/envelope/from_template/{template_id} para criar um novo envelope a partir de um modelo.
2. Substitua {template_id} pelo ID do seu modelo existente.
   Onde posso encontrar o ID do meu modelo?
   • Aceda a https://app.sign.plus/templates .
     
   • Clique no nome do modelo pretendido.
     
   • Copie o ID a partir da barra lateral direita.
3. Envie um pedido POST para POST /v2/envelope/from_template/{template_id} com o seguinte corpo JSON:
   {
"name": "My wonderful envelope from template"
}
4. Inclua a sua chave de API no cabeçalho Authorization.
5. Em caso de sucesso, receberá um objeto 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": {
// ...
}
}
6. Guarde o id devolvido como envelope_id para futuras chamadas à API.
7. Registe o idde cada destinatário para utilização posterior no processo de assinatura.
   Exemplos:
   • 66eb7d0467d2d549b89fcb71: Primeiro SIGNER (Passo 1)
   • 66eb7d0467d2d549b89fcb71: RECEIVES_A_COPY (Passo 1)
   • 66eb7d0467d2d549b89fcb72: Segundo SIGNER (Passo 2)

Passo 2: Definir os detalhes do destinatário

Se o seu modelo não tiver destinatários fixos e for necessário definir ou atualizar os detalhes do destinatário:

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/signing_steps para atualizar as informações do destinatário.
2. Substitua {envelope_id} pelo ID que recebeu no Passo 1.
3. Envie um pedido POST com o seguinte corpo JSON:
   {
"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"
}
]
}
]
}
4. Em caso de sucesso, receberá um array de objetos SigningStep.

Passo 3: Enviar o envelope para assinatura

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/send para enviar o envelope.
2. Substitua {envelope_id} pelo ID do seu envelope do Passo 1.
3. Envie um pedido POST para este endpoint.
4. Em caso de sucesso, o envelope será enviado ao(s) destinatário(s) para assinatura.

Conclusão

Enviou com sucesso um documento para assinatura utilizando um modelo com a API de assinatura eletrónica Sign.Plus. O(s) destinatário(s) receberá(ão) uma notificação por email com uma ligação para assinar o documento.

A utilização de modelos pode simplificar significativamente o seu fluxo de trabalho de assinatura de documentos, especialmente para documentos utilizados com frequência e com esquemas e requisitos de assinatura consistentes.