Firecrawl for Platforms

Descripción general

Firecrawl for Platforms permite que tu plataforma cree y gestione claves de API de Firecrawl para tus usuarios directamente desde tu propio backend. Así, los usuarios empiezan a utilizar Firecrawl sin salir de tu plataforma.

Configura Firecrawl for Platforms por tu cuenta en el Dashboard de Firecrawl. Cualquier administrador o miembro de una organización puede crear una integración: asígnale un nombre, selecciona un tipo de integración, acepta el acuerdo correspondiente a ese tipo y copia la clave de plataforma. La clave solo se muestra una vez. Más adelante puedes generar y revocar claves en Settings. No hace falta enviar ninguna solicitud ni esperar aprobación.

Hay dos tipos de integración. Ambos aprovisionan cuentas de la misma forma, mediante los endpoints que se describen a continuación y con la misma clave de plataforma; la diferencia está en quién paga el uso de cada usuario:

Standard: tus usuarios pagan a Firecrawl. Cada cuenta aprovisionada mantiene su propio plan y facturación de Firecrawl, empieza en el plan Free y cambia a un plan superior directamente con Firecrawl.
Gateway: tu organización cubre el uso de tus usuarios. Las cuentas que crea tu integración se inscriben en Gateway, de modo que su uso elegible se factura a tu organización una vez que el usuario agota sus propios créditos. Consulta Gateway más abajo.

El tipo de integración se selecciona al crearla. Cambiarlo después no es sencillo, así que te recomendamos revisar bien ambas opciones antes de aceptar el acuerdo. Consulta la página de Firecrawl for Platforms para ver una descripción general. Algunas ofertas del socio incluyen créditos promocionales para los usuarios aprovisionados; en ese caso, en Créditos de socio se detalla lo que recibe el usuario.

Gateway

Gateway es un tipo de integración, no una API independiente. Se usan la misma clave de plataforma y los mismos endpoints. Esto es lo que cambia en una integración Gateway:

Las cuentas se crean exclusivamente para tu integración y son solo de API, sin acceso propio al Dashboard. Una solicitud nunca se vincula a una cuenta de Firecrawl existente, aunque el correo electrónico coincida con el de una de ellas.
Primero se consumen los créditos propios del usuario. El uso elegible que exceda esa cantidad se factura a tu organización.
Las respuestas de POST /partner/v1/accounts incluyen un campo gatewayStatus.
La integración acepta la versión Gateway del acuerdo al crearse.

URL base

https://integrations.firecrawl.dev

Autenticación

Todas las solicitudes a la API de Platforms requieren una cabecera Authorization con tu clave de plataforma:

Authorization: Bearer <platform key>

Las claves de plataforma no son las mismas que las claves de API estándar de Firecrawl. Puedes crearlas y revocarlas en Settings > Firecrawl for Platforms, en el Dashboard de Firecrawl.

Requisitos de seguridad

Solo en el servidor: las claves de plataforma solo deben usarse en código del lado del servidor. Nunca expongas una clave de plataforma en código de frontend, JavaScript del lado del cliente ni aplicaciones móviles.
Términos del servicio: antes de llamar a POST /partner/v1/accounts, tu plataforma debe pedir al usuario que acepte los Términos del servicio de Firecrawl.

Endpoints

Crear usuario

Aprovisiona una cuenta de Firecrawl para uno de tus usuarios, identificado por su correo electrónico, y devuelve su clave de API.

POST /partner/v1/accounts

Comportamiento

Con una integración Standard:

Si el usuario aún no tiene una cuenta de Firecrawl, se crean un nuevo usuario y un nuevo equipo.
Si el usuario ya tiene una cuenta de Firecrawl, pero ningún equipo asociado a tu integración, se crea un nuevo equipo asociado a tu integración.
Si el usuario ya tiene una cuenta de Firecrawl y un equipo asociado a tu integración, se devuelve el equipo existente.

Con una integración Gateway:

Cada cuenta se crea exclusivamente para tu integración. Una solicitud nunca se vincula a una cuenta de Firecrawl existente, aunque el correo electrónico coincida con el de alguna. El correo electrónico se guarda como dirección de contacto de la cuenta y no se usa para buscar cuentas.
Las llamadas repetidas con el mismo correo electrónico devuelven la misma cuenta y su clave de API.

Si tu integración incluye créditos promocionales, se aplican una sola vez, al crear la cuenta por primera vez.

Solicitud

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/accounts" \
  -H "Authorization: Bearer <platform key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

Cuerpo

Campo	Tipo	Obligatorio	Descripción
`email`	string	Sí	Dirección de correo electrónico del usuario. En una integración de Gateway, se guarda como dirección de contacto de la cuenta.

Respuesta

200 OK

{
  "apiKey": "fc-...",
  "alreadyExisted": false
}

En una integración de Gateway, la respuesta también incluye el estado de inscripción:

{
  "apiKey": "fc-...",
  "alreadyExisted": false,
  "gatewayStatus": "enrolled"
}

