Collections
Postman, Insomnia e Bruno
Collections prontas para Postman, Insomnia e Bruno, com endpoints, exemplos e variáveis de ambiente. A ordem é API v3, ClickFlow e módulos. O passo a passo da API v3 também está em Ferramentas.
Os arquivos ficam no repositório docs-clicksign-api. Baixe só o produto que for testar.
O clique esquerdo abre o JSON no navegador. Para gravar o arquivo, clique com o botão direito no link e escolha Salvar link como. Importe esse arquivo no Postman ou no Insomnia.
| Produto | Postman | Insomnia | Bruno |
|---|---|---|---|
| API v3 | collection · environment | baixar | — |
| Orquestrador | collection · environment | baixar | abrir pasta |
| Executor | collection · environment | baixar | abrir pasta |
| Módulo de Coleta de Dados (ClickForm) | collection · environment | baixar | abrir pasta |
| Módulos de Aceite e de Notificação | collection · environment | baixar | abrir pasta |
Como importar
Postman. Importe a collection e o environment. Selecione o environment Sandbox e preencha as credenciais.
Insomnia. Importe o JSON (já traz Sandbox e Produção). Selecione o ambiente e preencha as credenciais.
Bruno. Abra a pasta bruno do produto (clickflow/orquestrador/bruno, clickflow/executor/bruno, clickform/bruno ou aceite-e-notificacao/bruno). Selecione o ambiente Sandbox e preencha as credenciais.
O Bruno abre uma pasta, não um JSON. Para tê-la na máquina, baixe o repositório (.zip) e extraia. Quem já usa Git clona e abre a mesma pasta:
git clone https://github.com/clicksign/docs-clicksign-api.gitAs collections apontam para o sandbox, liberado para testes. Produção depende de contratação: fale com o time comercial.
Credenciais e hosts ficam nos primeiros passos, nesta ordem: API v3, ClickFlow, Módulo de Coleta de Dados (ClickForm) e Módulos de Aceite e de Notificação. A collection de Aceite e Notificação autentica com X-API-Key e X-API-Secret.
Próximo passo ➡️
- Primeiros passos da API v3 — crie a conta de sandbox e o access token do Envelope.
- Primeiros passos do ClickFlow — crie, publique e execute um flow.
- Primeiros passos do Módulo de Coleta de Dados (ClickForm) — crie um formulário, uma versão e um run.
- Módulos de Aceite e de Notificação — conheça confirmação e aviso.
❓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
Updated 29 days ago