Afecta a
Equipos que usan las guías o la referencia de API de Flowker. Esta actualización aplica al portal de documentación pública. No cambia el comportamiento de la API en tiempo de ejecución, salvo que la documentación de producto enlazada indique lo contrario.
Qué cambió
Documentación de Flowker
Flowker ya tiene cobertura completa de documentación en guías, referencia de API y especificación OpenAPI. Esta versión incluye 11 páginas de guías, la referencia de 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 principales, principios de diseño y los problemas que resuelve Flowker
- Conceptos de Flowker — Conceptos centrales: workflows, nodos, aristas, configuraciones de executor, configuraciones de proveedor, catálogo y ejecuciones
Guías
- Primeros pasos — Recorrido de extremo a extremo: explora el catálogo, conecta tus proveedores, define workflows y ejecuta
- Guía de integración — Análisis a fondo de la configuración de proveedor, los tipos de autenticación, el mapeo de campos, los disparadores por webhook, el circuit breaker y el comportamiento de reintento
- Guía de diseño de workflows — Ciclo de vida del workflow, tipos de nodo, condiciones de aristas, patrones de diseño (secuencial, condicional, fan-out paralelo) y límites técnicos
- Trabajo con datos de solicitud y respuesta — Mapeo de entrada y salida, transformaciones en línea, operaciones de Kazaam y orden de ejecución
- Seguridad — Autenticación con Access Manager, autenticación de proveedores, 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 el contexto regulatorio
- Guía de observabilidad — Trazas de OpenTelemetry, métricas de Prometheus, endpoints de health check y configuración del dashboard de Grafana
- Variables de entorno — Referencia completa de 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, conciliación y orquestación de notificaciones
Referencia de API
- Inicio rápido de la API — Primeros pasos con la API de Flowker
- Lista de errores — Referencia completa de códigos de error
- Implementación de observabilidad — Guía de configuración de observabilidad para la API
Especificación OpenAPI
- Especificación OpenAPI 3.1 de Flowker — La especificación a partir de la cual se generan las páginas de referencia de API
Impacto
Esta es una actualización de documentación. Las integraciones existentes no necesitan una migración solo por esta nota de versión.
Qué debes hacer
1
Revisa la documentación de Flowker antes de construir o actualizar integraciones de orquestación de workflows.