Aller au contenu principal

Demarrage rapide

Completez votre premier appel API en 10 minutes.

En bref

Ce guide vous accompagne de la creation de votre cle API jusqu'a la creation de votre premiere entite via l'API.

Prerequis

  • Compte Ontologie actif
  • Acces a un workspace
  • Terminal avec curl installe

Etape 1 : Obtenir votre cle API et votre Workspace ID

Cle API

  1. Naviguez vers Parametres > Cles API
  2. Cliquez sur Creer une cle API
  3. Copiez la cle (affichee une seule fois)

Workspace ID

Le Workspace ID identifie votre espace de travail. Il est transmis dans le header x-workspace-id de chaque requete API.

Depuis l'interface :

  1. Cliquez sur le selecteur de workspace en haut a gauche de l'ecran
  2. Le Workspace ID s'affiche en bas du menu deroulant
  3. Cliquez sur le bouton Copier a cote de l'ID

Vous pouvez egalement le retrouver dans Parametres sur la carte Workspace.

Via l'API (si vous avez deja une cle API) :

curl -s "https://api.ontologie-growthsystemes.com/api/workspaces" \
-H "Authorization: Bearer $ONTOLOGIE_API_KEY" | jq '.[0].id'

Configuration

export ONTOLOGIE_API_KEY="df_xxxxxxxxxxxxxxxxxxxx"
export WORKSPACE_ID="votre-workspace-id-ici"

Qu'est-ce que le Workspace ID ?
Le Workspace ID est un identifiant unique (UUID) de votre espace de travail. Il n'est pas secret — il est transmis en clair dans les headers HTTP. Il sert a isoler vos donnees de celles des autres espaces.

Stockage securise
Les cles API ne sont affichees qu'une seule fois. Stockez-les dans un endroit securise (gestionnaire de mots de passe, coffre-fort de secrets).

Etape 2 : Lister les entites

Recuperez toutes les entites de votre workspace :

curl -s -X GET "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
-H "Authorization: Bearer $ONTOLOGIE_API_KEY" \
-H "x-workspace-id: $WORKSPACE_ID"

Reponse attendue :

{
"success": true,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Client",
"entityType": "concept",
"position": { "x": 100, "y": 100 }
}
],
"meta": {
"total": 1,
"limit": 50,
"offset": 0
}
}

Etape 3 : Creer une entite

Creez une nouvelle entite via l'API :

curl -s -X POST "https://api.ontologie-growthsystemes.com/api/commands/execute" \
-H "Authorization: Bearer $ONTOLOGIE_API_KEY" \
-H "x-workspace-id: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"type": "CREATE_NODE",
"payload": {
"name": "Ma premiere entite",
"entityType": "concept",
"position": { "x": 200, "y": 200 }
}
}'

Reponse attendue :

{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440099",
"name": "Ma premiere entite",
"entityType": "concept"
},
"metadata": {
"canUndo": true
}
}

Etape 4 : Verifier dans l'interface

  1. Ouvrez l'application Ontologie
  2. Naviguez vers votre workspace
  3. Ouvrez le canvas Modeler
  4. Votre nouvelle entite devrait apparaitre a la position (200, 200)

Resultat attendu : Vous avez cree une entite via l'API et pouvez la visualiser dans le canvas Modeler. Vous maitrisez les bases de l'authentification et des commandes Ontologie.

Prochaines etapes

Problemes courants

ErreurCauseSolution
401 UnauthorizedCle API invalide ou manquanteVerifiez le format du header Authorization
403 ForbiddenMauvais workspace ou scope insuffisantVerifiez le header x-workspace-id
404 Not FoundEndpoint inexistantVerifiez l'URL

Voir Erreurs courantes pour un depannage detaille.

Besoin d'aide

Contactez le support pour toute question.