[Flow/Form] Publicar collections de Postman, Insomnia e Bruno do ClickFlow e do ClickForm

[juliomonq-clk]

Summary

Publica no repositório oficial as collections de Postman, Insomnia e Bruno do ClickFlow Orchestrator, do ClickFlow Runner e do ClickForm, geradas a partir do OpenAPI/Swagger em produção.

O host padrão é sandbox. access_token vai em branco. Authorization é UUID, sem Bearer. Rotas /api/internal e capacidade fora de produção (incluindo embedded_signature) ficam de fora. Os arquivos da API v3 de Envelope/Assinatura não são alterados.

Este PR é o mesmo diff do #1, reaberto de branch interna (clickflow-clickform-collections → main) para o merge não depender de fork.

Jira: AVL-4437

Test plan

• Importar cada collection Postman + environment; conferir host sandbox e access_token vazio
• Importar cada collection Insomnia e disparar /health sem autenticação
• Abrir as pastas Bruno e confirmar que não há /api/internal
• Confirmar que Clicksign_Postman_Collection.json, Clicksign_Postman_Environment.json, Clicksign_Insomnia_Expert_Collection.json e Insomnia_Collection.json continuam intactos

[Copilot]

🔵 Needs a closer look

Moderate Insomnia import/authentication issues and documentation/example mismatches remain unresolved.

Pull request overview

Publishes Postman, Insomnia, and Bruno collections for ClickFlow Orchestrator, ClickFlow Runner, and ClickForm.

Changes:

• Adds API collections, requests, and sandbox/production environments.
• Adds Bruno examples and endpoint folders.
• Updates README usage documentation.

Final review notes include moderate Insomnia import/authentication issues and nit-level documentation/example mismatches. ClickForm_Postman_Collection.json also has a nit (1 vote) because its is_active example does not send is_active.

File summaries

