API de integração de parceiros

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.

Para saber mais sobre o que os usuários dos parceiros recebem, incluindo créditos, validade e limites do plano, consulte Partner Credits.

https://integrations.firecrawl.dev

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.

• 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 POST /partner/v1/accounts, sua plataforma deve solicitar ao usuário que aceite os Termos de Serviço do Firecrawl.

Cria uma chave de API do Firecrawl associada ao endereço de e-mail do usuário.

POST /partner/v1/accounts

• 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.

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

Corpo

200 OK

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

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 /partner/v1/api-keys/validate

• 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.

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-..."}'

Corpo

200 OK

{
  "teamName": "Example Team",
  "email": "[email protected]"
}

Exclui uma chave de API do Firecrawl existente e cria uma nova para o mesmo usuário e equipe.

POST /partner/v1/api-keys/rotate

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-..."}'

Corpo

200 OK

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

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 [email protected] para saber mais e solicitar uma chave de API para parceiros.