Para acelerar sua integração com o ClickForm, disponibilizamos collections prontas para os aplicativos de teste de API mais usados: Postman, Insomnia e Bruno. Elas trazem os endpoints já configurados, com exemplos reais de payload para cada tipo de campo.

Por que usar as Collections?

Todos os endpoints de Forms, Versions e Runs, já organizados por recurso.
Exemplos prontos de POST /api/v1/forms/{form_key}/versions para cada tipo de campo — texto, número, data, documentos (CPF/CNPJ), seleção, repetidor e condições.
Variáveis de ambiente pré-configuradas para sandbox (host, access_token, form_key, version_key, run_key).

Como Utilizar

As collections do ClickForm vivem no repositório docs-clicksign-api, junto com as do ClickFlow.

Downloads

Ferramenta	Arquivo	Link
Postman collection	`ClickForm_Postman_Collection.json`	baixar
Postman environment	`ClickForm_Postman_Environment.json`	baixar
Insomnia	`ClickForm_Insomnia_Collection.json`	baixar
Bruno	pasta `bruno/ClickForm/`	abrir pasta

Postman

Baixe o JSON da collection e o do environment (tabela acima).
No Postman, Import > File para cada um dos dois arquivos.
Selecione o environment ClickForm - Sandbox no seletor de ambiente.
Preencha a variável access_token com o UUID do seu access token.
Preencha form_key / version_key / run_key conforme o request que for testar.

Insomnia

Baixe o JSON da collection (já traz os ambientes Sandbox e Produção dentro do próprio arquivo — não precisa de um arquivo de environment separado).
Create > Import > From File e selecione o arquivo baixado.
Selecione o ambiente Sandbox.
Preencha access_token.

Bruno

Clone o repositório docs-clicksign-api (ou baixe só a pasta bruno/ClickForm/).
No Bruno, Open Collection apontando para a pasta.
Selecione o ambiente Sandbox (environments/Sandbox.bru).
Preencha access_token — a autenticação já está herdada em collection.bru (header Authorization, tipo API key).

O que está incluído?

Pastas: Health · Forms · Versions · Runs · Exemplos de versões.

Request	Método	Path
Verifica disponibilidade do serviço	GET	`/health`
Lista todos os formulários	GET	`/api/v1/forms`
Cria o formulário base	POST	`/api/v1/forms`
Retorna metadados de um formulário específico	GET	`/api/v1/forms/{form_key}`
Atualiza os metadados do formulário	PUT	`/api/v1/forms/{form_key}`
Remove um formulário	DELETE	`/api/v1/forms/{form_key}`
Lista todas as versões de um formulário	GET	`/api/v1/forms/{form_key}/versions`
Cria uma nova versão (schema)	POST	`/api/v1/forms/{form_key}/versions`
Retorna a estrutura da versão	GET	`/api/v1/forms/{form_key}/versions/{version_key}`
Atualiza metadados da versão (ex.: `is_active`)	PUT	`/api/v1/forms/{form_key}/versions/{version_key}`
Remove uma versão específica	DELETE	`/api/v1/forms/{form_key}/versions/{version_key}`
Lista todas as execuções associadas a uma versão	GET	`/api/v1/versions/{version_key}/runs`
Cria uma versão pré-preenchida (run)	POST	`/api/v1/versions/{version_key}/runs`
Obtém uma execução (run) por versão	GET	`/api/v1/versions/{version_key}/runs/{run_key}`
Atualiza contexto, `expires_at` ou `callback_url` do run	PUT	`/api/v1/versions/{version_key}/runs/{run_key}`
Remove uma execução pendente	DELETE	`/api/v1/versions/{version_key}/runs/{run_key}`

Exemplos de versões (todos POST /api/v1/forms/{form_key}/versions, um por tipo de campo):

Texto curto · Texto longo · Número · Intervalo numérico · E-mail do signatário · Número de telefone/WhatsApp · Data · CPF · CNPJ · Monetário · CEP · Imagem · Anexo · Cabeçalho · Parágrafo · Lista suspensa · Única resposta · Múltiplas respostas · Repetidor de campos · Campos com regras condicionais.

Modelo de dados (Form → Version → Run), tipos de campo, conditions e verificação de acesso: Criar e utilizar formulários.

Autenticação e ambientes

Header Authorization com o UUID do access token — sem prefixo Bearer. Mesma regra de Primeiros passos. O endpoint /health não exige autenticação.

A collection já vem com o host apontando para sandbox. Para testar em produção, troque a variável host (Postman/Bruno) ou selecione o ambiente Produção (Insomnia/Bruno):

Ambiente	Host
Sandbox (padrão)	`clickform-sandbox.clicksign.com`
Produção	`clickform.clicksign.com`

Atualizações e Suporte

A collection é gerada a partir da spec pública do ClickForm (/api/v1, sem rotas internas) e será atualizada conforme a API evoluir. Caso encontre alguma dificuldade ou tenha sugestões de melhoria, entre em contato com o Suporte.

Próximo passo ➡️

Primeiros passos — visão geral do ClickForm e autenticação.
Criar e utilizar formulários — tipos de campo, condições e verificação de acesso.

❓Precisa de ajuda? Entre em contato com o Suporte

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