クライアントサイド統合 - クライアントスパイダーAPI

APIには clientSpider というAPIプレフィックスを介してアクセスできます。

ビュー

• status (scanId*): スパイダースキャンのステータスを取得します。 現在の進行状況を示す0から100までの整数を返します。

アクション

• scan (browser url contextName userName subtreeOnly maxCrawlDepth pageLoadTime numberOfBrowsers scopeCheck): 指定されたURLやコンテキストに対してクライアントスパイダーを実行します。 スキャンIDを返します。
• stop (scanId*): クライアントスパイダースキャンを停止します。

パラメーター

• browser: スキャンに使用するブラウザ、例: 'firefox-headless'。 指定されていない場合は、Firefox Headlessが使用されます。
• url: スキャンを開始するURL。 指定されておらずコンテキストが設定されている場合は、コンテキスト内の最初のURLが使用されます。
• contextName: スキャンするコンテキストの名前。
• userName: スキャンを実行するユーザーの名前。 ユーザーは指定されたコンテキストに存在する必要があります。
• subtreeOnly: 'true' に設定されている場合、スパイダーは指定されたURLの下のURLのみをスキャンします。 デフォルト: 'false'
• maxCrawlDepth: スパイダーがクロールする最大深度。0は無制限を意味します。 デフォルトはクライアントオプションです。
• pageLoadTime: ページの読み込み待機時間 (秒単位)。 デフォルトはクライアントオプションです。
• numberOfBrowsers: 開くブラウザウィンドウの数 (同時実行数)。 整数値。デフォルトはクライアントオプションの設定値です。
• scopeCheck: スコープチェックモード。FLEXIBLE (デフォルト) またはSTRICTのいずれか。
• scanId: 照会または管理するスキャンのID。

例

スキャンの開始：

https://zap/JSON/clientSpider/action/scan/?url=https://example.com&maxCrawlDepth=5&pageLoadTime=30&numberOfBrowsers=1&scopeCheck=STRICT

ステータスの確認：

https://zap/JSON/clientSpider/view/status/?scanId=1

スキャンの停止：

https://zap/JSON/clientSpider/action/stop/?scanId=1