Swagger / OpenAPI

Le microservice expose une documentation OpenAPI interactive pour aider les partenaires a integrer l'API.

Swagger UI par version

GET /docs/swagger/v0
GET /docs/swagger/v1

Ces interfaces permettent de parcourir les endpoints, consulter les parametres attendus et tester les appels avec un token Bearer.

Specifications OpenAPI JSON

GET /docs/openapi-v0.json
GET /docs/openapi-v1.json

Ces fichiers peuvent etre importes dans des outils comme Postman, Bruno, Insomnia ou des generateurs de clients OpenAPI.

Versions documentees

Chaque version dispose de son propre document Swagger/OpenAPI.

• v0: endpoints legacy conserves pour compatibilite.
• v1: endpoints recommandes pour les nouvelles integrations partenaires.

Les endpoints v0 sont marques comme deprecated. Ils restent disponibles pour les clients non migres, mais ne doivent pas etre utilises pour une nouvelle integration.

Authentification

Swagger declare une authentification Bearer commune.

Pour v0, utilisez le token legacy fourni par Comminter.

Pour v1, utilisez un token CMS associe a un utilisateur ayant le role Partner.

Authorization: Bearer <token>

v1 ne supporte pas le fallback ?token=.

Tags principaux

Dans /docs/openapi-v0.json:

• v0 - Facilities
• v0 - Areas
• v0 - Service Subscriptions
• v0 - Remote Control

Dans /docs/openapi-v1.json:

• v1 - Facilities
• v1 - Areas
• v1 - Service Subscriptions
• v1 - Remote Control