Skip to main content

はじめに

同期スクリーンショット

screenshot エンドポイントはブラウザセッションを実行し、base64 エンコードされた画像を JSON で返します — プログラム連携や API Tester に最適です。

非同期ジョブ

jobs エンドポイントはスクリーンショットタスクをキューに入れ、ステータスと結果をポーリングできます — 大量処理や遅いページに最適です。

REST アーキテクチャ

ウェブサイトスクリーンショット API は REST 原則に従い、予測可能なリソース指向 URL と標準 HTTP ステータスコードでシームレスな統合とエラー処理を実現します。

HTTPS セキュリティ

すべての API 通信は TLS 1.2 以上で保護され、データの完全性とプライバシーを確保します。

API バージョニング

ウェブサイトスクリーンショット API はバージョニングにより後方互換性を維持し、現在 Version 1 で稼働しています。

認証

API キーはウェブサイトスクリーンショット API へアクセスする唯一の認証情報です。Cleariflow の各サービスには固有のキーが必要です。JSON ボディに api_key として含めるか、レガシー GET エンドポイントではクエリパラメータとして渡してください。

ベース URL

ページレンダリング

ページは実際のヘッドレスブラウザでレンダリングされます。スクリーンショット取得前に JavaScript が完全に実行されます。組み込みの SSRF 保護により、localhost やプライベート IP 範囲へのリクエストはブロックされます。

レスポンスおよびエラーコード

リクエストが失敗した場合、API は効果的なトラブルシューティングのための特定のコードと説明を含む構造化 JSON エラーレスポンスを返します。