File	Reviewed change	Final review notes
README.md	Documents collections and usage.	Nit (1): Bruno is omitted from the introduction; Sandbox selection is not documented.
ClickForm_Postman_Environment.json	Defines ClickForm Postman environments.	No final comment.
ClickForm_Insomnia_Collection.json	Adds ClickForm Insomnia requests.	Moderate (1 each): duplicate Authorization sources; empty Base Environment; unscoped Insomnia variables. Nit (1): the is_active example omits is_active.
ClickFlow_Runner_Postman_Environment.json	Defines Runner Postman environments.	No final comment.
ClickFlow_Runner_Postman_Collection.json	Adds Runner Postman requests.	No final comment.
ClickFlow_Runner_Insomnia_Collection.json	Adds Runner Insomnia requests.	Moderate (1 each): duplicate Authorization sources; empty Base Environment; unscoped Insomnia variables.
ClickFlow_Orchestrator_Postman_Environment.json	Defines Orchestrator Postman environments.	No final comment.
ClickFlow_Orchestrator_Insomnia_Collection.json	Adds Orchestrator Insomnia requests.	Moderate (1 each): duplicate Authorization sources; empty Base Environment; unscoped Insomnia variables.
bruno/ClickForm/versions/folder.bru	Organizes version requests.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/folder.bru	Organizes version examples.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/036-campos-com-regras-condicionais.bru	Adds a conditional-fields example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/035-repetidor-de-campos.bru	Adds a repeater example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/034-multiplas-respostas.bru	Adds a multiple-choice example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/033-unica-resposta.bru	Adds a single-choice example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/032-lista-suspensa.bru	Adds a select example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/031-paragrafo.bru	Adds a paragraph example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/030-cabecalho.bru	Adds a header example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/029-anexo.bru	Adds an attachment example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/028-imagem.bru	Adds an image example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/027-cep.bru	Adds a postal-code example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/026-monetario.bru	Adds a currency example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/025-cnpj.bru	Adds a CNPJ example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/024-cpf.bru	Adds a CPF example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/023-data.bru	Adds a date example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/022-numero-de-telefone-whatsapp.bru	Adds a phone example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/021-e-mail-do-signatario.bru	Adds an email example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/020-intervalo-numerico.bru	Adds a numeric-range example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/019-numero.bru	Adds a number example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/018-texto-longo.bru	Adds a long-text example.	No final comment.
bruno/ClickForm/versions/exemplos-de-versoes/017-texto-curto.bru	Adds a short-text example.	No final comment.
bruno/ClickForm/versions/016-remove-uma-versao-especifica.bru	Adds version deletion.	No final comment.
bruno/ClickForm/versions/015-atualiza-metadados-da-versao-ex-is-active.bru	Adds version metadata update.	Nit (1): the is_active example payload omits is_active.
bruno/ClickForm/versions/014-retorna-a-estrutura-da-versao.bru	Adds version lookup.	No final comment.
bruno/ClickForm/versions/013-cria-uma-nova-versao-schema-do-formulario.bru	Adds version creation.	No final comment.
bruno/ClickForm/versions/012-lista-todas-as-versoes-de-um-formulario.bru	Adds version listing.	No final comment.
bruno/ClickForm/runs/folder.bru	Organizes run requests.	No final comment.
bruno/ClickForm/runs/011-remove-uma-execucao-pendente.bru	Adds pending-run deletion.	No final comment.
bruno/ClickForm/runs/010-atualiza-contexto-expires-at-ou-callback-url-do-run.bru	Adds run update.	No final comment.
bruno/ClickForm/runs/009-obtem-uma-execucao-run-por-versao.bru	Adds run lookup.	No final comment.
bruno/ClickForm/runs/008-cria-uma-versao-pre-preenchida-do-formulario-para-preenchimento-unico.bru	Adds prefilled run creation.	No final comment.
bruno/ClickForm/runs/007-lista-todas-as-execucoes-associadas-a-uma-versao.bru	Adds run listing.	No final comment.
bruno/ClickForm/health/folder.bru	Organizes health requests.	No final comment.
bruno/ClickForm/health/001-verifica-disponibilidade-do-servico.bru	Adds the health check.	No final comment.
bruno/ClickForm/forms/folder.bru	Organizes form requests.	No final comment.
bruno/ClickForm/forms/006-remove-um-formulario.bru	Adds form deletion.	No final comment.
bruno/ClickForm/forms/005-atualiza-os-metadados-do-formulario.bru	Adds form update.	No final comment.
bruno/ClickForm/forms/004-retorna-metadados-de-um-formulario-especifico.bru	Adds form lookup.	No final comment.
bruno/ClickForm/forms/003-cria-o-formulario-base.bru	Adds form creation.	No final comment.
bruno/ClickForm/forms/002-lista-todos-os-formularios.bru	Adds form listing.	No final comment.
bruno/ClickForm/environments/Sandbox.bru	Defines the Sandbox environment.	No final comment.
bruno/ClickForm/environments/Producao.bru	Defines the production environment.	No final comment.
bruno/ClickForm/collection.bru	Configures collection authentication.	No final comment.
bruno/ClickForm/bruno.json	Defines Bruno collection metadata.	No final comment.
bruno/ClickFlow_Runner/health/folder.bru	Organizes health requests.	No final comment.
bruno/ClickFlow_Runner/health/001-health-check.bru	Adds the health check.	No final comment.
bruno/ClickFlow_Runner/executions/folder.bru	Organizes execution requests.	No final comment.
bruno/ClickFlow_Runner/executions/007-inicia-execucao-com-arquivo-runner-files.bru	Adds file execution.	No final comment.
bruno/ClickFlow_Runner/executions/006-inicia-execucao-canal-api.bru	Adds API-channel execution.	No final comment.
bruno/ClickFlow_Runner/executions/005-inicia-execucao-whatsapp.bru	Adds WhatsApp execution.	No final comment.
bruno/ClickFlow_Runner/executions/004-lista-os-steps-de-uma-execucao.bru	Adds execution steps lookup.	No final comment.
bruno/ClickFlow_Runner/executions/003-cancela-uma-execucao.bru	Adds execution cancellation.	No final comment.
bruno/ClickFlow_Runner/executions/002-retorna-uma-execucao.bru	Adds execution lookup.	No final comment.
bruno/ClickFlow_Runner/environments/Sandbox.bru	Defines the Sandbox environment.	No final comment.
bruno/ClickFlow_Runner/environments/Producao.bru	Defines the production environment.	No final comment.
bruno/ClickFlow_Runner/collection.bru	Configures collection authentication.	No final comment.
bruno/ClickFlow_Runner/bruno.json	Defines Bruno collection metadata.	No final comment.
bruno/ClickFlow_Orchestrator/health/folder.bru	Organizes health requests.	No final comment.
bruno/ClickFlow_Orchestrator/health/001-health-check.bru	Adds the health check.	No final comment.
bruno/ClickFlow_Orchestrator/flows/folder.bru	Organizes flow requests.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/folder.bru	Organizes flow examples.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/034-verify-provider-priority.bru	Adds a provider-priority example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/033-verify-instructions.bru	Adds a verification-instructions example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/032-verify-identity-biometrics.bru	Adds an identity-biometrics example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/031-verify-biometric-behavior-form.bru	Adds a form verification example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/030-verify-biometric-behavior.bru	Adds a behavioral verification example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/029-verify-liveness.bru	Adds a liveness example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/028-signature-modelo-tavola.bru	Adds a template-signature example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/027-signature-template-signatarios-extras.bru	Adds an extra-signers example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/026-signature-runner-files.bru	Adds a runner-files signature example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/025-signature-arquivo-s3-modelo-tavola.bru	Adds an S3/template signature example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/024-signature-filename-com-interpolacao.bru	Adds a filename interpolation example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/023-signature-arquivo-s3.bru	Adds an S3 signature example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/022-signature-template-configuracoes-do-envelope.bru	Adds a signature-settings example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/021-kyc-form-biometric-behavior-kyc-cpf.bru	Adds a CPF KYC example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/020-kyc-biometric-behavior-kyc-cnpj.bru	Adds a CNPJ KYC example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/019-form-injecao-do-contato-no-formulario.bru	Adds contact injection.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/018-form-injecao-de-respostas-de-formularios-anteriores.bru	Adds response injection.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/017-form-atualizacao-de-contato.bru	Adds contact-update flow.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/016-form.bru	Adds a form flow example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/015-consent-variaveis-por-step-channel-params.bru	Adds consent variables.	No final comment.
bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/014-consent.bru	Adds a consent example.	No final comment.
bruno/ClickFlow_Orchestrator/flows/013-despublica-flow-published-unpublished.bru	Adds flow unpublishing.	No final comment.
bruno/ClickFlow_Orchestrator/flows/012-publica-flow-draft-ou-unpublished-published.bru	Adds flow publishing.	No final comment.
bruno/ClickFlow_Orchestrator/flows/011-remove-flow.bru	Adds flow deletion.	No final comment.
bruno/ClickFlow_Orchestrator/flows/010-atualiza-flow.bru	Adds flow update.	No final comment.
bruno/ClickFlow_Orchestrator/flows/009-obtem-flow-por-id.bru	Adds flow lookup.	No final comment.
bruno/ClickFlow_Orchestrator/flows/008-cria-flow.bru	Adds flow creation.	No final comment.
bruno/ClickFlow_Orchestrator/flows/007-lista-flows.bru	Adds flow listing.	No final comment.
bruno/ClickFlow_Orchestrator/executions/folder.bru	Organizes execution requests.	No final comment.
bruno/ClickFlow_Orchestrator/executions/006-inicia-execucao-de-um-flow-publicado.bru	Adds published-flow execution.	No final comment.
bruno/ClickFlow_Orchestrator/executions/005-lista-execucoes-de-um-flow.bru	Adds flow execution listing.	No final comment.
bruno/ClickFlow_Orchestrator/executions/004-avanca-para-o-proximo-passo.bru	Adds next-step execution.	No final comment.
bruno/ClickFlow_Orchestrator/executions/003-cancela-uma-execucao-em-andamento.bru	Adds execution cancellation.	No final comment.
bruno/ClickFlow_Orchestrator/executions/002-estado-da-execucao.bru	Adds execution status lookup.	No final comment.
bruno/ClickFlow_Orchestrator/environments/Sandbox.bru	Defines the Sandbox environment.	No final comment.
bruno/ClickFlow_Orchestrator/environments/Producao.bru	Defines the production environment.	No final comment.
bruno/ClickFlow_Orchestrator/collection.bru	Configures collection authentication.	No final comment.
bruno/ClickFlow_Orchestrator/bruno.json	Defines Bruno collection metadata.	No final comment.

