Reference API

En bref

Ontologie expose une API REST complete pour integrer la plateforme a vos outils. Authentifiez vos requetes, consultez les endpoints disponibles et automatisez vos processus.

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 l'application : le module API Manager vous permet de tester et simuler tous les endpoints generes par votre ontologie, directement depuis l'application.

Portail Client : Reference API complete

Pour acceder a la documentation interactive complete de tous les endpoints (schemas, exemples, sandbox), ainsi qu'au SDK et a la documentation MCP, connectez-vous au Portail Client.

L'acces au portail est reserve aux clients disposant d'un compte actif. Devenir client →

URL de base {#base-url}

https://api.ontologie-growthsystemes.com

Authentification {#authentication}

Tous les endpoints requierent une cle API. Deux methodes sont acceptees :

Methode 1 : Header X-API-Key (recommande) {#x-api-key}

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 {#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 {#required-headers}

Voir le Guide des cles API pour la gestion des cles.

Endpoints principaux {#main-endpoints}

Requetes (Lecture) {#queries}

Commandes (Ecriture) {#commands}

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 {#agent}

Live Data {#live-data}

Workflow {#workflow}

Pagination {#pagination}

GET /reference/api/queries/nodes?limit=50&offset=100

Filtrage {#filtering}

GET /reference/api/queries/nodes?entityType=concept&name=Client

Tri {#sorting}

GET /reference/api/queries/nodes?sort=-createdAt,name

• Prefixe - pour ordre descendant
• Champs multiples separes par virgule

Rate Limits {#rate-limits}

Headers dans la reponse :

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

Codes HTTP {#status-codes}

Exemples par langage {#examples}

cURL

export API_KEY="df_xxxxxxxxxxxxxxxxxxxx"
export WORKSPACE_ID="550e8400-..."
export API_URL="https://api.ontologie-growthsystemes.com"

curl "$API_URL/reference/api/queries/nodes" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID"

JavaScript / TypeScript

const API_URL = "https://api.ontologie-growthsystemes.com";
const API_KEY = process.env.ONTOLOGIE_API_KEY;
const WORKSPACE_ID = process.env.ONTOLOGIE_WORKSPACE_ID;

// Lire les entites
const response = await fetch(`${API_URL}/reference/api/queries/nodes`, {
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "x-workspace-id": WORKSPACE_ID,
  },
});
const { data, meta } = await response.json();

// Creer une entite
const create = await fetch(`${API_URL}/reference/api/commands/execute`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "x-workspace-id": WORKSPACE_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "CREATE_NODE",
    payload: { name: "Client", entityType: "concept", position: { x: 100, y: 100 } },
  }),
});

Python

import os
import requests

API_URL = "https://api.ontologie-growthsystemes.com"
API_KEY = os.environ["ONTOLOGIE_API_KEY"]
WORKSPACE_ID = os.environ["ONTOLOGIE_WORKSPACE_ID"]

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "x-workspace-id": WORKSPACE_ID,
}

# Lire les entites
response = requests.get(f"{API_URL}/reference/api/queries/nodes", headers=headers)
data = response.json()["data"]

# Creer une entite
create = requests.post(
    f"{API_URL}/reference/api/commands/execute",
    headers={**headers, "Content-Type": "application/json"},
    json={
        "type": "CREATE_NODE",
        "payload": {"name": "Client", "entityType": "concept", "position": {"x": 100, "y": 100}},
    },
)

Configuration rapide {#quick-setup}

Creez un fichier .env pour stocker vos identifiants :

# .env
ONTOLOGIE_API_KEY=df_xxxxxxxxxxxxxxxxxxxx
ONTOLOGIE_WORKSPACE_ID=550e8400-e29b-41d4-a716-446655440000
ONTOLOGIE_API_URL=https://api.ontologie-growthsystemes.com

Specification OpenAPI {#openapi}

La specification OpenAPI complete est disponible sur le Portail Client. Elle peut etre importee dans Postman, Insomnia ou tout client compatible OpenAPI 3.0.

Reference complete des endpoints

Besoin d'aide ?

Ecrivez-nous : Support et contact.