Firecrawl pour les plateformes

Vue d’ensemble

Firecrawl for Platforms 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 peuvent ainsi utiliser Firecrawl sans quitter votre plateforme.

Configurez vous-même Firecrawl for Platforms dans le tableau de bord Firecrawl. Tout administrateur ou membre d’une organisation peut créer une intégration : nommez-la, choisissez un type d’intégration, acceptez l’accord correspondant à ce type, puis copiez la clé de plateforme. La clé n’est affichée qu’une seule fois. Vous pouvez ensuite générer et révoquer des clés dans Settings. Aucune candidature ni approbation n’est requise.

Il existe deux types d’intégration. Tous deux provisionnent les comptes de la même manière, via les points de terminaison ci-dessous et avec la même clé de plateforme ; ils diffèrent uniquement par la partie qui paie l’utilisation :

Standard : vos utilisateurs paient Firecrawl. Chaque compte provisionné conserve sa propre offre et sa propre facturation Firecrawl, et effectue ses mises à niveau directement auprès de Firecrawl. Consultez la section Crédits des comptes provisionnés pour savoir de quoi dispose un nouveau compte au départ.
Gateway : votre organisation prend en charge l’utilisation de vos utilisateurs. Les comptes créés par votre intégration sont inscrits à Gateway : leur utilisation éligible est donc facturée à votre organisation. Consultez la section Gateway ci-dessous.

Le type d’intégration se choisit lors de la création de l’intégration. Il est difficile de le modifier par la suite ; nous vous recommandons donc d’examiner attentivement les deux options avant d’accepter l’accord. Pour une vue d’ensemble, consultez la page Firecrawl for Platforms. Certaines offres partenaires incluent des crédits promotionnels pour les utilisateurs provisionnés ; le cas échéant, la page Partner Credits décrit ce que reçoit l’utilisateur.

Gateway

Gateway est un type d’intégration, et non une API distincte : la clé de plateforme et les points de terminaison restent les mêmes. Voici ce qui change pour une intégration Gateway :

Les comptes sont créés exclusivement pour votre intégration et sont accessibles uniquement via l’API, sans connexion propre au tableau de bord. Une requête n’est jamais rattachée à un compte Firecrawl existant, même si l’e-mail correspond à celui d’un compte.
L’utilisation éligible est facturée à votre organisation. Consultez Crédits des comptes provisionnés pour savoir dans quels cas les crédits de l’utilisateur sont consommés en premier.
Les réponses de POST /partner/v1/accounts contiennent un champ gatewayStatus.
L’intégration accepte la version Gateway de l’accord lors de sa création.

URL de base

https://integrations.firecrawl.dev

Authentification

Toutes les requêtes à l’API Platforms nécessitent un en-tête Authorization contenant votre clé de plateforme :

Authorization: Bearer <platform key>

Les clés de plateforme sont distinctes des clés API Firecrawl standard. Vous les créez et les révoquez depuis Settings > Firecrawl for Platforms dans le tableau de bord Firecrawl.

Exigences de sécurité

Côté serveur uniquement : les clés de plateforme doivent être utilisées exclusivement dans du code côté serveur. N’exposez jamais une clé de plateforme dans du code frontend, du JavaScript côté client ou une application mobile.
Conditions d’utilisation : avant d’appeler POST /partner/v1/accounts, votre plateforme doit inviter l’utilisateur à accepter les Conditions d’utilisation de Firecrawl.

Crédits des comptes provisionnés

Les comptes créés par votre intégration ne disposent d’aucun crédit gratuit, sauf si Firecrawl a vérifié votre plateforme ou si vous avez signé un accord avec Firecrawl. D’ici là :

Un compte Standard démarre sans crédit inclus. L’utilisateur peut à tout moment ajouter un mode de paiement ou choisir une offre dans le tableau de bord Firecrawl.
Un compte Gateway facture l’intégralité des crédits à votre organisation.

Une fois votre plateforme vérifiée, les comptes nouveaux comme existants bénéficient des crédits mensuels du Forfait gratuit ; pour les comptes Gateway, ces crédits sont consommés avant toute facturation à votre organisation. La vérification est effectuée manuellement par Firecrawl. Lorsque votre intégration est en production, ou si vous créez une application destinée à la production, écrivez à partnerships@firecrawl.dev en indiquant l’ID de votre intégration.

Limites

La création de comptes est limitée par intégration, à la fois en nombre de comptes qu’une intégration peut créer et en rythme de création. Ces limites augmentent à mesure que la relation de votre organisation avec Firecrawl se développe et n’affectent jamais les comptes que vous avez déjà créés. Un appel répété pour un utilisateur que vous avez déjà provisionné renvoie le compte existant et n’est pas pris en compte dans la limite de comptes. Pour un compte Standard, l’adresse que vous envoyez doit permettre à votre utilisateur de recevoir des e-mails. Si vous atteignez une limite, ou si vous prévoyez une intégration en production, écrivez à partnerships@firecrawl.dev en indiquant l’ID de votre intégration et le volume prévu. Si Firecrawl suspend votre intégration, écrivez à help@firecrawl.com.

Points de terminaison

Créer un utilisateur

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

POST /partner/v1/accounts

Comportement

Avec une intégration Standard :

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 à votre intégration 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 une intégration Gateway :

