ZapSign API
Search…
Criar documento via Modelo
post
https://api.zapsign.com.br
/api/v1/models/create-doc/?api_token={{seu_token_de_acesso}}
Criar documento via Modelo

Campos opcionais da requisição

  • Documento - raiz do JSON:
    • lang (string): idioma do documento. Valores possíveis: "pt-br" (português), "es" (espanhol), "en" (inglês). Default: "pt-br"
    • disable_signer_emails (boolean): para desativar os e-mails enviados aos signatários, envie esse parâmetro como true. Default: false
    • signed_file_only_finished (boolean): para desativar os botões "Baixar original" e "Baixar assinado" da experiência de signatário, ative este flag. Assim, você é quem se encarregará de entregar o signed_file ao signatário. Default: false
    • brand_logo (string): se deseja personalizar a logomarca da experiência de assinatura deste documento específico, envie a URL da imagem (precisa ser um link publicamente acessível). Default: ""
    • brand_primary_color (string): se deseja personalizar a cor primária (do botão) da experiência de assinatura deste documento específico, envie em rgb ou hexadecimal. Ex: "#0011ee". Default: ""
    • brand_name (string): se deseja personalizar o nome do remetente dos e-mails enviados ao signatário, insira aqui o nome da marca. Por exemplo, se inserido "XPTO Advogados", o remetente do e-mail será "XPTO Advogados via ZapSign". Max-length: 100 caracteres. Default: ""
    • external_id (string): ID do documento na sua aplicação. Default: ""
    • folder_path (string): caminho da pasta dentro da ZapSign em que o documento será colocado. Se as pastas não existirem, serão criadas automaticamente. Requisitos: (1) o folder_path pode ter até 255 caracteres, (2) cada pasta pode ter até 50 caracteres, (3) há um limite de 5 níveis de pasta. Ex.: "/api/" ou "/pasta1/pasta2/pasta3/". Default: "/" (sem pasta).
    • created_by (string): e-mail do usuário que será definido como criador do documento, para fins de organização interna. Caso o e-mail não exista ou não seja usuário da sua conta, este parâmetro será ignorado. Default: "" (documento terá como criador aquele usuário que criou o modelo)
    • send_automatic_email (boolean): Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o email do signatário seja definido com um campo dinâmico, por exemplo {{EMAIL DO CLIENTE}}, e esse valor seja enviado junto da requisição.
    • custom_message (string): (apenas relevante caso send_automatic_email: true). A custom_message é a mensagem personalizada que você pode inserir no e-mail enviado pela ZapSign ao signatário. Exemplo: "Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO". O símbolo \n serve para "pular uma linha" no texto do e-mail. Default: ""

Exemplo de requisição

Os parâmetros devem estar em formato JSON no corpo da requisição
1
{
2
"template_id":"ad896ea9-3c69-48d8-893a-3ee10fdb1e8d",
3
"signer_name":"João dos Santos",
4
"external_id":"123",
5
"send_automatic_email":true,
6
"data":[
7
{
8
"de":"{{EMAIL CLIENTE}}",
10
},
11
{
12
"de":"{{NOME COMPLETO}}",
13
"para":"João dos Santos"
14
},
15
{
16
"de":"{{NÚMERO DO CPF}}",
17
"para":"123.456.789-10"
18
},
19
{
20
"de":"{{ENDEREÇO COMPLETO}}",
21
"para":"Rua Brigadeiro, n. 10, CEP 05622-001"
22
}
23
]
24
}
Copied!

O que fazer com a resposta

Após uma requisição bem sucedida, você deverá receber uma resposta como essa:
1
{
2
"open_id": 5,
3
"token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
4
"status": "pending",
5
"name": "Contrato de Admissão",
6
"original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
7
"signed_file": null,
8
"created_at": "2020-04-16T03:33:46.241747Z",
9
"last_update_at": "2020-04-16T03:33:46.241775Z",
10
"signers": [
11
{
12
"token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
13
"sign_url": "https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
14
"status": "new",
15
"name": "João da Silva",
16
"email": "",
17
"phone_country": "",
18
"phone_number": "",
19
"times_viewed": 0,
20
"last_view_at": null,
21
"signed_at": null
22
}
23
],
24
"answers": [
25
{
26
"variable": "NOME COMPLETO",
27
"value": "Nome Teste"
28
},
29
{
30
"variable": "NÚMERO DO CPF",
31
"value": "99999999999"
32
},
33
{
34
"variable": "ENDEREÇO COMPLETO",
35
"value": "Endereço teste"
36
}
37
]
38
}
Copied!
O que você deverá fazer com essa resposta é enviar o link de assinatura para o signatário através da sua aplicação.
O link de assinatura consiste na rota: https://app.zapsign.com.br/verificar/{{signer_token}}
Ou seja, no exemplo acima, você deve enviar o seguinte link de assinatura ao signatário: - João da Silva: https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b E agora é só aguardar que o signatário assine!
Mais de um signatário? Se você quiser adicionar mais signatários, utilize o endpoint "Adicionar signatário", receba o token do novo signatário e envie o link de assinatura como explicado acima.

Como criar um Modelo dinâmico na ZapSign

Um modelo dinâmico na ZapSign é um .docx (Word) com variáveis, representadas por duplas chaves. Exemplo: {{NOME COMPLETO}}
Exemplo de Modelo dinâmico
Para inserir um modelo dinâmico na ZapSign, entre na sua conta e vá na aba "Modelos".
Observação: é necessário adquirir um plano de API mensal para ter acesso (inclusive para teste) aos Modelos. Cada documento criado via Modelo gastará apenas 1 crédito da API, não há cobrança extra por estar usando os Modelos.
Entre na sua conta, clique em "Modelos", "Novo modelo" e "Modelo dinâmico".
O "template_id" do seu Modelo dinâmico pode ser encontrado aqui:
"template_id" do seu Modelo dinâmico

Mais de um signatário

Se você precisar definir mais campos do signatário ou precisar de mais de um signatário, utilize os endpoints "Atualizar signatário" e "Adicionar signatário".