> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI Octoparse

> Référence OpenAPI Octoparse pour l'authentification, la gestion des tâches, l'extraction dans le cloud et l'export de données.

Utilisez l'OpenAPI Octoparse pour gérer les tâches, lancer des extractions dans le cloud et récupérer par programmation les données extraites.

## Authentification

Pour les points de terminaison protégés, la méthode d'authentification la plus simple est une clé API Octoparse. Créez une clé dans le centre de compte Octoparse, puis ajoutez-la à l'en-tête de requête `x-api-key`. Une même clé peut servir avec l'OpenAPI Octoparse, le serveur MCP et la CLI.

<Card title="Créer ou gérer les clés API" icon="key" href="https://www.octoparse.fr/console/account-center/api-keys">
  Ouvrez la page des clés API dans votre centre de compte Octoparse.
</Card>

Les clés API commencent généralement par `op_sk_` :

```bash theme={null}
curl "https://openapi.octoparse.com/taskGroup" \
  --header "x-api-key: op_sk_xxxxx"
```

<Warning>
  Gardez votre clé API secrète. Ne l'exposez pas dans du code côté navigateur, des dépôts publics, des captures d'écran ou des journaux.
</Warning>

L'authentification par jeton d'accès est également prise en charge. Obtenez un jeton d'accès avec `POST /token`, puis envoyez-le sous la forme `Authorization: Bearer <access_token>`.

## API AgentTools

L'API AgentTools est une couche de flux de travail fondée sur des modèles et destinée aux agents d'IA. Elle s'appuie sur les anciennes API de bas niveau Tâche, Extraction dans le cloud et Données. Utilisez-la lorsqu'un agent ou une automatisation doit trouver un modèle de scraping approprié, démarrer une exécution, suivre les prochaines étapes indiquées par le serveur et récupérer les métadonnées d'exportation sans assembler directement chaque point de terminaison de bas niveau.

Nouveau flux de scraping :

```text theme={null}
searchTemplates -> executeTask -> exportData
```

Flux d'une tâche existante :

```text theme={null}
searchTasks -> startOrStopTask -> exportData
```

Vous découvrez AgentTools ? Consultez le [tutoriel complet du flux de travail](https://helpcenter.octoparse.com/fr/articles/15855832-run-a-scraping-workflow-with-the-octoparse-agenttools-api) pour apprendre à rechercher des modèles, démarrer une tâche et exporter les résultats.

Les réponses AgentTools conservent les champs métier dans `data`. Utilisez `requestId` uniquement pour le dépannage et suivez `retryGuidance`, `suggestedNextCall`, `workflow` et `toolHint` au lieu de coder en dur les intervalles d'interrogation.

<Info>
  L'API AgentTools exige une authentification `x-api-key`. Certains points de terminaison exigent aussi `x-external-user-id` ; consultez la référence de chacun pour connaître les en-têtes exacts.
</Info>

## Avant de commencer

Pour utiliser l'OpenAPI Octoparse, vous devez disposer d'une **Offre Standard, Professionnelle ou Entreprise** et d'au moins une tâche fonctionnelle. [Inscrivez-vous ici](https://www.octoparse.fr/signup) si ce n'est pas encore le cas.

Version actuelle de l'API : **v1.0**

## URL de base

Toutes les requêtes doivent être encodées sous forme d'URL par rapport à l'URL de base :

```text theme={null}
https://openapi.octoparse.com
```

Les espaces réservés sont affichés sous la forme `{xxxx}` et doivent être remplacés par des valeurs réelles. Par exemple, l'URL de requête de *Rechercher une tâche* est :

```text theme={null}
GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}
```

Si l'identifiant de votre groupe de tâches est `abc`, l'URL devient `https://openapi.octoparse.com/task/search?taskGroupId=abc`.

## Limites de débit

Octoparse limite l'utilisation de l'API à **20 requêtes par seconde**. Si vous recevez le code d'état `429`, réduisez la fréquence des requêtes.

Une réponse réussie renvoie le code HTTP `200`. Pour les autres codes, consultez la section [Références](#) de chaque point de terminaison.

## Autorisations

Assurez-vous que votre compte est autorisé à utiliser chaque service. Sinon, mettez votre offre à niveau.

| Service                  | API                                             | Offre requise                         |
| ------------------------ | ----------------------------------------------- | ------------------------------------- |
| Jeton d'accès            | Obtenir un nouveau jeton                        | Tous les utilisateurs                 |
| Jeton d'accès            | Renouveler le jeton                             | Tous les utilisateurs                 |
| Groupe de tâches         | Obtenir les informations du groupe de tâches    | Standard, Professionnelle, Entreprise |
| Tâche                    | Rechercher une tâche                            | Standard, Professionnelle, Entreprise |
| Tâche                    | Dupliquer une tâche                             | Standard, Professionnelle, Entreprise |
| Tâche                    | Déplacer une tâche                              | Standard, Professionnelle, Entreprise |
| Tâche                    | Obtenir les paramètres d'action                 | Professionnelle, Entreprise           |
| Tâche                    | Mettre à jour les paramètres de la tâche        | Professionnelle, Entreprise           |
| Tâche                    | Mettre à jour les paramètres d'action           | Professionnelle, Entreprise           |
| Tâche                    | Mettre à jour la liste des éléments de boucle   | Professionnelle, Entreprise           |
| Tâche                    | Mettre à jour les URL de la tâche               | Professionnelle, Entreprise           |
| Extraction dans le cloud | Démarrer la tâche                               | Professionnelle, Entreprise           |
| Extraction dans le cloud | Arrêter la tâche                                | Professionnelle, Entreprise           |
| Extraction dans le cloud | Obtenir l'état de la tâche                      | Professionnelle, Entreprise           |
| Extraction dans le cloud | Obtenir l'état de la tâche V2                   | Professionnelle, Entreprise           |
| Extraction dans le cloud | Obtenir l'état de la sous-tâche                 | Professionnelle, Entreprise           |
| Extraction dans le cloud | Démarrer les sous-tâches                        | Professionnelle, Entreprise           |
| Extraction dans le cloud | Arrêter les sous-tâches                         | Professionnelle, Entreprise           |
| Données                  | Obtenir les données non exportées               | Standard, Professionnelle, Entreprise |
| Données                  | Marquer les données comme exportées             | Standard, Professionnelle, Entreprise |
| Données                  | Obtenir les données par décalage                | Standard, Professionnelle, Entreprise |
| Données                  | Obtenir par décalage les données d'un lot donné | Standard, Professionnelle, Entreprise |
| Données                  | Supprimer les données                           | Standard, Professionnelle, Entreprise |

## Dépannage

Chaque réponse contient un `requestId`. Si une requête échoue, communiquez ce `requestId` à l'[équipe d'assistance Octoparse](mailto:support@octoparse.com) afin de faciliter le diagnostic.
