Découvrez l'API REST publique en un appel : doc de découverte/health et préflight CORS
API REST publique doc de découverte/health & préflight CORS une fonctionnalité du module Jetons API, webhooks & API REST de Clustraly. Le document de découverte/health de l'API REST publique expose versions, scopes et carte des ressources, et répond au préflight CORS des intégrations navigateur.
Offrez à vos intégrateurs un point d'entrée unique : versions, scopes et carte des ressources en un seul appel, plus un préflight CORS prêt pour le navigateur.
Un seul appel révèle toute l'API
Pointez vos intégrateurs vers GET /api/v1 : ils obtiennent aussitôt le nom de l'application et une carte des ressources disponibles. Plus besoin de deviner les routes ni d'attendre une documentation externe.
Ce document sert de point d'entrée d'auto-documentation. L'API se présente elle-même, dans une réponse JSON exploitable immédiatement.
- Nom de l'application et carte des ressources
- Réponse JSON prête à l'emploi
- Point d'entrée d'auto-documentation
Sachez à quelle version vous parlez
Le document expose les versions api et cms telles que définies côté serveur. Vos intégrations vérifient d'un coup d'œil la compatibilité avant d'appeler la moindre route, et repèrent une évolution sans surprise.
- Version de l'API exposée
- Version du CMS exposée
- Contrôle de compatibilité avant intégration
Voyez ce que votre jeton peut faire
Le document renvoie le nom et les scopes du jeton appelant, ainsi que la liste des scopes disponibles. Vous savez immédiatement à quoi votre clé donne droit, sans tâtonner entre les 401 et les 403.
- Nom et scopes du jeton appelant
- Liste des scopes disponibles
- Diagnostic rapide des droits d'accès
Ouvrez l'API à vos applications navigateur
Les requêtes OPTIONS /api/v1 et /api/v1/{any} reçoivent un repli de préflight CORS. Vos front-ends et applications JavaScript négocient l'accès sans blocage, avant même leur premier appel authentifié.
- OPTIONS géré sur /api/v1 et /api/v1/{any}
- Repli de préflight prêt pour le navigateur
- Intégrations front-end sans friction
Une découverte, mais sous contrôle
Le document de découverte exige le scope content:read : seuls les jetons habilités le consultent. Il s'inscrit dans la même chaîne d'authentification Bearer, de gating de scope et de rate-limit que le reste de l'API.
Vous exposez juste ce qu'il faut pour intégrer, sans jamais relâcher le contrôle des accès.
- Scope content:read requis
- Authentification Bearer partagée
- Aligné sur le gating de scope de l'API
L'API se présente elle-même
Vos intégrateurs interrogent un point d'entrée unique et repartent avec les versions, les scopes et la carte des ressources. Vous gardez la main sur les accès ; l'API fait le reste.
Questions fréquentes
Que contient le document de découverte/health ?
Faut-il un jeton pour accéder à la découverte ?
Comment le préflight CORS est-il pris en charge ?
À quoi sert cette découverte pour un intégrateur ?
Fonctionnalités liées
Jetons API liste et statuts
Consulter la liste • Voir le préfixe masqué • Voir propriétaire/scopes/dernière
DécouvrirCréation de jeton avec révélation unique du secret
Créer un jeton • Choisir les scopes • Fixer l'expiration • Copier le secret • Jo
DécouvrirRévocation de jeton
Révoquer • Confirmer • Journaliser (audit)
DécouvrirPrêt à laisser l'API se documenter elle-même ?
Exposez un point d'entrée clair à vos intégrateurs et ouvrez vos applications navigateur, sans jamais relâcher le contrôle des accès. La découverte propose, votre scope décide.