Para acelerar sua integração com o ClickFlow (Orquestrador e Executor), 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 step.

Por que usar as Collections?

• Todos os endpoints do Orquestrador e do Executor, já organizados por recurso.
• Exemplos prontos de POST /api/v1/flows para cada tipo de step (consent, form, verify, kyc, signature) — inclusive combinações comuns, como Verify + KYC.
• Variáveis de ambiente pré-configuradas para sandbox (host, access_token, flow_id, execution_id).

Como Utilizar

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

Downloads

Postman

1. Baixe o JSON da collection e o do environment (tabela acima) — um par para o Orquestrador, outro para o Executor.
2. No Postman, Import > File para cada um dos dois arquivos.
3. Selecione o environment importado (ClickFlow Orchestrator - Sandbox ou ClickFlow Runner - Sandbox) no seletor de ambiente.
4. Preencha a variável access_token com o UUID do seu access token.
5. Preencha flow_id / execution_id conforme o request que for testar.

Insomnia

1. 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).
2. Create > Import > From File e selecione o arquivo baixado.
3. Selecione o ambiente Sandbox.
4. Preencha access_token.

Bruno

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

O que está incluído?

Orquestrador (ClickFlow Orchestrator)

Pastas: Health · Executions · Flows · Exemplos de Flows.

Exemplos de Flows (todos POST /api/v1/flows, um por tipo de step e combinação comum):

• Consent
• Consent — variáveis por step (channel_params)
• Form
• Form — atualização de contato
• Form — injeção de respostas de formulários anteriores
• Form — injeção do contato no formulário
• KYC — biometric_behavior + kyc (CNPJ)
• KYC — form + biometric_behavior + kyc (CPF)
• Signature — template + configurações do envelope
• Signature — arquivo S3
• Signature — filename com interpolação
• Signature — arquivo S3 + template
• Signature — runner_files
• Signature — template + signatários extras
• Verify — liveness
• Verify — biometric_behavior
• Verify — biometric_behavior + form
• Verify — identity_biometrics
• Verify — instructions
• Verify — provider_priority

Detalhe de cada tipo de step e do context esperado: Orquestrador. Papel de cada módulo por trás do step: Módulos.

Executor (ClickFlow Runner)

Pastas: Health · Executions.

Crie e publique o flow no Orquestrador; dispare a execução no Executor. Canal whatsapp vs. api, upload de arquivo no disparo e cancelamento: Executor.

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.

As collections já vêm 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):

Atualizações e Suporte

As collections são geradas a partir das specs públicas do Orquestrador e do Executor (/api/v1, sem rotas internas) e serão atualizadas 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 ClickFlow e autenticação.
• Orquestrador — todos os tipos de step e ciclo de vida do flow.
• Executor — canal whatsapp vs. api.