Afeta
Equipes que usam os guias ou a referência da API do Flowker. Esta atualização se aplica ao portal público de documentação. Ela não muda 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 entre guias, referência da API e especificação OpenAPI. Este release inclui 11 páginas de guia, a referência da API e uma especificação OpenAPI 3.1 — tudo verificado contra o código-fonte do Flowker e disponível em inglês, português e espanhol.Novas páginas
Visão geral
- O que é o 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, arestas, configurações de executor, configurações de provedor, catálogo e execuções
Guias
- Primeiros passos — Passo a passo de ponta a ponta: explore o catálogo, conecte seus provedores, defina workflows e execute
- Guia de integração — Detalhamento da configuração de provedor, tipos de autenticação, mapeamento de campos, gatilhos por webhook, circuit breaker e comportamento de nova tentativa
- Guia de desenho de workflows — Ciclo de vida do workflow, tipos de nó, condições de aresta, padrões de desenho (sequencial, condicional, fan-out paralelo) e limites técnicos
- Trabalhando com dados de requisição e resposta — Mapeamento de entrada e saída, transformações inline, operações Kazaam e ordem de execução
- Segurança — Autenticação pelo Access Manager, autenticação de provedor, política de CORS, TLS e proteção de dados
- Conformidade — Validação antes da escrita no ledger, o registro de cada execução no nível de passo e contexto regulatório
- Guia de observabilidade — Traces do OpenTelemetry, métricas do Prometheus, endpoints de health check e configuração do dashboard no Grafana
- Variáveis de ambiente — Referência completa de 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, conciliação e orquestração de notificações
Referência da API
- Início rápido da API — Primeiros passos com a API do Flowker
- Lista de erros — Referência completa de códigos de erro
- Implementando observabilidade — Guia de configuração de observabilidade para a API
Especificação OpenAPI
- Especificação OpenAPI 3.1 do Flowker — A especificação a partir da qual as páginas de referência da API são renderizadas
Impacto
Esta é uma atualização de documentação. As integrações existentes não precisam de migração apenas por esta nota de release.
O que você precisa fazer
1
Revise a documentação do Flowker antes de construir ou atualizar integrações de orquestração de workflows.