Skip to main content
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.

Créer ou gérer les clés API

Ouvrez la page des clés API dans votre centre de compte Octoparse.
Les clés API commencent généralement par op_sk_ :
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.
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 :
Flux d’une tâche existante :
Vous découvrez AgentTools ? Consultez le tutoriel complet du flux de travail 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.
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.

​
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 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 :
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 :
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.

​
Dépannage

Chaque réponse contient un requestId. Si une requête échoue, communiquez ce requestId à l’équipe d’assistance Octoparse afin de faciliter le diagnostic.