Reference API
En bref
Documentation complete de l'API REST Ontologie. Authentifiez vos requetes, consultez les endpoints disponibles et integrez Ontologie a vos outils.
Prerequis techniques
- Une cle API active (consultez le Guide des cles API).
- L'identifiant UUID de votre workspace.
- Un client HTTP (
curl, Postman, Insomnia ou equivalent).
Explorez vos endpoints dans Ontologie : le module API Manager vous permet de tester et simuler tous les endpoints generes par votre ontologie, directement depuis l'application.
URL de base
https://api.ontologie-growthsystemes.com
Authentification
Tous les endpoints requierent une cle API. Deux methodes sont acceptees :
Methode 1 : Header X-API-Key (recommande)
curl "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
-H "X-API-Key: df_xxxxxxxxxxxxxxxxxxxx" \
-H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000"
Methode 2 : Header Authorization: Bearer
curl "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
-H "Authorization: Bearer df_xxxxxxxxxxxxxxxxxxxx" \
-H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000"
Les deux methodes sont equivalentes. Utilisez X-API-Key pour la clarte, ou Authorization: Bearer si votre client HTTP l'exige.
Headers requis
| Header | Requis | Description |
|---|---|---|
X-API-Key ou Authorization | Oui | df_xxx ou Bearer df_xxx |
x-workspace-id | Oui* | UUID du workspace (*sauf routes globales) |
Content-Type | Pour POST/PUT | application/json |
Les cles API commencent par le prefixe
df_. Si votre cle ne commence pas par df_, regenerez-la depuis la page Cles API.Voir le Guide des cles API pour la gestion des cles.
Specifications par domaine
La documentation est organisee en 5 specifications OpenAPI :
| Specification | Description | Endpoints |
|---|---|---|
| API Externe | Recherche, graphe, CQRS, cles API, ontologie | ~80 |
| API Agent | Agent IA, sessions, studio, hub | ~45 |
| API Workflow | Executions, schedules, canvas, debug | ~65 |
| API Live Data | Sources, streams, connecteurs, mappings | ~70 |
| API Modules | Tableurs, calendrier, connaissances, gouvernance | ~150 |
Endpoints principaux
Requetes (Lecture)
| Methode | Endpoint | Description |
|---|---|---|
GET | /api/queries/nodes | Lister toutes les entites |
GET | /api/queries/nodes/:id | Obtenir une entite par ID |
GET | /api/queries/edges | Lister toutes les relations |
GET | /api/queries/edges/:id | Obtenir une relation par ID |
Commandes (Ecriture)
| Methode | Endpoint | Description |
|---|---|---|
POST | /api/commands/execute | Executer une commande |
Types de commandes :
CREATE_NODE- Creer une entiteUPDATE_NODE- Modifier une entiteDELETE_NODE- Supprimer une entiteCREATE_EDGE- Creer une relationDELETE_EDGE- Supprimer une relationUNDO- Annuler la derniere actionREDO- Retablir la derniere action annulee
Agent IA
| Methode | Endpoint | Description |
|---|---|---|
POST | /api/v1/agent/query | Requete en langage naturel |
POST | /api/v1/agent/invoke | Invocation avec streaming SSE |
GET | /api/v1/agent/tools | Outils disponibles |
Live Data
| Methode | Endpoint | Description |
|---|---|---|
GET | /api/unified-sources | Lister les sources de donnees |
POST | /api/unified-sources | Creer une source de donnees |
Workflow
| Methode | Endpoint | Description |
|---|---|---|
POST | /api/v1/workflow/runs | Lancer une execution |
GET | /api/logic/schedules | Lister les planifications |
Pagination
GET /api/queries/nodes?limit=50&offset=100
| Parametre | Defaut | Max | Description |
|---|---|---|---|
limit | 50 | 100 | Elements par page |
offset | 0 | - | Elements a sauter |
Filtrage
GET /api/queries/nodes?entityType=concept&name=Client
Tri
GET /api/queries/nodes?sort=-createdAt,name
- Prefixe
-pour ordre descendant - Champs multiples separes par virgule
Rate Limits
| Plan | Requetes/min | Requetes/jour |
|---|---|---|
| Starter | 60 | 10 000 |
| Pro | 300 | 100 000 |
| Enterprise | Personnalise | Personnalise |
Headers dans la reponse :
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1700000000
Codes HTTP
| Code | Signification |
|---|---|
200 | Succes |
201 | Cree |
204 | Pas de contenu (DELETE) |
400 | Requete invalide |
401 | Non authentifie |
403 | Acces interdit |
404 | Non trouve |
409 | Conflit de version |
429 | Rate limit depasse |
500 | Erreur serveur |
Exemples cURL
export API_KEY="df_xxxxxxxxxxxxxxxxxxxx"
export WORKSPACE_ID="550e8400-..."
export API_URL="https://api.ontologie-growthsystemes.com"
curl "$API_URL/api/queries/nodes" \
-H "Authorization: Bearer $API_KEY" \
-H "x-workspace-id: $WORKSPACE_ID"
Resultat attendu
Vous pouvez authentifier vos requetes, lire et ecrire des donnees via l'API REST Ontologie, et integrer la plateforme a vos outils existants.
Besoin d'aide ?
Ecrivez-nous : Support et contact.