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, a referência de API e uma spec OpenAPI 3.1 — 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, nodes, edges, configurações de executor, configurações de provider, catálogo e execuções
Guias
- Getting started — Walkthrough completo: explorar o catálogo, conectar seus providers, definir workflows e executar
- Integration guide — Aprofundamento em configuração de 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 node, condições de edge, padrões de design (sequencial, condicional, fan-out paralelo) e limites técnicos
- Trabalhando com os dados da requisição e da resposta — Mapeamento de entrada/saída, transformações inline, operações Kazaam e ordem de execução
- Security — Autenticação com o Access Manager, autenticação de providers, política CORS, TLS e proteção de dados
- Conformidade — Validação antes da escrita no ledger, o registro passo a passo de cada execução 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 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
Especificação OpenAPI
- Spec OpenAPI 3.1 do Flowker — A especificação a partir da qual as páginas de referência de API são renderizadas
Impacto
Esta é uma atualização de documentação. Integrações existentes não precisam migrar apenas com base nesta release note.
O que você precisa fazer
1
Revise a documentação do Flowker antes de construir ou atualizar integrações de orquestração de workflow.