Afecta
Equipos que usan las guías de Flowker o la referencia API. Esta actualización se aplica al portal de documentación pública. No cambia el comportamiento del API en tiempo de ejecución, salvo que la documentación del producto enlazada indique lo contrario.
Qué cambió
Documentación de Flowker
Flowker ahora cuenta con cobertura completa de documentación en guías, referencia API y especificación OpenAPI. Esta versión incluye 11 páginas de guías, la referencia API y una especificación OpenAPI 3.1 — todo verificado contra el código fuente de Flowker y disponible en inglés, portugués y español.Páginas nuevas
Resumen
- Qué es Flowker — Resumen del producto, arquitectura y dónde encaja Flowker en la plataforma Lerian
- Por qué Flowker — Diferenciadores clave, principios de diseño y los problemas que Flowker resuelve
- Conceptos de Flowker — Conceptos centrales: workflows, nodes, edges, configuraciones de executor, configuraciones de provider, catálogo y ejecuciones
Guías
- Getting started — Recorrido de extremo a extremo: explorar el catálogo, conectar tus providers, definir workflows y ejecutar
- Guía de integración — Profundización en la configuración de provider, tipos de autenticación, mapeo de campos, triggers de webhook, circuit breaker y comportamiento de reintento
- Guía de diseño de workflows — Ciclo de vida del workflow, tipos de nodes, condiciones de edges, patrones de diseño (secuencial, condicional, fan-out paralelo) y límites técnicos
- Trabajar con los datos de la solicitud y de la respuesta — Mapeo de entrada/salida, transformaciones inline, operaciones Kazaam y orden de ejecución
- Seguridad — Autenticación con Access Manager, autenticación de providers, política CORS, TLS y protección de datos
- Cumplimiento — Validación antes de la escritura en el ledger, el registro paso a paso de cada ejecución y contexto regulatorio
- Guía de observabilidad — Trazas de OpenTelemetry, métricas de Prometheus, endpoints de health check y configuración de dashboard de Grafana
- Variables de entorno — Referencia completa para todas las opciones de configuración de servidor, base de datos, autenticación y observabilidad
Casos de uso
- Casos de uso — Escenarios reales: procesamiento de pagos, detección de fraude, KYC/AML, reconciliación y orquestación de notificaciones
Referencia API
- Inicio rápido del API — Cómo comenzar con la API de Flowker
- Lista de errores — Referencia completa de códigos de error
- Implementando observabilidad — Guía de configuración de observabilidad para la API
Especificación OpenAPI
- Especificación OpenAPI 3.1 de Flowker — La especificación desde la que se renderizan las páginas de referencia API
Impacto
Esta es una actualización de documentación. Las integraciones existentes no necesitan migración solo por esta nota de versión.
Qué necesitas hacer
1
Revisa la documentación de Flowker antes de construir o actualizar integraciones de orquestación de workflows.