Campo	Tipo	Descripción
`apiKey`	string	La clave de API de Firecrawl del equipo que tu integración aprovisionó para este usuario
`alreadyExisted`	boolean	`true` si tu integración ya había aprovisionado una cuenta para este correo electrónico. No indica si el correo existe en otro lugar de Firecrawl.
`gatewayStatus`	string	Solo para integraciones Gateway. `enrolled` en la llamada que crea la cuenta y `already_enrolled` en las llamadas posteriores con el mismo correo electrónico.

Errores

Estado	Descripción
`400`	Solicitud incorrecta: falta `email` o su formato no es válido
`401`	No autorizado: la clave de plataforma es incorrecta o no es válida
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Validar clave de API

Valida una clave de API de Firecrawl y devuelve el nombre del equipo asociado y la dirección de correo electrónico del usuario. La clave de API solo se considerará válida si se creó a través de tu integración.

POST /partner/v1/api-keys/validate

Notas importantes

Las claves de API de Firecrawl no tienen permisos ni fecha de caducidad.
Los usuarios pueden eliminar manualmente las claves de API en cualquier momento.
Las claves de API eliminadas no se someten a un borrado lógico (soft delete). Firecrawl no puede distinguir una clave eliminada de una que nunca existió.

Solicitud

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/validate" \
  -H "Authorization: Bearer <platform key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

Cuerpo

Campo	Tipo	Obligatorio	Descripción
`apiKey`	string	Sí	La clave de API que se validará

Respuesta

200 OK

{
  "teamName": "Example Team",
  "email": "user@example.com"
}

Campo	Tipo	Descripción
`teamName`	string	El nombre del equipo asociado a esta clave de API
`email`	string	El correo electrónico con el que se aprovisionó la cuenta. En las cuentas Gateway, es la dirección de contacto que proporcionaste.

Errores

Estado	Descripción
`400`	Solicitud incorrecta: la clave de API tiene un formato no válido
`401`	No autorizado: la clave de plataforma es incorrecta o no válida
`404`	No se puede identificar la clave de API: la clave no existe o no se creó a través de tu integración
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Rotar clave de API

Elimina una clave de API de Firecrawl existente y crea una nueva para el mismo usuario y equipo.

POST /partner/v1/api-keys/rotate

Solicitud

cURL

curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/rotate" \
  -H "Authorization: Bearer <platform key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

Cuerpo

Campo	Tipo	Obligatorio	Descripción
`apiKey`	string	Sí	La clave de API que se eliminará y sustituirá

Respuesta

200 OK

{
  "apiKey": "fc-..."
}

Campo	Tipo	Descripción
`apiKey`	string	La clave de API recién creada

Errores

Estado	Descripción
`401`	No autorizado: la clave de plataforma es incorrecta o no es válida
`404`	No se puede identificar la clave de API: la clave no existe o no se creó a través de tu integración
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Primeros pasos

Crea tu integración en el Dashboard de Firecrawl: inicia sesión, selecciona Standard o Gateway, acepta el acuerdo y copia tu clave de plataforma. El tipo de integración no es fácil de cambiar más adelante, así que confirma tu elección antes de aceptar el acuerdo. Después, llama a los endpoints anteriores desde tu servidor. ¿Tienes dudas sobre tu configuración? Escribe a help@firecrawl.com. ¿Estás pensando en una integración de mayor alcance? Escribe a partnerships@firecrawl.dev.

Uso de la API

Endpoints de búsqueda

Endpoints de scraping

Endpoints de interacción / sandbox del navegador

Endpoints de Research Index

Endpoints de developer index

Endpoints de mapeo

Endpoints de procesamiento

Endpoints de rastreo

Supervisar endpoints

Endpoints de agentes

Endpoints de comentarios

Endpoints de depuración con agentes

Endpoints de cuenta

Cargas útiles de webhook

Firecrawl para plataformas

Firecrawl for Platforms

Descripción general

Gateway

URL base

Autenticación

Requisitos de seguridad

Endpoints

Crear usuario

Comportamiento

Solicitud

Respuesta

Errores

Validar clave de API

Notas importantes

Solicitud

Respuesta

Errores

Rotar clave de API

Solicitud

Respuesta

Errores

Primeros pasos

​Descripción general

​Gateway

​URL base

​Autenticación

​Requisitos de seguridad

​Endpoints

​Crear usuario

​Comportamiento

​Solicitud

​Respuesta

​Errores

​Validar clave de API

​Notas importantes

​Solicitud

​Respuesta

​Errores

​Rotar clave de API

​Solicitud

​Respuesta

​Errores

​Primeros pasos

Descripción general

Gateway

URL base

Autenticación

Requisitos de seguridad

Endpoints

Crear usuario

Comportamiento

Solicitud

Respuesta

Errores

Validar clave de API

Notas importantes

Solicitud

Respuesta

Errores

Rotar clave de API

Solicitud

Respuesta

Errores

Primeros pasos