Chaque compte est créé exclusivement pour votre intégration. Une requête n’est jamais rattachée à un compte Firecrawl existant, même si l’e-mail correspond à celui d’un compte. L’e-mail est enregistré comme adresse de contact du compte et ne sert pas à rechercher des comptes.
Des 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, ils sont appliqué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 <platform 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. Dans le cas d’une intégration Gateway, elle est enregistrée comme adresse de contact du compte.

Réponse

200 OK

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

Pour une intégration Gateway, la réponse contient également l’état de l’inscription :

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

Champ	Type	Description
`apiKey`	string	La clé API Firecrawl de l’équipe que votre intégration a provisionnée pour cet utilisateur
`alreadyExisted`	boolean	`true` si votre intégration avait déjà provisionné un compte pour cet e-mail. N’indique pas si l’e-mail est utilisé ailleurs dans Firecrawl.
`gatewayStatus`	string	Intégrations Gateway uniquement. `enrolled` lors de l’appel qui crée le compte, `already_enrolled` lors des appels suivants pour le même e-mail.

Erreurs

État	Description
`400`	Requête incorrecte : le champ `email` est manquant ou mal formé
`401`	Non autorisé : la clé de plateforme est incorrecte ou invalide
`403`	Refusé : le champ `error.code` du corps en précise la raison, à savoir `partner_account_cap_reached` (l’intégration a atteint sa limite de comptes), `partner_provisioning_email_rejected` (l’adresse ne peut pas être utilisée pour un compte Firecrawl) ou `partner_integration_suspended`. Voir Limites
`429`	Trop de requêtes : `rate_limit_exceeded` ; ralentissez le rythme, puis réessayez
`502`	Firecrawl n’a pas pu joindre son provider de facturation lors de la création du compte : réessayez la requête
`503`	Firecrawl n’a pas pu vérifier la limite de débit : réessayez dans quelques instants
`500`	Erreur interne du serveur : ces erreurs sont surveillées par Firecrawl

Valider une 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 reconnue comme valide que si elle a été créée via votre intégration.

POST /partner/v1/api-keys/validate

Remarques importantes

Les clés API Firecrawl n’ont ni autorisations ni date d’expiration.
Les utilisateurs peuvent supprimer manuellement leurs clés API à tout moment.
La suppression d’une clé API est définitive (pas de 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 <platform 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’adresse e-mail utilisée lors de la création du compte. 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é de plateforme 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 votre intégration
`500`	Erreur interne du serveur - ces erreurs sont surveillées par Firecrawl

Renouveler la clé API

Supprime une clé API Firecrawl existante et en crée 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 <platform key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

Corps

Champ	Type	Obligatoire	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 générée

Erreurs

État	Description
`401`	Non autorisé - la clé de plateforme 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 votre intégration
`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 Standard ou Gateway, acceptez l’accord, puis copiez votre clé de plateforme. Le type d’intégration étant difficile à modifier par la suite, vérifiez bien votre choix avant d’accepter l’accord. Appelez ensuite les points de terminaison ci-dessus depuis votre serveur. Des questions sur votre configuration ? Écrivez à help@firecrawl.com. Vous envisagez une intégration de plus grande envergure ? Écrivez à partnerships@firecrawl.dev.

Programme partenaire

Les plateformes qui provisionnent des comptes Firecrawl pour leurs utilisateurs peuvent candidater au programme partenaire Firecrawl (Firecrawl Partner Program). Les partenaires approuvés bénéficient d’un partage des revenus sur l’utilisation payante des utilisateurs qu’ils apportent, d’actions de co-marketing et d’une présence dans notre annuaire de partenaires, d’un accès anticipé aux nouveaux points de terminaison, d’une ligne directe avec notre équipe pour le support technique, ainsi que de limites plus élevées pour leurs utilisateurs. L’accès au programme se fait sur candidature, et nous répondons sous une semaine. En contrepartie, les partenaires affichent « Powered by Firecrawl » dans leur produit, avec un lien vers firecrawl.dev incluant leur balise ?ref=<partner>. Le partage des revenus s’applique uniquement aux nouveaux clients payants que vous apportez après l’approbation de votre candidature, sans aucun effet rétroactif. Il couvre la première année de chaque client sur les offres self-serve ; les offres Scale et Enterprise en sont exclues. Chaque partenaire est examiné et approuvé par notre équipe. Candidater au programme partenaire Vous écrivez sur Firecrawl ou publiez des liens vers notre site ? Le programme d’affiliation est plus adapté.

​Vue d’ensemble

​Gateway

​URL de base

​Authentification

​Exigences de sécurité

​Crédits des comptes provisionnés

​Limites

​Points de terminaison

​Créer un utilisateur

​Comportement

​Requête

​Réponse

​Erreurs

​Valider une clé API

​Remarques importantes

​Requête

​Réponse

​Erreurs

​Renouveler la clé API

​Requête

​Réponse

​Erreurs

​Démarrer

​Programme partenaire

Vue d’ensemble

Gateway

URL de base

Authentification

Exigences de sécurité

Crédits des comptes provisionnés

Limites

Points de terminaison

Créer un utilisateur

Comportement

Requête

Réponse

Erreurs

Valider une clé API

Remarques importantes

Requête

Réponse

Erreurs

Renouveler la clé API

Requête

Réponse

Erreurs

Démarrer

Programme partenaire