Como criar um modelo de documento via API

Automatize a criação de documentos com integração via API

Disponível para o plano Integração. Saiba mais em Planos e Preços.

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

Untitled-15

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

 

Dicas

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

  • Chave a mais na variável impede o fechamento da tag: possivelmente foi adicionado uma 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 

     

    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.


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