Review details

Suppressed comments (14)

ClickFlow_Orchestrator_Insomnia_Collection.json:147

• Each authenticated request serializes Authorization twice: once as an explicit header and again through the Insomnia authentication object. Insomnia materializes the apikey auth as a header, so imported requests can send duplicate Authorization values and be rejected by the API. Remove the explicit Authorization headers (or remove the authentication objects) consistently so there is only one source of auth.

        {
          "name": "Authorization",
          "value": "{{ access_token }}"
        }

ClickFlow_Orchestrator_Insomnia_Collection.json:19

• This export leaves the initially active Base Environment empty, while every request resolves host from it. Because Sandbox is only a child environment, importing the collection does not actually provide the documented sandbox default and even /health has an unresolved host until the user switches environments. Populate the base environment with the sandbox defaults (or explicitly document that switch).

      "data": {},

ClickFlow_Orchestrator_Insomnia_Collection.json:99

• These requests use {{host}} (and {{ access_token }} elsewhere), but the existing Insomnia exports in this repository reference environment variables with the scoped v4 syntax {{ _.host }}/{{ _.access_token }}. Since this export defines host only inside the imported environment, the imported requests can leave the URL/auth unresolved, so the documented /health smoke test will not work reliably. Use the Insomnia-scoped form consistently throughout this collection.

      "url": "https://{{host}}/health",

