Skip to main content
Octoparse OpenAPIを使うと、タスクの管理、クラウド抽出の実行、スクレイピングデータの取得をプログラムから行えます。

​
認証

保護されたエンドポイントでは、Octoparse APIキーを使用するのが最も簡単です。Octoparseアカウントセンターでキーを作成し、リクエストのx-api-keyヘッダーに指定します。同じAPIキーをOctoparse OpenAPI、MCP Server、CLIで使用できます。

APIキーを作成・管理する

OctoparseアカウントセンターのAPIキーページを開きます。
APIキーは通常op_sk_で始まります。
APIキーは秘密情報として管理してください。ブラウザ側のコード、公開リポジトリ、スクリーンショット、ログに含めないでください。
アクセストークン認証も利用できます。POST /tokenでアクセストークンを取得し、Authorization: Bearer <access_token>として送信してください。

​
AgentTools API

AgentTools APIは、従来のTask API、Cloud Extraction API、Data APIの上に構築された、テンプレート主導のAIエージェント向けワークフローレイヤーです。適切なスクレイピングテンプレートを探し、実行を開始し、サーバーが返す次のアクションに沿って処理を進め、エクスポート情報を取得したい場合に適しています。 新規スクレイピングの基本フロー:
既存タスクを扱う基本フロー:
AgentToolsを初めて使う場合は、エンドツーエンドのワークフローチュートリアルで、テンプレート検索から実行、エクスポートまでの流れを確認できます。 AgentToolsの業務データはdataに含まれます。requestIdはトラブルシューティング用です。ポーリング間隔を固定せず、retryGuidance、suggestedNextCall、workflow、toolHintに従って処理を進めてください。
AgentTools APIではx-api-key認証が必須です。一部のエンドポイントではx-external-user-idも必要です。必要なヘッダーは各エンドポイントのリファレンスを確認してください。

​
ご利用前の確認

Octoparse OpenAPIを利用するには、スタンダード、プロフェッショナル、エンタープライズのいずれかのプランで、稼働可能なタスクが少なくとも1つ必要です。アカウントをお持ちでない場合はこちらから登録できます。 現在のAPIバージョン: v1.0

​
ベースURL

すべてのリクエストは、次のベースURLに対して送信します。
プレースホルダーは{xxxx}で表記されており、実際の値に置き換えて使用します。たとえば、タスク検索のリクエストURLは次のとおりです。
taskGroupIdがabcの場合、URLはhttps://openapi.octoparse.com/task/search?taskGroupId=abcになります。

​
レート制限

Octoparse APIの利用上限は1秒あたり20リクエストです。429ステータスコードが返された場合は、リクエスト頻度を下げてください。 成功時のHTTPステータスコードは200です。それ以外のステータスについては、各エンドポイントのリファレンスを確認してください。

​
利用可能なプラン

各サービスを利用するには、対応するプランが必要です。利用できない場合は、プランのアップグレードをご検討ください。

​
トラブルシューティング

すべてのレスポンスにはrequestIdが含まれます。リクエストが失敗した場合は、requestIdをOctoparseサポートチームに共有すると、原因調査に役立ちます。