Como criar modelos de documentos?

Com essa funcionalidade, você consegue gerar novos documentos de forma automática a partir de modelos pré-definidos em formato Word


A função Modelos está disponível apenas para clientes Clicksign Automação - Fluxia e clientes que utilizem nossa API. Essa funcionalidade é ideal para quem tem documentos padronizados e deseja reduzir o tempo de criação deles.

É possível criar modelos de documentos através da plataforma Clicksign, ou diretamente via API. Saiba mais!

Criando um modelo através da plataforma Clicksign

Passo 1. Na opção Modelos, 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:

Os campos editáveis devem ser nomeados e estar entre chaves duplas. 

Por exemplo:  {{Razão Social}}{{Endereço}}{{Telefone}}.

Recomendamos que utilize nosso documento modelo para seu primeiro teste. Clique aui  para baixá-lo.

⠀⠀⠀⠀⠀⠀⠀⠀⠀

Passo 3: Clique em Gerar documento para informar os dados para os campos editáveis do modelo.

⠀⠀⠀⠀⠀⠀⠀⠀⠀

Passo 4: Gerar documentos a partir do Modelo.

Adicione os dados variáveis do documento em formato JSON, clique em Gerar documento e siga o fluxo padrão de envio de documentos.

{"Razão Social": "SICRANO BELTRANO - EIRELI ME","Cidade": "Campo Grande","Estado": "MS","CNPJ": "11.222.333/0001-44","Nome": "Sicrano Beltrano","Detalhes do Serviço": "serviços de construção e gerenciamento","Remuneração $": "R$ 1.000,00","Remuneração extenso": "mil reais","Dia da Assinatura": "7","Mês da Assinatura": "Setembro","Ano da Assinatura": "2019"}

Criando modelos de documentos via API

Passo 1. Na plataforma Clicksign, clique em Configurações, e em seguida em API. 

Passo 2. Agora é só criar o Access Token e copiá-lo, para fazer a requisição via API.

Passo 3. Faça a requisição via API no ambiente de desenvolvimento.

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. 

⠀⠀⠀⠀⠀⠀⠀⠀⠀

Dúvidas? Entre em contato com ajuda@clicksign.com


Fique à vontade para esclarecer dúvidas, relatar erros, dar sugestões, fazer críticas construtivas ou elogios.

Ainda precisa de ajuda? Contate-nos Contate-nos