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

# Firecrawl pour les plateformes

> Référence de l'API pour les plateformes qui créent et gèrent des clés API Firecrawl pour leurs utilisateurs

<h2 id="overview">
  Vue d'ensemble
</h2>

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.

<Note>
  Configurez vous-même Firecrawl for Platforms dans le [tableau de bord Firecrawl](https://www.firecrawl.dev/app/partner-api). 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.
</Note>

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, démarre avec l'offre Free et effectue ses mises à niveau directement auprès de Firecrawl.
* **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 une fois les crédits propres de l'utilisateur épuisés. Consultez la section [Gateway](#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](https://www.firecrawl.dev/firecrawl-for-platforms).

Certaines offres partenaires incluent des crédits promotionnels pour les utilisateurs provisionnés ; le cas échéant, la page [Partner Credits](/fr/partner-credits) décrit ce que reçoit l'utilisateur.

<h3 id="gateway">
  Gateway
</h3>

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.
* Les crédits de l'utilisateur sont consommés en premier. Au-delà, l'utilisation éligible est facturée à votre organisation.
* 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.

<h2 id="base-url">
  URL de base
</h2>

```
https://integrations.firecrawl.dev
```

<h2 id="authentication">
  Authentification
</h2>

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

```bash theme={null}
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](https://www.firecrawl.dev/app/partner-api).

<h2 id="security-requirements">
  Exigences de sécurité
</h2>

* **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](https://www.firecrawl.dev/terms-of-service) de Firecrawl.

***

<h2 id="endpoints">
  Points de terminaison
</h2>

<h3 id="create-user">
  Créer un utilisateur
</h3>

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
```

<h4 id="behavior">
  Comportement
</h4>

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.

<h4 id="request">
  Requête
</h4>

```bash cURL theme={null}
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. |

<h4 id="response">
  Réponse
</h4>

**`200 OK`**

```json theme={null}
{
  "apiKey": "fc-...",
  "alreadyExisted": false
}
```

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

```json theme={null}
{
  "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. |

<h4 id="errors">
  Erreurs
</h4>

| É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 |
| `500` | Erreur interne du serveur : ces erreurs sont surveillées par Firecrawl |

***

<h3 id="validate-api-key">
  Valider une clé API
</h3>

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
```

<h4 id="important-notes">
  Remarques importantes
</h4>

* 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é.

<h4 id="request-2">
  Requête
</h4>

```bash cURL theme={null}
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 |

<h4 id="response-2">
  Réponse
</h4>

**`200 OK`**

```json theme={null}
{
  "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. |

<h4 id="errors-2">
  Erreurs
</h4>

| É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 |

***

<h3 id="rotate-api-key">
  Renouveler la clé API
</h3>

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
```

<h4 id="request-3">
  Requête
</h4>

```bash cURL theme={null}
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 |

<h4 id="response-3">
  Réponse
</h4>

**`200 OK`**

```json theme={null}
{
  "apiKey": "fc-..."
}
```

| Champ | Type | Description |
| - | - | - |
| `apiKey` | string | La nouvelle clé API générée |

<h4 id="errors-3">
  Erreurs
</h4>

| É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 |

***

<h2 id="get-started">
  Démarrer
</h2>

Créez votre intégration dans le [tableau de bord Firecrawl](https://www.firecrawl.dev/app/partner-api) : 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](mailto:help@firecrawl.com). Vous envisagez une intégration de plus grande envergure ? Écrivez à [partnerships@firecrawl.dev](mailto:partnerships@firecrawl.dev).