Démarrage rapide

Complétez votre premier appel API en 10 minutes.

Prérequis

• Compte DataForge actif
• Accès à un workspace
• Terminal avec curl installé

Étape 1 : Obtenir votre clé API

1. Naviguez vers Paramètres > Clés API
2. Cliquez sur Créer une clé API
3. Copiez la clé (affichée une seule fois)

export DATAFORGE_API_KEY="df_live_xxxxxxxxxxxxxxxxxxxx"
export WORKSPACE_ID="550e8400-e29b-41d4-a716-446655440000"

Stockage sécurisé

Les clés API ne sont affichées qu'une seule fois. Stockez-les dans un endroit sécurisé (gestionnaire de mots de passe, coffre-fort de secrets).

Étape 2 : Lister les entités

Récupérez toutes les entités de votre workspace :

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

Réponse 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
  }
}

Étape 3 : Créer une entité

Créez une nouvelle entité via l'API :

curl -s -X POST "https://api.dev-growthsystemes.com/api/commands/execute" \
  -H "Authorization: Bearer $DATAFORGE_API_KEY" \
  -H "x-workspace-id: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "CREATE_NODE",
    "payload": {
      "name": "Ma première entité",
      "entityType": "concept",
      "position": { "x": 200, "y": 200 }
    }
  }'

Réponse attendue :

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "name": "Ma première entité",
    "entityType": "concept"
  },
  "metadata": {
    "canUndo": true
  }
}

Étape 4 : Vérifier dans l'interface

1. Ouvrez l'application DataForge
2. Naviguez vers votre workspace
3. Ouvrez le canvas Modeler
4. Votre nouvelle entité devrait apparaître à la position (200, 200)

Prochaines étapes

• Clés API - Authentification avancée (scopes, rotation)
• Modeler - Comprendre le système de modélisation visuelle
• Référence API - Documentation complète des endpoints
• Erreurs et pagination - Bonnes pratiques de gestion d'erreurs

Problèmes courants

Erreur	Cause	Solution
401 Unauthorized	Clé API invalide ou manquante	Vérifiez le format du header Authorization
403 Forbidden	Mauvais workspace ou scope insuffisant	Vérifiez le header x-workspace-id
404 Not Found	Endpoint inexistant	Vérifiez l'URL

Voir Erreurs courantes pour un dépannage détaillé.