Partner API

Vue d’ensemble

L’API d’intégration partenaire de Firecrawl permet à votre plateforme de créer et de gérer des clés API Firecrawl pour vos utilisateurs directement depuis votre propre backend. Vos utilisateurs commencent à utiliser Firecrawl sans quitter votre plateforme.

Configurez vous-même la Partner API dans le tableau de bord Firecrawl. Tout administrateur ou membre d’une organisation peut créer une intégration : la nommer, choisir une configuration, accepter l’accord correspondant, puis copier la clé partenaire. La clé n’est affichée qu’une seule fois. Vous pourrez générer et révoquer des clés par la suite dans Settings. Aucune candidature ni approbation n’est nécessaire.

Il existe deux configurations. Toutes deux provisionnent les comptes de la même manière via les points de terminaison ci-dessous ; elles diffèrent sur un point : qui paie l’utilisation de l’utilisateur.

Partner API : chaque compte provisionné conserve son propre plan et sa propre facturation Firecrawl. Les utilisateurs démarrent sur le Free plan et effectuent leur mise à niveau directement auprès de Firecrawl.
Gateway : les comptes créés par votre intégration sont inscrits à Gateway ; leur utilisation éligible est donc facturée à votre organisation une fois les crédits propres à l’utilisateur épuisés. Les comptes Gateway sont exclusivement API et ne disposent pas de leur propre accès au tableau de bord.

Vous choisissez la configuration au moment de créer l’intégration. Il n’est pas facile de la modifier par la suite : nous vous recommandons donc d’examiner attentivement les deux options avant d’accepter l’accord. Consultez la page Partner API pour une vue d’ensemble. Certaines partner offers incluent des crédits promotionnels pour les utilisateurs provisionnés ; le cas échéant, Partner Credits détaille ce que reçoit l’utilisateur.

URL de base

https://integrations.firecrawl.dev

Authentification

Toutes les requêtes adressées à l’API d’intégration partenaire nécessitent un en-tête Authorization contenant votre clé partenaire :

Authorization: Bearer <partner key>

Les clés partenaires sont distinctes des clés API Firecrawl standards. Vous pouvez les créer et les révoquer dans Settings > Partner API du tableau de bord Firecrawl.

Exigences de sécurité

Côté serveur uniquement : les clés partenaires ne doivent être utilisées que dans du code côté serveur. N’exposez jamais une clé partenaire dans du code front-end, du JavaScript côté client ou des applications mobiles.
Conditions d’utilisation : avant d’appeler POST /partner/v1/accounts, votre plateforme doit demander à l’utilisateur d’accepter les Conditions d’utilisation de Firecrawl.

Points de terminaison

Créer un utilisateur

Provisionne un compte Firecrawl pour l’un de vos utilisateurs, identifié par son e-mail, et renvoie sa clé API.

POST /partner/v1/accounts

Comportement

Avec la configuration Partner API :

Si l’utilisateur n’a pas encore de compte Firecrawl, un nouvel utilisateur et une nouvelle équipe sont créés.
Si l’utilisateur a déjà un compte Firecrawl mais aucune équipe associée à votre intégration, une nouvelle équipe associée au partenaire est créée.
Si l’utilisateur a déjà un compte Firecrawl et une équipe associée à votre intégration, l’équipe existante est renvoyée.

Avec la configuration Gateway :

Chaque compte est créé pour votre intégration uniquement. Une requête ne se rattache jamais à un compte Firecrawl existant, même si l’e-mail correspond à celui d’un compte existant. L’e-mail est enregistré comme adresse de contact du compte et ne sert pas à rechercher des comptes.
Les appels répétés avec le même e-mail renvoient le même compte et sa clé API.

Si votre intégration inclut des crédits promotionnels, ceux-ci sont attribués une seule fois, à la création du compte.

Requête

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

Corps

Champ	Type	Obligatoire	Description
`email`	string	Oui	L’adresse e-mail de l’utilisateur. Avec la configuration Gateway, elle est stockée comme adresse de contact du compte.

Réponse

200 OK

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

Avec le setup Gateway, la réponse contient également l’état d’inscription :

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

Champ	Type	Description
`apiKey`	string	La clé API Firecrawl de l’équipe associée au partenaire de cet utilisateur
`alreadyExisted`	boolean	`true` si votre intégration avait déjà provisionné un compte pour cet e-mail. Cela n’indique en rien si l’e-mail existe ailleurs dans Firecrawl.
`gatewayStatus`	string	Intégrations de passerelle uniquement. `enrolled` lors de l’appel qui crée le compte, `already_enrolled` lors des appels répétés pour le même e-mail.

