Este artigo irá guiá-lo através do processo de envio de um documento para assinatura usando um modelo com o Sign.Plus eSignature API.
Ao seguir estes passos, você criará um envelope a partir de um modelo, definirá os detalhes do destinatário e enviará o envelope para assinatura.
Pré-requisitos
- Uma conta Sign.Plus com um plano de API
- Seu Token de Acesso Pessoal
- Um modelo existente na sua conta Sign.Plus
Passo 1: Crie um envelope a partir de um modelo
- Use o endpoint POST /v2/envelope/from_template/{template_id} para criar um novo envelope a partir de um template.
- Substituir
{template_id}
pelo ID do seu modelo existente.
Onde posso encontrar meu ID de template?- Vá para https://app.sign.plus/templates.
- Clique no nome do template desejado.
- Copie a ID da barra lateral direita.
- Vá para https://app.sign.plus/templates.
- Envie uma solicitação POST para
POST /v2/envelope/from_template/{template_id}
com o seguinte corpo JSON:{
"name": "Meu maravilhoso envelope de modelo"
} - Inclua sua chave API no cabeçalho
autorização
. - On success, you will receive
an Envelope
object.{
"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": {
// ...
}
} - Salve o
id
retornado comoenvelope_id
para futuras chamadas de API. - Registre o
id
de cada destinatário para uso posterior no processo de assinatura.
Exemplos:-
66eb7d0467d2d549b89fcb71
: PrimeiroSIGNER
(Passo 1) -
66eb7d0467d2d549b89fcb71
:RECEIVES_A_COPY
(Etapa 1) -
66eb7d0467d2d549b89fcb72
: SegundoSIGNER
(Etapa 2)
-
Passo 2: Definir detalhes do destinatário
Se o seu modelo não tem os destinatários fixos e você precisa definir ou atualizar os detalhes do destinatário:
- Use o endpoint POST /v2/envelope/{envelope_id}/signing_steps para atualizar as informações do destinatário.
- Substitua
{envelope_id}
pela ID que recebeu no Passo 1. - Send a
POST
request with the following JSON body:{
"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"
}
]
}
]
} - Em caso de sucesso, você receberá uma matriz de objeto
SigningStep
.
Passo 3: Envie seu envelope para assinatura
- Use o endpoint POST /v2/envelope/{envelope_id}/enviar para enviar o envelope.
- Substitua
{envelope_id}
pelo seu ID do envelope a partir do Passo 1. - Envie uma solicitação
POST
para este endpoint. - Em caso de sucesso, o envelope será enviado para o(s) destinatário(s) para assinatura.
Conclusão
Você agora enviou com sucesso um documento para assinatura usando um modelo com a API Sign.Plus eSignature API. O(s) destinatário(s) receberá(s) uma notificação por e-mail com um link para assinar o documento.
Usar modelos pode simplificar significativamente seu fluxo de trabalho de assinatura, especialmente para documentos frequentemente usados, com layouts consistentes e requisitos de assinatura.