はじめに
クイックスタート
API キーを作成し、Webサイト監査を実行して結果を読みます。5分、SDK は不要です。
最初のスキャンを実行
- 1
API キーを作成
API キーを開いて作成します。すべてのプランに1つ含まれ、無料キーは無料の月間上限を共有します。 - 2
環境変数に保存
キーは sk_live_ で始まります。コードやリポジトリに含めないでください。shellexport SCANVERRA_API_KEY="sk_live_..."
- 3
リクエストを送信
Webサイト監査は完成したレポートを待つため、レスポンスがそのまま結果です。30〜90秒かかります。curl -X POST https://www.scanverra.com/api/audit \ -H "X-API-Key: $SCANVERRA_API_KEY" \ -H "Content-Type: application/json" \ -d '{"url":"https://example.com"}' - 4
レスポンスを読む
まずはこのフィールドから:performanceScore0〜100。seoScore、accessibilityScore、bestPracticesScore もあります。issues問題点。それぞれに重大度と説明があります。fixesScanverra が検出したスタック向けの修正方法。reportIdアプリの /report/:reportId で同じレポートを開けます。
キーは
X-API-Key: sk_live_... または Authorization: Bearer で送信します。パスワードと同じように扱ってください。キーを持つ人は誰でもあなたのプランでスキャンを実行できます。漏洩したキーは API キーのページで無効にしてください。