Quickstart API

Démarrer

Réaliser votre premier appel API

Créez une clé, vérifiez l’authentification et ajoutez une donnée de démonstration dans un workspace.

Niveau

Débutant

Durée

10 minutes

Rôle

Développeur

Vérifié

juillet 2026

Avant de commencer

• Un compte Ontologie actif et un workspace accessible.
• curl et jq installés.
• Un type Client existant ; vous pouvez le créer avec le quickstart interface.

1. Créer une clé API

1. Ouvrez Paramètres > Clés API.
2. Créez une clé disposant des permissions de lecture du modèle et d’écriture des instances.
3. Copiez la clé, affichée une seule fois.

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

Ne stockez jamais la clé dans le dépôt ou dans un fichier partagé.

2. Tester l’authentification

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

Vérifiez que la réponse contient le workspace attendu, puis confirmez que sa valeur correspond à WORKSPACE_ID.

3. Lire le modèle

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

Repérez l’identifiant du type Client dans la réponse et exportez-le :

export CLIENT_TYPE_ID="uuid-du-type-client"

Les noms exacts des champs sont décrits dans la référence API.

4. Créer une donnée de démonstration

Utilisez l’endpoint de création d’instance exposé par votre type Client. Le corps minimal doit fournir un identifiant unique, le nom ACME API et un statut valide.

curl -s -X POST "https://api.ontologie-growthsystemes.com/api/v1/object-types/$CLIENT_TYPE_ID/instances" \
  -H "Authorization: Bearer $ONTOLOGIE_API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": {
      "identifiant": "CLI-API-001",
      "nom": "ACME API",
      "statut": "Actif"
    },
    "status": "active"
  }' | jq .

Conservez l’identifiant retourné pour supprimer la donnée de démonstration après vérification.

5. Vérifier puis nettoyer

1. Ouvrez les instances de Client dans l’application.
2. Vérifiez que ACME API est visible.
3. Supprimez l’instance depuis l’interface ou avec l’endpoint de suppression indiqué dans la référence.

Résultat attendu

Vous avez authentifié une requête, lu le modèle, créé une instance Client, vérifié sa présence puis nettoyé la donnée de démonstration.

Erreurs courantes

Code	Cause probable	Action
401	Clé absente, invalide ou expirée	Vérifiez le header Authorization et la rotation de la clé
403	Permission ou workspace incorrect	Vérifiez les scopes et x-workspace-id
404	Route ou type inexistant	Vérifiez l’URL et l’identifiant du type
409	Version ou identifiant en conflit	Relisez la ressource puis recommencez avec une valeur unique

Voir Clés API et codes d’erreur.