Skip to main content
L’API publique Le Commis expose les informations d’un établissement (identité, horaires, menus web) sous forme de JSON, en lecture seule (GET uniquement). Elle est conçue pour être consommée depuis un backend : site vitrine, build statique (Astro, Eleventy, Next…), plugin WordPress, ou tout intégrateur qui veut afficher les menus à jour sans recopier les données à la main.

Base URL

https://app.lecommis.fr/api/v1
Le serveur OpenAPI est https://app.lecommis.fr ; le préfixe /api/v1 fait partie de chaque chemin.
Toutes les routes partagent la même base URL https://app.lecommis.fr/api/v1. Chaque chemin documenté ici s’y ajoute (ex. /establishments/au-bistrot).
L’API est désactivée par défaut. Elle doit d’abord être activée par l’administrateur de l’établissement, depuis la page Réglages → API, qui génère également la clé d’accès.

Principes

Tenant par slug

Chaque établissement est identifié par son slug (ex. au-bistrot), jamais par un identifiant numérique.

Réponse à plat

Pas d’enveloppe data/meta : la ressource sérialisée est la racine du JSON.

Lecture seule

Uniquement des requêtes GET. Aucune écriture via l’API.

Pas de pagination

Ni pagination, ni includes, ni sparse-fields, ni filtres. Le seul query param est ?locale.

Authentification

Chaque requête doit porter le header X-Api-Key avec la clé de l’établissement. C’est une clé serveur-à-serveur : ne l’exposez jamais dans du JavaScript navigateur.
Exemple d'appel
curl https://app.lecommis.fr/api/v1/establishments/au-bistrot \
  -H "X-Api-Key: VOTRE_CLE_API"
Détails complets (activation, rotation, codes 401/404) sur la page Authentification.

Les 4 endpoints

MéthodeCheminDescription
GET/establishments/{slug}Identité de l’établissement
GET/establishments/{slug}/hoursHoraires (réguliers + exceptionnels à venir)
GET/establishments/{slug}/menusListe des menus web
GET/establishments/{slug}/menus/{menu_type_slug}Détail d’un menu (sections + items)
Le seul paramètre de requête disponible est ?locale=fr|en, et uniquement sur les endpoints menus (liste et détail). Voir Sélection de la langue.

Pour aller plus loin

Établissement

Identité, contact, localisation, logo.

Horaires

Horaires réguliers et exceptionnels.

Menus

Liste des menus, sections et items.

content_revision

Détecter les changements et invalider votre cache.
Consultez aussi les quotas de requêtes, le format des erreurs, et l’onglet API Reference pour le playground interactif : /api-reference.