Especificación OpenAPI
La API pública de Frihet expone una especificación OpenAPI 3.1 completa en GET /openapi.yaml. La especificación describe todas las operaciones disponibles, sus parámetros, respuestas y modelos de datos, en un formato consumible por generadores de cliente, agentes de tool-calling y exploradores interactivos.
Cómo funciona
La especificación se sirve en formato YAML como text/yaml con caché de 1 hora desde el endpoint público de la API. Cubre los recursos principales del producto: facturas, gastos, depósitos, clientes, productos, presupuestos, cobros, recurrentes y exportaciones. Para cada recurso, documenta los endpoints GET/POST/PATCH/DELETE con esquemas de petición y respuesta tipados.
El consumo habitual es de tres tipos. Para generar clientes en cualquier lenguaje (Python, Go, Java, Ruby, etc.) usando OpenAPI Generator o herramientas equivalentes — útil cuando no estás en TypeScript o necesitas un cliente en lenguaje no cubierto por el SDK oficial. Para importar en Postman, Insomnia o Bruno y tener una colección lista para probar la API de forma interactiva. Para alimentar agentes de tool-calling que descubren operaciones disponibles a partir de la especificación y construyen llamadas automáticamente.
Adicionalmente, una copia estática se publica en docs.frihet.io/openapi.json para que crawlers y agentes la encuentren desde el sitio de documentación sin necesidad de autenticarse contra la API.
La especificación se mantiene sincronizada con la implementación real. Si encuentras un endpoint en producción que no aparece o un campo con un tipo distinto al declarado, abre soporte para que el equipo lo corrija.
Configuración
No requiere configuración. La especificación es pública y no necesita API key para consultarse. Para autenticarte contra los endpoints reales sí necesitas una API key — gestiónala desde Configuración → Desarrolladores → API Keys.