Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt

Use this file to discover all available pages before exploring further.

Visão geral

A API de Integração de Parceiros do Firecrawl permite que parceiros aprovados criem e gerenciem chaves de API do Firecrawl para seus usuários diretamente em sua própria plataforma. Isso proporciona uma experiência de onboarding fluida, em que os usuários podem começar a usar o Firecrawl sem sair da plataforma do parceiro.
O acesso à API de Parceiros está disponível apenas para parceiros aprovados do Firecrawl. As chaves de parceiro são compartilhadas de forma privada com parceiros aprovados. Para se candidatar ao programa de parceiros ou solicitar uma chave de API de parceiro, envie um e-mail para partnerships@firecrawl.dev.
Para saber mais sobre o que os usuários dos parceiros recebem, incluindo créditos, validade e limites do plano, consulte Partner Credits.

URL base

https://api.firecrawl.dev

Autenticação

Todas as solicitações da API de integração de parceiros exigem um cabeçalho Authorization com sua chave de parceiro:
Authorization: Bearer <partner key>
As chaves de parceiro são diferentes das chaves de API padrão do Firecrawl e são fornecidas diretamente pela equipe do Firecrawl.

Requisitos de segurança

  • Somente no servidor: As chaves de parceiro devem ser usadas apenas em código executado no servidor. Nunca exponha uma chave de parceiro em código de frontend, JavaScript do lado do cliente ou aplicativos móveis.
  • Termos de Serviço: Antes de chamar o endpoint create-user, sua plataforma deve solicitar ao usuário que aceite os Termos de Serviço do Firecrawl.

Endpoints

Criar usuário

Cria uma chave de API do Firecrawl associada ao endereço de e-mail do usuário.
POST /admin/integration/create-user

Comportamento

  • Se o usuário ainda não tiver uma conta no Firecrawl, um novo usuário e uma nova equipe serão criados.
  • Se o usuário já tiver uma conta no Firecrawl, mas não tiver uma equipe associada à integração de parceiro, uma nova equipe associada ao parceiro será criada.
  • Se o usuário já tiver uma conta no Firecrawl e já tiver uma equipe associada à integração de parceiro, a equipe existente será retornada e o cupom promocional não será aplicado novamente.

Requisição

cURL
curl -X POST "https://api.firecrawl.dev/admin/integration/create-user" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'
Corpo
CampoTipoObrigatórioDescrição
emailstringSimO endereço de e-mail do usuário

Resposta

200 OK
{
  "apiKey": "fc-...",
  "alreadyExisted": false
}
CampoTipoDescrição
apiKeystringA chave de API do Firecrawl da equipe associada ao parceiro deste usuário
alreadyExistedbooleantrue se tanto o usuário quanto a equipe associada ao parceiro já existiam. Quando true, o cupom promocional não é aplicado novamente.

Erros

StatusDescrição
401Não autorizado — a chave de parceiro está incorreta ou inválida
500Erro interno do servidor — esses erros são monitorados pela Firecrawl

Validar chave de API

Valida uma chave de API do Firecrawl e retorna o nome da equipe associada e o endereço de e-mail do usuário. A chave de API só será considerada válida se tiver sido criada por meio desta integração de parceiro.
POST /admin/integration/validate-api-key

Observações importantes

  • As chaves de API do Firecrawl não têm permissões nem data de expiração.
  • As chaves de API podem ser excluídas manualmente pelos usuários a qualquer momento.
  • As chaves de API excluídas não passam por exclusão lógica. O Firecrawl não consegue distinguir uma chave excluída de uma que nunca existiu.

Requisição

cURL
curl -X POST "https://api.firecrawl.dev/admin/integration/validate-api-key" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'
Corpo
CampoTipoObrigatórioDescrição
apiKeystringSimA chave de API a ser validada

Resposta

200 OK
{
  "teamName": "Example Team",
  "email": "user@example.com"
}
CampoTipoDescrição
teamNamestringO nome da equipe associada a esta chave de API
emailstringO endereço de e-mail do usuário associado a esta chave de API

Erros

StatusDescrição
401Não autorizado - a chave de parceiro está incorreta ou é inválida
404chave de API não reconhecida - a chave não existe ou não foi criada por esta integração de parceiro
500Erro interno do servidor - esses erros são monitorados pela Firecrawl

Rotacionar chave de API

Exclui uma chave de API do Firecrawl existente e cria uma nova para o mesmo usuário e equipe.
POST /admin/integration/rotate-api-key

Requisição

cURL
curl -X POST "https://api.firecrawl.dev/admin/integration/rotate-api-key" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'
Corpo
CampoTipoObrigatórioDescrição
apiKeystringSimA chave de API que será excluída e substituída

Resposta

200 OK
{
  "apiKey": "fc-..."
}
CampoTipoDescrição
apiKeystringA chave de API recém-criada

Erros

StatusDescrição
401Não autorizado - a chave de parceiro está incorreta ou inválida
404Chave de API não identificada - a chave não existe ou não foi criada por meio desta integração de parceiro
500Erro interno do servidor - esses erros são monitorados pela Firecrawl

Torne-se parceiro

O programa de parceiros da Firecrawl está disponível para plataformas aprovadas. Se tiver interesse em integrar a Firecrawl à sua plataforma e oferecer créditos aos seus usuários, entre em contato conosco pelo partnerships@firecrawl.dev para saber mais e solicitar uma chave de API para parceiros.