Aller au contenu

Conventions de l'API

L'API publique Trovici suit des conventions stables et prévisibles. Elles s'appliquent à tous les endpoints publiés (approche spec-first).

Format

  • REST sur HTTPS, corps JSON, encodage UTF-8.
  • Dates au format ISO 8601 en UTC (ex. 2026-07-07T21:00:00Z).
  • Noms de champs en camelCase (cohérent avec l'écosystème Flarum/JSON:API sous-jacent).

Authentification

Les endpoints protégés attendent un jeton transmis dans l'en-tête Authorization. Le schéma exact et l'obtention du jeton sont décrits dans la référence API au fur et à mesure de l'ouverture des endpoints (spec-first).

Pagination

Les collections sont paginées. Suivre les paramètres et les liens de page fournis par la réponse plutôt que de supposer des tailles fixes.

Erreurs

Les erreurs renvoient un code HTTP approprié (4xx client, 5xx serveur) et un corps JSON décrivant le problème. Ne pas coder en dur des messages d'erreur : se fier au code HTTP et au champ de statut.

Stabilité

  • Le contrat OpenAPI (openapi-public.yaml) est la source de vérité.
  • Les changements incompatibles passeront par une stratégie de version documentée.

Voir : Démarrer · Référence API.