API & MCP

REST API und MCP: eine Integration starten

Nutze die REST API in deiner Software oder verbinde einen MCP-Client über die Einrichtung in der Anwendung. Beide Wege brauchen berechtigten Zugriff auf den richtigen Workspace.

Bevor du eine Integration verbindest, richte deinen ersten Workspace ein.

Die aktuelle API-Referenz lesen

Swagger beschreibt die unterstützten Endpunkte, Anfragefelder und Antwortschemas. Das maschinenlesbare OpenAPI-Dokument dient als Grundlage für einen API-Client. Diese Referenzen sind öffentlich, Workspace-Anfragen erfordern eine Authentifizierung.

Zugangsdaten in der Anwendung verwalten

Erstelle in den Integrations- oder Agent-Einstellungen einen Schlüssel mit den Berechtigungen, die deine Integration benötigt.

Kopiere den Schlüssel in den Secret Store deines Servers oder eine Umgebungsvariable. API-Keys werden nicht per E-Mail verschickt. Sie gehören nicht in Browser-Code oder öffentliche Repositories.

Widerrufe ungenutzte oder offengelegte Schlüssel in der Anwendung. Erstelle bei Bedarf einen neuen Schlüssel als Ersatz.

Mit einer lesenden Anfrage beginnen

Rufe mit einem berechtigten Schlüssel die zugänglichen Workspaces ab. Die Umgebungsvariable enthält deinen sicher gespeicherten Schlüssel. Nutze die öffentliche Workspace-ID aus der Antwort für weitere Anfragen. Dieses Beispiel startet keinen Crawl und kauft keine Daten.

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

Vor einer Aktion Berechtigungen und Kosten prüfen

Ein funktionierender Schlüssel erlaubt nicht jede Aktion. Prüfe Anforderungen, Berechtigungen, Workspace und Guthaben der Operation. Nutze die vorgesehenen Schätz- und Autorisierungsschritte. Prüfe bei Jobs Status und Fehler. Eine angenommene Anfrage ist noch kein abgeschlossenes Ergebnis.

Lies vor einem Datenabruf, wie Balance und Aktualisierungen funktionieren.

Einen MCP-Client verbinden

Nutze die Client-Einrichtung in der Anwendung für Claude, Cursor, VS Code oder Codex. Der Kunden-Endpunkt ist https://app.crawlfoundry.com/api/mcp. Eine Workspace-gebundene Verbindung enthält den von der App erzeugten Workspace-Parameter. Schließe Anmeldung und Zustimmung im Browser ab. Ohne fest gebundenen Workspace muss für die Sitzung ein Workspace gewählt werden.

Frage zuerst nach dem aktiven Workspace und bestehenden Informationen. Gib kostenpflichtige Operationen erst nach Prüfung von Umfang und Preis frei. Die einzelnen Client-Beispiele werden als eigene Aufgabe dokumentiert und getestet.

MCP-Produktübersicht