ClickFlow_Runner_Insomnia_Collection.json:147

• Each authenticated request serializes Authorization twice: once as an explicit header and again through the Insomnia authentication object. Insomnia materializes the apikey auth as a header, so imported requests can send duplicate Authorization values and be rejected by the API. Remove the explicit Authorization headers (or remove the authentication objects) consistently so there is only one source of auth.

        {
          "name": "Authorization",
          "value": "{{ access_token }}"
        }

ClickFlow_Runner_Insomnia_Collection.json:19

• This export leaves the initially active Base Environment empty, while every request resolves host from it. Because Sandbox is only a child environment, importing the collection does not actually provide the documented sandbox default and even /health has an unresolved host until the user switches environments. Populate the base environment with the sandbox defaults (or explicitly document that switch).

      "data": {},

ClickFlow_Runner_Insomnia_Collection.json:99

• These requests use {{host}} (and {{ access_token }} elsewhere), but the existing Insomnia exports in this repository reference environment variables with the scoped v4 syntax {{ _.host }}/{{ _.access_token }}. Since this export defines host only inside the imported environment, the imported requests can leave the URL/auth unresolved, so the documented /health smoke test will not work reliably. Use the Insomnia-scoped form consistently throughout this collection.

      "url": "https://{{host}}/health",

ClickForm_Insomnia_Collection.json:147

• Each authenticated request serializes Authorization twice: once as an explicit header and again through the Insomnia authentication object. Insomnia materializes the apikey auth as a header, so imported requests can send duplicate Authorization values and be rejected by the API. Remove the explicit Authorization headers (or remove the authentication objects) consistently so there is only one source of auth.

        {
          "name": "Authorization",
          "value": "{{ access_token }}"
        }

ClickForm_Insomnia_Collection.json:19

• This export leaves the initially active Base Environment empty, while every request resolves host from it. Because Sandbox is only a child environment, importing the collection does not actually provide the documented sandbox default and even /health has an unresolved host until the user switches environments. Populate the base environment with the sandbox defaults (or explicitly document that switch).

      "data": {},

ClickForm_Insomnia_Collection.json:99

• These requests use {{host}} (and {{ access_token }} elsewhere), but the existing Insomnia exports in this repository reference environment variables with the scoped v4 syntax {{ _.host }}/{{ _.access_token }}. Since this export defines host only inside the imported environment, the imported requests can leave the URL/auth unresolved, so the documented /health smoke test will not work reliably. Use the Insomnia-scoped form consistently throughout this collection.

      "url": "https://{{host}}/health",

ClickForm_Insomnia_Collection.json:636

• This request is named as the example for updating version metadata (specifically is_active), but its payload contains only settings and fields and never sends is_active. The public collection therefore does not demonstrate the operation it advertises; add the supported metadata field or rename the request to describe a schema update.

      "name": "Atualiza metadados da versão (ex.: is_active)",

ClickForm_Postman_Collection.json:811

• This request is named as the example for updating version metadata (specifically is_active), but its payload contains only settings and fields and never sends is_active. The public collection therefore does not demonstrate the operation it advertises; add the supported metadata field or rename the request to describe a schema update.

					"name": "Atualiza metadados da versão (ex.: is_active)",

README.md:53

• This new Bruno section makes the repository description at the top of the README incomplete: it still says the collections are available only for Postman and Insomnia. Update the introductory description as well so the documented tool support matches this section.

### **Bruno** (ClickFlow / ClickForm)

README.md:51

• The imported Insomnia workspace contains an empty Base Environment plus child Sandbox and Produção environments, but these steps never tell the user to select Sandbox. Following them can leave {{host}} unresolved, so the advertised unauthenticated /health check may fail immediately. Add an explicit environment-selection step after import.

1. Faça o download do arquivo `Insomnia_Collection.json` (API v3) ou das collections ClickFlow/ClickForm listadas acima.
2. Abra o Insomnia.
3. Clique no menu de Workspaces e selecione **Import/Export > Import Data**.
4. Escolha a opção **From File** e selecione o arquivo baixado.

bruno/ClickForm/versions/015-atualiza-metadados-da-versao-ex-is-active.bru:2

• This request is named as the example for updating version metadata (specifically is_active), but its payload contains only settings and fields and never sends is_active. The public collection therefore does not demonstrate the operation it advertises; add the supported metadata field or rename the request to describe a schema update.

• Files reviewed: 110/110 changed files
• Comments generated: 0
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.