Crawl Foundry
Abrir app
API & MCP

REST API y MCP: iniciar una integración

Usa la REST API en tu software o conecta un cliente MCP mediante la instalación de la aplicación. Ambos necesitan acceso autorizado al espacio correcto.

Antes de conectar una integración, configura tu primer espacio.

Leer la referencia API actual

Swagger describe endpoints, campos de solicitud y esquemas de respuesta. El documento OpenAPI permite generar un cliente API. Las referencias son públicas, pero las solicitudes al espacio requieren autenticación.

Gestionar credenciales en la aplicación

1
Abre los ajustes de integración o agente en la aplicación y crea una credencial con los permisos necesarios.
2
Copia la clave mostrada y guárdala en el almacén de secretos del servidor o una variable de entorno. Las claves API no se envían por correo. No las incluyas en código del navegador ni repositorios públicos.
3
Revoca las credenciales sin uso o expuestas desde la aplicación. Crea una nueva cuando necesites sustituirla.

Empezar con una solicitud de lectura

Con una credencial autorizada para listar espacios, solicita primero la lista accesible. La variable de entorno contiene tu clave guardada de forma segura. Usa el ID público devuelto para solicitudes posteriores. El ejemplo no inicia rastreos ni compra datos recientes.

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

Revisar permisos y costes antes de ejecutar

Una clave válida no autoriza todas las acciones. Revisa requisitos, permisos, espacio y saldo. Sigue los pasos de estimación y autorización requeridos. En los trabajos, revisa estado y errores: una solicitud aceptada no es un resultado terminado.

Antes de solicitar datos recientes, consulta cómo funcionan el saldo y las actualizaciones.

Conectar un cliente MCP

Usa la instalación de la aplicación para Claude, Cursor, VS Code o Codex. El endpoint del cliente es https://app.crawlfoundry.com/api/mcp. La conexión vinculada a un espacio incluye el selector generado por la app. Completa acceso y consentimiento en el navegador. Sin espacio fijo, elige uno para la sesión.

Pregunta primero por el espacio activo y la información existente. Aprueba operaciones de pago tras revisar alcance y coste. Los ejemplos específicos de clientes se documentan y prueban por separado.

Documentación relacionada