Skip to main content
Verwenden Sie die Octoparse OpenAPI, um Aufgaben zu verwalten, Cloud-Extraktionen auszuführen und gescrapte Daten programmgesteuert abzurufen.

​
Authentifizierung

Für geschützte Endpunkte ist ein Octoparse-API-Schlüssel die einfachste Authentifizierungsmethode. Erstellen Sie im Octoparse-Kontocenter einen Schlüssel und fügen Sie ihn in den Anfrage-Header x-api-key ein. Derselbe API-Schlüssel kann mit Octoparse OpenAPI, MCP Server und CLI verwendet werden.

API-Schlüssel erstellen oder verwalten

Öffnen Sie die Seite für API-Schlüssel in Ihrem Octoparse-Kontocenter.
API-Schlüssel beginnen üblicherweise mit op_sk_:
Halten Sie Ihren API-Schlüssel geheim. Legen Sie ihn nicht in browserseitigem Code, öffentlichen Repositorys, Screenshots oder Protokollen offen.
Die Authentifizierung mit Zugriffstoken wird ebenfalls unterstützt. Rufen Sie über POST /token ein Zugriffstoken ab und senden Sie es als Authorization: Bearer <access_token>.

​
AgentTools API

Die AgentTools API ist eine vorlagengesteuerte Workflow-Ebene für KI-Agenten über den bisherigen Low-Level-APIs für Aufgaben, Cloud-Extraktion und Daten. Verwenden Sie sie, wenn ein Agent oder eine Automatisierung eine geeignete Scraping-Vorlage finden, einen Lauf starten, den vom Server bereitgestellten Anweisungen für den nächsten Schritt folgen und Exportmetadaten abrufen soll, ohne jeden Low-Level-Endpunkt einzeln zu verknüpfen. Neuer Scraping-Ablauf:
Ablauf für bestehende Aufgaben:
Neu bei AgentTools? Lesen Sie das vollständige Workflow-Tutorial, um zu erfahren, wie Sie Vorlagen suchen, eine Aufgabe starten und Ergebnisse exportieren. AgentTools-Antworten enthalten Geschäftsfelder innerhalb von data. Verwenden Sie requestId nur zur Fehlerbehebung und folgen Sie retryGuidance, suggestedNextCall, workflow und toolHint, statt Abfrageintervalle fest zu codieren.
Die AgentTools API erfordert eine Authentifizierung mit x-api-key. Einige Endpunkte erfordern außerdem x-external-user-id; die genauen Header finden Sie in der jeweiligen Endpunktreferenz.

​
Voraussetzungen

Für die Octoparse OpenAPI benötigen Sie ein Standard-, Professional- oder Enterprise-Konto mit mindestens einer funktionsfähigen Aufgabe. Registrieren Sie sich hier, falls Sie noch kein Konto besitzen. Aktuelle API-Version: v1.0

​
Basis-URL

Alle Anfragen müssen für die Basis-URL URL-codiert sein:
Platzhalter werden als {xxxx} dargestellt und müssen durch echte Werte ersetzt werden. Die Anfrage-URL für Aufgabe suchen lautet beispielsweise:
Wenn Ihre Aufgabengruppen-ID abc lautet, wird daraus https://openapi.octoparse.com/task/search?taskGroupId=abc.

​
Ratenbegrenzungen

Octoparse begrenzt die API-Nutzung auf 20 Anfragen pro Sekunde. Wenn Sie den Statuscode 429 erhalten, reduzieren Sie Ihre Anfragerate. Eine erfolgreiche Antwort gibt HTTP 200 zurück. Informationen zu anderen Statuscodes finden Sie im Abschnitt Referenzen des jeweiligen Endpunkts.

​
Berechtigungen

Stellen Sie sicher, dass Ihr Konto zur Nutzung des jeweiligen Dienstes berechtigt ist. Führen Sie andernfalls ein Upgrade Ihres Kontos durch.

​
Fehlerbehebung

Jede Antwort enthält eine requestId. Wenn eine Anfrage fehlschlägt, teilen Sie die requestId dem Octoparse-Supportteam mit, um die Diagnose zu erleichtern.