Clés API plateforme

Accès du site corporate DevOra au catalogue public des plans (scope platform:catalog:read). Le secret n'est affiché qu'une seule fois, à la création.

0/5 clés actives

Documentation de l'API

Documentation à transmettre au développeur du site corporate — la clé s'envoie séparément, par un canal sécurisé.

Authentification

En-tête X-Api-Key obligatoire sur chaque requête. Base : https://api.global.scolarium.devoraht.com/api/v1/platform

Endpoints (lecture seule)

  • GET /plansEndpoint unique : plans publics actifs, chacun embarquant le catalogue complet des features (isIncluded par item)
  • GET /plans/recommendedLe plan mis en avant — 404 RECOMMENDED_PLAN_NOT_FOUND si aucun

Chaque plan embarque un tableau features (arbre récursif, libellés { fr, en }) où chaque item porte isIncluded : la grille de comparaison se construit avec ce seul appel.

Exemple

curl -s https://api.global.scolarium.devoraht.com/api/v1/platform/plans \
  -H "X-Api-Key: <VOTRE_CLE_API>"

Règles importantes

  • Appels côté serveur uniquement : la clé ne doit jamais apparaître dans du code exécuté par le navigateur.
  • Cache obligatoire (SSG/ISR) : TTL recommandé ≥ 5 minutes — inutile d'appeler l'API à chaque visite.
  • Rate limit : 300 requêtes/minute par clé ; au-delà, 429 sans corps ni Retry-After — prévoir un backoff.
  • Grille de comparaison en un seul appel GET /plans : chaque plan porte le même arbre features ; la case (ligne, colonne) = isIncluded de l'item dans ce plan.
  • isIncluded est explicite (pas de grandfathering) : un parent inclus n'implique pas ses enfants, et un plan entièrement à false est un état légitime, pas une erreur.
  • name/description des features sont des objets { fr, en } — prévoir un fallback si une langue manque.
  • Rotation : créer une nouvelle clé, basculer le site, puis révoquer l'ancienne (effet immédiat).