API & MCP

REST API et MCP : démarrer une intégration

Utilisez la REST API dans votre logiciel ou connectez un client MCP via l'installation dans l'application. Les deux nécessitent un accès autorisé au bon espace.

Avant de connecter une intégration, configurez votre premier espace.

Lire la référence API actuelle

Swagger décrit les endpoints, champs de requête et schémas de réponse. Le document OpenAPI permet de générer un client API. Ces références sont publiques, mais les requêtes d'espace nécessitent une authentification.

Gérer les identifiants dans l'application

Ouvrez les réglages d'intégration ou d'agent dans l'application et créez un identifiant limité aux permissions nécessaires.

Copiez la clé affichée et conservez-la dans un coffre de secrets serveur ou une variable d'environnement. Les clés API ne sont pas envoyées par e-mail. Ne les placez pas dans le navigateur ni dans un dépôt public.

Révoquez les identifiants inutilisés ou exposés dans l'application. Créez-en un nouveau si nécessaire.

Commencer par une requête en lecture seule

Avec un identifiant autorisé à lister les espaces, demandez d'abord la liste accessible. La variable d'environnement contient votre clé stockée en sécurité. Utilisez l'identifiant public renvoyé pour les requêtes suivantes. Cet exemple ne lance aucun crawl et n'achète pas de données fraîches.

curl --fail-with-body "https://app.crawlfoundry.com/api/v1/workspaces" \
  --header "Authorization: Bearer $CRAWL_FOUNDRY_API_KEY"

Vérifier permissions et coûts avant une action

Une clé valide n'autorise pas toutes les actions. Vérifiez exigences, permissions, espace et solde. Suivez les étapes d'estimation et d'autorisation requises. Pour les jobs, examinez statut et erreurs : une requête acceptée n'est pas un résultat terminé.

Avant de demander des données récentes, consultez le fonctionnement du solde et des actualisations.

Connecter un client MCP

Utilisez l'installation proposée dans l'application pour Claude, Cursor, VS Code ou Codex. L'endpoint client est https://app.crawlfoundry.com/api/mcp. Une connexion liée à un espace inclut le sélecteur généré par l'application. Terminez connexion et consentement dans le navigateur. Sans espace fixe, sélectionnez un espace pour la session.

Demandez d'abord l'espace actif et des informations existantes. Autorisez une opération payante après examen de son périmètre et de son coût. Les exemples propres aux clients sont documentés et testés séparément.

Présentation du produit MCP