Où trouver la documentation et le contrat OpenAPI de l'API ?

Sur l'adresse de l'API : /docs affiche la documentation interactive, /openapi.yaml le contrat OpenAPI 3.1, prêt à générer un client. Les deux sont publics et ne lisent aucune donnée. Le contrat décrit l'API telle qu'elle est déployée, et il est confronté au code à chaque livraison.

• GET /docs : la documentation, avec un exemple par route. La clé saisie pour essayer n'est pas conservée : elle disparaît au rechargement de la page.
• GET /openapi.yaml : le contrat au format OpenAPI 3.1.

Ces deux adresses sont hors de /v1/ : elles ne demandent pas d'authentification et ne lisent aucune donnée de société.

Ce que le contrat garantit

• Il décrit l'API déployée, pas une feuille de route : une route ou un champ qui y figure est réellement servi.
• Il est confronté au code à chaque livraison.
• Des champs peuvent être ajoutés sans nouvelle version : votre client doit ignorer ce qu'il ne connaît pas.

Ce qui n'existe pas encore

Le contrat le dit lui-même : pas d'en-tête Idempotency-Key générique, pas de webhooks vers les intégrateurs, pas de jetons délégués ni d'OAuth2.

Pourquoi la page est publique

Elle ne contient que le contrat, identique pour tous. La garder hors de l'authentification permet de la consulter avant même d'avoir une clé.

Mis à jour le 30 septembre 2026.