API de integración para socios

Resumen

La API de integración para socios de Firecrawl permite a los socios aprobados crear y gestionar claves de API de Firecrawl para sus usuarios directamente desde su propia plataforma. Esto ofrece una experiencia de incorporación fluida en la que los usuarios pueden empezar a usar Firecrawl sin salir de la plataforma del socio.

El acceso a la API para socios solo está disponible para los socios aprobados de Firecrawl. Las claves de socio se comparten de forma privada con los socios aprobados. Para solicitar el programa de socios o pedir una clave de API para socios, envía un correo a partnerships@firecrawl.dev.

Para obtener más información sobre lo que reciben los usuarios de socios, incluidos los créditos, la caducidad y los límites del plan, consulta Partner Credits.

URL base

https://integrations.firecrawl.dev

Autenticación

Todas las solicitudes a la API de integración para socios requieren una cabecera Authorization con tu clave de socio:

Authorization: Bearer <partner key>

Las claves de socio son distintas de las claves de API estándar de Firecrawl y el equipo de Firecrawl las proporciona directamente.

Requisitos de seguridad

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

Endpoints

Crear usuario

Crea una clave de API de Firecrawl asociada a la dirección de correo electrónico del usuario.

POST /partner/v1/accounts

Comportamiento

Si el usuario aún no tiene una cuenta de Firecrawl, se crearán un nuevo usuario y un nuevo equipo.
Si el usuario ya tiene una cuenta de Firecrawl pero no tiene un equipo asociado a la integración de tu partner, se creará un nuevo equipo asociado a ese partner.
Si el usuario ya tiene una cuenta de Firecrawl y ya tiene un equipo asociado a la integración de tu partner, se devolverá el equipo existente y el cupón promocional no se volverá a aplicar.

Solicitud

cURL

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

Cuerpo

Campo	Tipo	Obligatorio	Descripción
`email`	string	Sí	La dirección de correo electrónico del usuario

Respuesta

200 OK

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

Campo	Tipo	Descripción
`apiKey`	string	La clave de API de Firecrawl para el equipo de este usuario asociado con el partner
`alreadyExisted`	boolean	`true` si tanto el usuario como el equipo asociado con el partner ya existían. Cuando es `true`, el cupón promocional no vuelve a aplicarse.

Errores

Estado	Descripción
`401`	No autorizado: la clave de socio es incorrecta o no es válida
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Validar la 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 esta integración de partner.

POST /partner/v1/api-keys/validate

Notas importantes

Las claves de API de Firecrawl no tienen permisos ni fecha de vencimiento.
Los usuarios pueden eliminar manualmente las claves de API en cualquier momento.
Las claves de API eliminadas no se conservan como eliminadas de forma lógica. Firecrawl no puede distinguir entre una clave eliminada y una que nunca existió.

Solicitud

cURL

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

Cuerpo

Campo	Tipo	Obligatorio	Descripción
`apiKey`	string	Sí	La clave de API que se va a 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	La dirección de correo electrónico del usuario asociada a esta clave de API

Errores

Estado	Descripción
`401`	No autorizado: la clave de socio 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 esta integración de partner
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Rotar la 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 <partner 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 reemplazará

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 socio 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 esta integración de partner
`500`	Error interno del servidor: Firecrawl supervisa estos errores

Conviértete en socio

El programa para socios de Firecrawl está disponible para plataformas aprobadas. Si te interesa integrar Firecrawl en tu plataforma y ofrecer créditos a tus usuarios, contáctanos en partnerships@firecrawl.dev para obtener más información y solicitar una clave de API para socios.

Uso de la API

Endpoints de búsqueda

Endpoints de scraping

Endpoints de interacción

Endpoints de Research Index

Endpoints de mapeo

Endpoints de procesamiento

Endpoints de rastreo

Endpoints de supervisión

Endpoints de feedback

Endpoints de depuración con agentes

Endpoints de la cuenta

Cargas útiles de webhook

Integración de socios

API de integración para socios

Resumen

URL base

Autenticación

Requisitos de seguridad

Endpoints

Crear usuario

Comportamiento

Solicitud

Respuesta

Errores

Validar la clave de API

Notas importantes

Solicitud

Respuesta

Errores

Rotar la clave de API

Solicitud

Respuesta

Errores

Conviértete en socio

​Resumen

​URL base

​Autenticación

​Requisitos de seguridad

​Endpoints

​Crear usuario

​Comportamiento

​Solicitud

​Respuesta

​Errores

​Validar la clave de API

​Notas importantes

​Solicitud

​Respuesta

​Errores

​Rotar la clave de API

​Solicitud

​Respuesta

​Errores

​Conviértete en socio

Resumen

URL base

Autenticación

Requisitos de seguridad

Endpoints

Crear usuario

Comportamiento

Solicitud

Respuesta

Errores

Validar la clave de API

Notas importantes

Solicitud

Respuesta

Errores

Rotar la clave de API

Solicitud

Respuesta

Errores

Conviértete en socio