Criar documento via Modelo

post
Criar documento via Modelo

https://api.zapsign.com.br/api/v1/models/create-doc/?api_token={{seu_token_de_acesso}}
Esse endpoint permite que você crie um documento a partir de um Modelo dinâmico (isto é, um .docx com variáveis que você sobe na ZapSign, que terá suas variáveis automaticamente substituídas e convertido para .pdf). Você deverá enviar os dados em JSON, bem como receberá eles nesse mesmo formato.
Request
Response
Request
Body Parameters
sandbox
optional
boolean
Default: false. Defina como true caso se trate de um documento de teste (sem cobrança de créditos e sem validade jurídica).
template_id
required
string
ID do template (modelo dinâmico)
signer_name
required
string
Nome do signatário do documento. Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário.
data[]['de']
required
string
Nome da variável a ser substituída. Ex: "{{NOME COMPLETO}}"
data[]['para']
required
string
Valor a ser preenchido no lugar da variável. Ex: "João dos Santos"
Response
200: OK

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: ""

    • 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).

Exemplo de requisição

Os parâmetros devem estar em formato JSON no corpo da requisição

{
"template_id":"ad896ea9-3c69-48d8-893a-3ee10fdb1e8d",
"signer_name":"João dos Santos",
"external_id":"123",
"data":[
{
"de":"{{NOME COMPLETO}}",
"para":"João dos Santos"
},
{
"de":"{{NÚMERO DO CPF}}",
"para":"123.456.789-10"
},
{
"de":"{{ENDEREÇO COMPLETO}}",
"para":"Rua Brigadeiro, n. 10, CEP 05622-001"
}
]
}

O que fazer com a resposta

Após uma requisição bem sucedida, você deverá receber uma resposta como essa:

{
"open_id": 5,
"token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
"status": "pending",
"name": "Contrato de Admissão",
"original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
"signed_file": null,
"created_at": "2020-04-16T03:33:46.241747Z",
"last_update_at": "2020-04-16T03:33:46.241775Z",
"signers": [
{
"token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
"status": "new",
"name": "João da Silva",
"email": "",
"phone_country": "",
"phone_number": "",
"times_viewed": 0,
"last_view_at": null,
"signed_at": null
}
]
}

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}}

Baixe aqui um .docx de exemplo: https://app.zapsign.com.br/assets/modelo/Exemplo-Modelo-Dinamico.docx

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".