22 de abril de 2026 Atualização de documentação Revisão recomendadaDocumentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Afeta
Times usando guias ou referência de API do Flowker. Esta atualização se aplica ao portal público de documentação. Não altera o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.
O que mudou
Documentação do Flowker
O Flowker agora tem cobertura completa de documentação em guias, referência de API e especificação OpenAPI. Este release inclui 11 páginas de guias, 53 páginas de referência de API e uma spec OpenAPI 3.1 completa — todas verificadas contra o código-fonte do Flowker e disponíveis em inglês, português e espanhol.Novas páginas
Visão geral
- O que é Flowker — Visão geral do produto, arquitetura, e onde o Flowker se encaixa na plataforma Lerian
- Por que Flowker — Principais diferenciais, princípios de design e os problemas que o Flowker resolve
- Conceitos do Flowker — Conceitos centrais: workflows, nós, edges, configurações de executor, configurações de provider, catálogo, execuções e trilha de auditoria
Guias
- Getting started — Walkthrough completo: explorar o catálogo, configurar executores, definir workflows e executar
- Integration guide — Aprofundamento em configuração de executor e provider, tipos de autenticação, mapeamento de campos, triggers de webhook, circuit breaker e comportamento de retry
- Workflow design guide — Ciclo de vida do workflow, tipos de nó, condições de edge, padrões de design (sequencial, condicional, fan-out paralelo) e limites técnicos
- Field mapping reference — Mapeamento de entrada/saída, transformações inline, operações Kazaam e ordem de execução
- Security — Autenticação por API key, gerenciamento de credenciais de executor, política CORS, TLS e proteção de dados
- Compliance and audit — Trilha de auditoria append-only, verificação de integridade da cadeia de hash, busca e filtragem, e contexto regulatório
- Observability guide — Traces OpenTelemetry, métricas Prometheus, endpoints de health check e setup de dashboard Grafana
- Environment variables — Referência completa para todas as opções de configuração de servidor, banco de dados, autenticação, auditoria e observabilidade
Casos de uso
- Casos de uso — Cenários reais: processamento de pagamentos, detecção de fraude, KYC/AML, reconciliação e orquestração de notificações
Referência de API
- API quick start — Primeiros passos com a API do Flowker
- Error list — Referência completa de códigos de erro
- Implementing observability — Guia de setup de observabilidade para a API
- 53 páginas de referência de endpoint cobrindo toda a superfície da API:
- Workflows — Criar, atualizar, excluir, listar, ativar, desativar, clonar, mover para draft, criar a partir de template
- Executions — Executar workflow, obter status, obter resultados, listar execuções
- Executor configurations — Obter, atualizar, excluir, listar
- Provider configurations — Criar, atualizar, excluir, listar, habilitar, desabilitar, testar conectividade
- Catalog — Listar/obter executores, providers, templates, triggers; validar config de executor e parâmetros de template
- Audit — Pesquisar eventos, obter evento por ID, verificar cadeia de hash, exportar logs, obter status de exportação
- Webhooks — Endpoint de trigger de webhook
- Dashboards — Resumo de workflow, resumo de execução
- Health — Saúde do serviço, liveness, readiness, versão da aplicação
Especificação OpenAPI
- Spec OpenAPI 3.1 do Flowker — Especificação legível por máquina com todos os endpoints, schemas e exemplos
Impacto
Esta é uma atualização de documentação. Integrações existentes não precisam migrar apenas com base nesta release note.