API d’intégration partenaire

Vue d’ensemble

L’API d’intégration partenaire de Firecrawl permet aux partenaires approuvés de créer et de gérer des clés API Firecrawl pour leurs utilisateurs directement depuis leur propre plateforme. Cela offre un parcours d’intégration fluide, permettant aux utilisateurs de démarrer avec Firecrawl sans quitter la plateforme du partenaire.

L’accès à l’API partenaire n’est disponible que pour les partenaires Firecrawl approuvés. Les clés partenaire sont communiquées en privé aux partenaires approuvés. Pour candidater au programme partenaire ou demander une clé API partenaire, envoyez un e-mail à partnerships@firecrawl.dev.

Pour en savoir plus sur ce dont bénéficient les utilisateurs partenaires, notamment les crédits, la durée de validité et les limites de l’offre, consultez Partner Credits.

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 et sont fournies directement par l’équipe 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

Crée une clé API Firecrawl associée à l’adresse e-mail de l’utilisateur.

POST /partner/v1/accounts

Comportement

Si l’utilisateur ne possède pas encore de compte Firecrawl, un nouvel utilisateur et une nouvelle équipe seront créés.
Si l’utilisateur possède déjà un compte Firecrawl, mais n’a pas d’équipe associée à votre intégration partenaire, une nouvelle équipe associée au partenaire sera créée.
Si l’utilisateur possède déjà un compte Firecrawl et a déjà une équipe associée à votre intégration partenaire, l’équipe existante est renvoyée et le coupon promotionnel n’est pas appliqué de nouveau.

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

Réponse

200 OK

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

Champ	Type	Description
`apiKey`	string	La clé API Firecrawl de l’équipe associée au partenaire de cet utilisateur
`alreadyExisted`	boolean	`true` si l’utilisateur et l’équipe associée au partenaire existaient déjà. Lorsque `true`, le coupon promotionnel n’est pas appliqué à nouveau.

Erreurs

État	Description
`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’adresse e-mail de l’utilisateur associé à cette 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

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

Devenir partenaire

Le programme de partenariat de Firecrawl est réservé aux plateformes approuvées. Si vous souhaitez intégrer Firecrawl à votre plateforme et offrir des crédits à vos utilisateurs, contactez-nous à partnerships@firecrawl.dev pour en savoir plus et demander une clé API partenaire.

Utilisation de l’API

Points de terminaison de recherche

Points de terminaison de Scrape

Points de terminaison d’Interact

Points de terminaison de Research Index

Points de terminaison de cartographie

Points de terminaison de Parse

Points de terminaison de crawl

Points de terminaison de Monitor

Points de terminaison de retours

Points de terminaison de débogage agentique

Points de terminaison du compte

Charges utiles des webhooks

Intégration partenaire

API d’intégration 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

Devenir 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

​Devenir 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

Devenir partenaire