Este artigo irá guiá-lo através do processo de envio de um documento para assinatura usando o Sign.Plus eSignature API.
Seguindo estes passos, você criará um envelope, adicionará um documento, definirá um destinatário, inserirá uma anotação na assinatura e, finalmente, enviará o envelope para assinatura.
Pré-requisitos
- Uma conta Sign.Plus com um plano de API
- Seu Token de Acesso Pessoal
Passo 1: Criar um Envelope
Um envelope é um recipiente para documentos serem assinados por destinatários.
- Envie uma solicitação para o endpoint POST /v2/envelope para criar um novo envelope.
{
"name": "Meu envelope maravilhoso",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Inclua sua chave API no cabeçalho
autorização
. -
Em caso de sucesso, você receberá um objeto
Envelope
.{ "id": "<string>" ... }
-
Salve o
id
como oenvelope_id
Passo 2: Adicione um documento ao seu envelope
-
Use o endpoint POST /v2/envelope/{envelope_id}/document para adicionar um documento.
-
Substitua
{envelope_id}
pela ID que recebeu no Passo 1. - Enviar uma solicitação POST com o arquivo de documento no corpo da solicitação na forma
multipart/form-data.
-
Em caso de sucesso, você receberá um objeto
Documento
como resposta.{ "id": "<string>" ... }
-
Salve o
id
como o document_idpara mais tarde.
Passo 3: Defina um destinatário para seu envelope
-
Use o endpoint POST /v2/envelope/{envelope_id}/signing_steps para adicionar um destinatário.
-
Substituir
{envelope_id}
por sua ID do envelope. -
Envie um pedido
POST
com o seguinte corpo: JSON corpo:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john. oe@exemplo. om", "papel": "SIGNER"
} ] } ] } -
Em caso de sucesso, você receberá uma matriz de
SigninStep
. -
Navegue pela matriz e pegue o nome de
id
do destinatário para o qual você deseja adicionar o quadro de assinatura (anotação de assinatura). Save thisid
as therecipient_id
.
Passo 4: insira uma anotação de assinatura no seu documento
Antes de adicionar uma assinatura anotação, certifique-se de que você definiu sua assinatura na plataforma Sign.Plus.
- Use o endpoint POST /v2/envelope/{envelope_id}/annotation para adicionar uma anotação da assinatura.
- Substituir
{envelope_id}
por sua ID do envelope. - Send a
POST
request with the following JSON body:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Substitua
<recipient_id>
e<document_id>
pelos valores apropriados.
Passo 5: Envie seu envelope para assinatura
- Use o endpoint POST /v2/envelope/{envelope_id}/enviar para enviar o envelope.
- Substituir
{envelope_id}
por sua ID do envelope. - Envie uma solicitação
POST
para este endpoint. - Em caso de sucesso, o envelope será enviado ao destinatário para assinatura.
Conclusão
Você agora enviou com sucesso um documento para assinatura usando a API Sign.Plus eSignature O destinatário receberá uma notificação por e-mail com um link para assinar o documento.
For more detailed information on each API endpoint used in this process, please refer to our API documentation.