Aller au contenu principal

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

HeaderRequisDescription
X-API-Key ou AuthorizationOuidf_xxx ou Bearer df_xxx
x-workspace-idOui*UUID du workspace (*sauf routes globales)
Content-TypePour POST/PUTapplication/json
Format des cles
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 :

SpecificationDescriptionEndpoints
API ExterneRecherche, graphe, CQRS, cles API, ontologie~80
API AgentAgent IA, sessions, studio, hub~45
API WorkflowExecutions, schedules, canvas, debug~65
API Live DataSources, streams, connecteurs, mappings~70
API ModulesTableurs, calendrier, connaissances, gouvernance~150

Endpoints principaux

Requetes (Lecture)

MethodeEndpointDescription
GET/api/queries/nodesLister toutes les entites
GET/api/queries/nodes/:idObtenir une entite par ID
GET/api/queries/edgesLister toutes les relations
GET/api/queries/edges/:idObtenir une relation par ID

Commandes (Ecriture)

MethodeEndpointDescription
POST/api/commands/executeExecuter une commande

Types de commandes :

  • CREATE_NODE - Creer une entite
  • UPDATE_NODE - Modifier une entite
  • DELETE_NODE - Supprimer une entite
  • CREATE_EDGE - Creer une relation
  • DELETE_EDGE - Supprimer une relation
  • UNDO - Annuler la derniere action
  • REDO - Retablir la derniere action annulee

Agent IA

MethodeEndpointDescription
POST/api/v1/agent/queryRequete en langage naturel
POST/api/v1/agent/invokeInvocation avec streaming SSE
GET/api/v1/agent/toolsOutils disponibles

Live Data

MethodeEndpointDescription
GET/api/unified-sourcesLister les sources de donnees
POST/api/unified-sourcesCreer une source de donnees

Workflow

MethodeEndpointDescription
POST/api/v1/workflow/runsLancer une execution
GET/api/logic/schedulesLister les planifications

Pagination

GET /api/queries/nodes?limit=50&offset=100
ParametreDefautMaxDescription
limit50100Elements par page
offset0-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

PlanRequetes/minRequetes/jour
Starter6010 000
Pro300100 000
EnterprisePersonnalisePersonnalise

Headers dans la reponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1700000000

Codes HTTP

CodeSignification
200Succes
201Cree
204Pas de contenu (DELETE)
400Requete invalide
401Non authentifie
403Acces interdit
404Non trouve
409Conflit de version
429Rate limit depasse
500Erreur 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.