Référence API (OpenAPI)

Objectif

Finoptika expose une API REST versionnée sous /api/v1. Cette page oriente vers la référence OpenAPI interactive et rappelle les principaux points d'entrée. Public : intégrateurs, développeurs, administrateurs avancés.

Phase 2

La génération de pages de référence détaillées depuis le schéma OpenAPI est prévue en phase 2 (voir ADR). En attendant, utilisez l'interface Swagger.

Accéder à la documentation interactive

• Développement : Swagger UI sur http://localhost:8000/docs (activé quand APP_ENV=development).
• Production : la Swagger UI est désactivée par défaut ; le schéma OpenAPI reste la source de vérité côté backend.

Authentification

• Dev : POST /api/v1/dev/token (persona admin/viewer, HS256).
• Prod : Bearer token OIDC (RS256/JWKS) par tenant. Voir IAM/RBAC.
• Toute requête sans token valide → 401 ; sans la permission requise → 403 ; ressource d'un autre tenant → 404.

Principaux points d'entrée par domaine

Domaine	Préfixe API	Écran(s)
Plateforme / IAM	/platform/*	IAM/RBAC
Coûts	/costs/*	Cost analysis, Cost explorer
Ingestion	/ingest-*, /ingest/*	Ingest & mapping
Connexions	/admin/connections	Connecteurs cloud
Allocation	/allocation/*	Showback & chargeback
Optimisation	/recommendations/*, /commitments/*	Opportunités
Prévision	/forecasts/*	Forecast & budgets
Gouvernance	/budgets, /policies, /anomalies, /enforcement/*	Gouvernance
Automatisation	/automation/*	Automatisation
Reporting	/reports/*, /finops/dashboards/*	Rapports exécutifs
Copilot	/copilot/*	FinOps Agent
IaC	/iac/*	Estimation IaC
Enterprise / audit	/enterprise/*	Santé plateforme

Bonnes pratiques d'intégration

• Respectez le rate limiting (middleware Redis) : gérez les 429 avec backoff.
• Toutes les mutations sont auditées — utilisez des comptes de service dédiés.
• 🔒 L'API applique RLS + RBAC : votre token détermine tenant et périmètre.

Voir aussi

• IAM/RBAC · Ingest & mapping
• Application : finoptika.fr