Como criar um modelo de documento?

Crie um modelo de documento que será preenchido automaticamente a partir de um fluxo. Confira!

A partir do  modelo de documento é possível automatizar a geração de documentos onde existe um conteúdo padrão, em que se alteram apenas alguns dados variáveis do signatário (quem assina) através do Fluxo com formulário ou Fluxo com planilha

Assista já o vídeo onde mostramos a criação dos modelos de documento.


Criando um modelo através da plataforma Clicksign

Passo 1. Em "Modelos" no menu lateral, clique em "Criar Modelo";

Passo 2. Escolha o nome que deseja vincular ao modelo, o arquivo em formato .docx, uma cor de identificação do modelo e clique em "Salvar";

Você também pode baixar um documento de exemplo com variáveis, clicando abaixo da seleção do modelo.⠀⠀⠀⠀⠀⠀⠀

Pronto! Modelo de documento criado com sucesso. ✔️


Criando modelos de documentos via API

Passo 1. Clique em " Configurações", e em seguida em " API";   

Passo 2. Clique em " Gerar  Access Token" e utilize-o para fazer a requisição via API.

Para consultar mais informações acesse a página Desenvolvedores.

Dicas

No modelo .docx:

Possíveis mensagens de erro ao tentar realizar o upload de seu modelo:

  • Erro no fechamento da tag ''.:Possivelmente foi adicionado um a chave a mais em um ou mais parâmetros do documento, como por exemplo "{{parâmetro}}}".
  • Erro no fechamento da tag '{parâmetro}'.:
    Se for indicado o nome do parâmetro que contêm algum erro, possivelmente esteja faltando uma chave nele, como por exemplo "{{parâmetro}"

⠀⠀⠀⠀⠀⠀⠀⠀⠀

No JSON para geração do documento:

O formato JSON deve seguir o padrão:

{"variável": "valor da variável","variável 1": "valor da variável 1"...}

  • Sempre comece com uma Chave 
  • Sempre inclua aspas antes e após a variável 
  • Inclua dois pontos 
  • Sempre inclua aspas antes e após o valor atribuído à variável
  • Todas as linhas devem ser finalizadas com vírgula, exceto a última linha
  • Encerre com uma chave 

Caso não seja passado no formato JSON corretamente, uma mensagem de erro será exibida.



Perguntas frequentes 

O que é JSON? 
JSON é um padrão de escrita para troca de dados entre sistemas, é  uma maneira de armazenar e representar informações de forma organizada e fácil de acessar. Mais informações em: https://www.devmedia.com.br/o-que-e-json/23166.

Como eu mando o documento após a geração? 
Após a geração do documento, ele é encaminhado como qualquer outro documento dentro da Clicksign. É necessário adicionar signatários, seus respectivos e-mails e qual a qualificação de suas assinaturas, decidir como será enviado o Token de autenticação e enviar o documento para assinatura.

Este artigo respondeu suas dúvidas? Agradecemos o feedback Ocorreu um problema para enviar seu feedback