Reference API

La reference OpenAPI publique est generee depuis le schema Swagger du backend, synchronise dans openapi/cyclecore-public-api.json. Elle ne contient que les endpoints publics stables.

Endpoints disponibles

Source technique

La source de verite est le backend NestJS. Il expose un schema Swagger/OpenAPI sur /api/docs-json lorsque la documentation technique est active.

Le flux de publication est:

1. Stabiliser les endpoints publics dans le backend.
2. Synchroniser le schema public depuis /api/docs-json avec npm run openapi:sync.
3. Garder uniquement les routes publiques et le serveur de production.
4. Regenerer les pages Fumadocs avec npm run openapi:generate.

A stabiliser avant publication

• GET /public/v1/products/{id}.
• POST /public/v1/products.
• GET /public/v1/channels.
• Endpoints d'exports publics dedies.
• Webhooks publics.

Integration Fumadocs OpenAPI

Le repo docs consomme openapi/cyclecore-public-api.json via fumadocs-openapi. Ce fichier est produit par npm run openapi:sync, puis les pages dans content/docs/api/reference/endpoints sont regenerees avec npm run openapi:generate.

Routes a exclure

Ne jamais publier dans cette reference:

• Gestion interne des organisations, membres, roles et permissions.
• Creation, listing et revocation des cles API cote application.
• Stripe, facturation et webhooks internes.
• Onboarding, admin, dashboard et notifications.
• Supabase exchange.
• Connecteurs internes, OAuth, synchronisation, mapping et jobs techniques.
• Routes d'import/export internes non stabilisees comme contrat public.