Aller au contenu principal

Partenaires

Partage & API - Documentation

Intégrer les menus MARIAM dans d'autres services via l'API publique.

MARIAM expose une API REST publique pour permettre à des services tiers (affichage campus, applications étudiantes, écrans connectés, etc.) de consommer les données des menus.

API développeur (v1)

La documentation interactive est disponible sur l’instance MARIAM à l’adresse /api/v1/docs (Swagger UI).

RouteDescription
GET /api/v1/menusMenu du jour et de demain
GET /api/v1/restaurantInformations du restaurant

Exemple de réponse

{
  "success": true,
  "data": {
    "today": {
      "date": "2026-02-25",
      "day_name": "Mercredi",
      "items": []
    },
    "tomorrow": {
      "date": "2026-02-26",
      "day_name": "Jeudi",
      "items": []
    }
  }
}

Routes publiques internes

Ces routes sont utilisées par l’interface web MARIAM elle-même, mais peuvent aussi être consommées :

RouteDescription
GET /api/public/menu/todayMenu du jour
GET /api/public/menu/tomorrowMenu de demain
GET /api/public/eventsÉvénements à venir

Rate limiting

L’API est protégée par un rate limiter (Redis). Les limites sont appliquées par route pour éviter les abus.

En savoir plus

Le code source et la documentation technique complète sont disponibles sur GitHub : github.com/Tezay/mariam.