Ontologie expose un ensemble contrôlé d’opérations REST pour les intégrations externes. Le catalogue des API publiées constitue la liste canonique des opérations supportées. Une route absente de ce catalogue ne doit pas être considérée comme publique, même si elle existe dans un contrat interne.
Avant de commencer
- Créez une clé depuis le guide des clés API.
- Récupérez l’identifiant UUID du workspace cible.
- Utilisez l’URL de l’environnement concerné. En production :
https://api.ontologie-growthsystemes.com.
Pour une intégration externe, envoyez la clé dans X-API-Key et, lorsque le catalogue l’indique, le workspace dans x-workspace-id :
curl "https://api.ontologie-growthsystemes.com/api/v1/object-types/UUID_DU_TYPE/instances" \
-H "X-API-Key: df_xxxxxxxxxxxxxxxxxxxx" \
-H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000"
Le header Authorization: Bearer df_xxx est également accepté. N’insérez jamais une clé API dans du code frontend ou dans un dépôt Git.
API de recherche
Découvrez les 30 opérations de recherche : composition, définitions métier, documents, instances et graphe. Chaque API est présentée avec son rôle, ses entrées, son résultat et un exemple d’usage.
Tester depuis API Manager
Le module API Manager est accessible dans l’application à l’adresse /ontology/apis. Recherchez une route publiée, ouvrez son panneau de test puis exécutez-la. Le panneau navigateur utilise votre session utilisateur active et le workspace sélectionné ; il ne simule pas une clé API externe et ne remplace jamais une erreur HTTP par des données de démonstration.
Contrat de support
- Le catalogue publié est généré depuis le manifeste backend et contrôlé par la CI.
- Les pages OpenAPI de cette section fournissent les schémas, paramètres et exemples.
- Consultez les scopes et permissions propres à chaque opération avant une intégration.
- Les erreurs HTTP affichées par le panneau sont les réponses réelles du backend.
Pour diagnostiquer un échec, conservez la méthode, le chemin, le code HTTP et l’identifiant de requête retourné par l’API.
Chemins, pagination et preuve d'intégration
Les pages de ce site commencent par /docs/ ; les endpoints du serveur commencent par /api/. Ne remplacez pas l'un par l'autre dans un exemple HTTP. Vérifiez ensemble la méthode, le chemin et les paramètres dans le catalogue publié.
Pour une liste, contrôlez la pagination et le périmètre autorisé avant de calculer un total. Une réponse vide et une erreur d'accès ne signifient pas la même chose. Comparez un enregistrement connu avec l'interface et gardez l'identifiant de requête pour le diagnostic.
Le quickstart API propose cette vérification en lecture. L'accès par session utilisateur dans API Manager et l'accès par clé externe peuvent avoir des permissions différentes.