Erreurs

État	Description
`400`	Requête incorrecte - `email` est manquant ou mal formé
`401`	Non autorisé - la clé partenaire est incorrecte ou non valide
`500`	Erreur interne du serveur - ces erreurs sont surveillées par Firecrawl

Valider la clé API

Valide une clé API Firecrawl et renvoie le nom de l’Équipe associée ainsi que l’adresse e-mail de l’utilisateur. La clé API n’est indiquée comme valide que si elle a été créée via cette intégration partenaire.

POST /partner/v1/api-keys/validate

Remarques importantes

Les clés API Firecrawl n’ont ni autorisations ni date d’expiration.
Les clés API peuvent être supprimées manuellement par les utilisateurs à tout moment.
Les clés API supprimées ne font pas l’objet d’une suppression logique. Firecrawl ne peut pas distinguer une clé supprimée d’une clé qui n’a jamais existé.

Requête

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

Corps

Champ	Type	Obligatoire	Description
`apiKey`	string	Oui	La clé API à valider

Réponse

200 OK

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

Champ	Type	Description
`teamName`	string	Le nom de l’équipe associée à cette clé API
`email`	string	L’e-mail avec lequel le compte a été provisionné. Pour les comptes Gateway, il s’agit de l’adresse de contact que vous avez fournie.

Erreurs

État	Description
`400`	Requête incorrecte - la clé API est mal formée
`401`	Non autorisé - la clé partenaire est incorrecte ou non valide
`404`	Impossible d’identifier la clé API - la clé n’existe pas ou n’a pas été créée via cette intégration partenaire
`500`	Erreur interne du serveur - ces erreurs sont surveillées par Firecrawl

Rotation de la clé API

Supprime une clé API Firecrawl existante et en génère une nouvelle pour le même utilisateur et la même équipe.

POST /partner/v1/api-keys/rotate

Requête

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

Corps

Champ	Type	Requis	Description
`apiKey`	string	Oui	La clé API à supprimer et à remplacer

Réponse

200 OK

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

Champ	Type	Description
`apiKey`	string	La nouvelle clé API

Erreurs

État	Description
`401`	Non autorisé - la clé partenaire est incorrecte ou invalide
`404`	Impossible d’identifier la clé API - la clé n’existe pas ou n’a pas été créée via cette intégration partenaire
`500`	Erreur interne du serveur - ces erreurs sont surveillées par Firecrawl

Démarrer

Créez votre intégration dans le tableau de bord Firecrawl : connectez-vous, choisissez Partner API ou Gateway, acceptez l’accord et copiez votre clé partenaire. Cette configuration est difficile à modifier par la suite, veuillez donc confirmer votre choix avant d’accepter l’accord. Appelez ensuite les points de terminaison ci-dessus depuis votre serveur. Des questions sur votre configuration ? Écrivez-nous à help@firecrawl.com. Un projet d’intégration plus ambitieux ? Écrivez-nous à partnerships@firecrawl.dev.

Utilisation de l’API

Points de terminaison de recherche

Points de terminaison de scraping

Points de terminaison Interact / Browser Sandbox

Points de terminaison de Research Index

Points de terminaison de l’index développeur

Points de terminaison de cartographie

Points de terminaison d’analyse

Points de terminaison crawl

Points de terminaison de surveillance

Points de terminaison Agent

Points de terminaison de retour

Points de terminaison de débogage agentique

Points de terminaison du compte

Charges utiles de webhook

API partenaire

Vue d’ensemble

URL de base

Authentification

Exigences de sécurité

Points de terminaison

Créer un utilisateur

Comportement

Requête

Réponse

Erreurs

Valider la clé API

Remarques importantes

Requête

Réponse

Erreurs

Rotation de la clé API

Requête

Réponse

Erreurs

Démarrer

​Vue d’ensemble

​URL de base

​Authentification

​Exigences de sécurité

​Points de terminaison

​Créer un utilisateur

​Comportement

​Requête

​Réponse

​Erreurs

​Valider la clé API

​Remarques importantes

​Requête

​Réponse

​Erreurs

​Rotation de la clé API

​Requête

​Réponse

​Erreurs

​Démarrer

Vue d’ensemble

URL de base

Authentification

Exigences de sécurité

Points de terminaison

Créer un utilisateur

Comportement

Requête

Réponse

Erreurs

Valider la clé API

Remarques importantes

Requête

Réponse

Erreurs

Rotation de la clé API

Requête

Réponse

Erreurs

Démarrer