使用 Evaluate API

本頁面說明如何使用 Evaluate API,讓用戶端應用程式評估網址的惡意程度。這項 API 會根據封鎖清單、機器學習模型和啟發式規則,傳回表示網址惡意程度的信心評分。如要取得二進位結果,而非信賴度分數,請使用 Lookup API

注意:提交至 Evaluate API 的網址可能會經過額外處理,包括檢索。

事前準備

如要使用這項功能,請與銷售團隊或客戶工程師聯絡。

評估網址

如要評估網址,請對 evaluateUri 方法發出 HTTP POST 要求。評估網址時,請瞭解下列注意事項:

  • Evaluate API 每個要求支援一個網址。如要檢查多個網址,請為每個網址分別提出要求。
  • 網址必須有效,且不必經過正規化。詳情請參閱 RFC 2396
  • Evaluate API 支援三種 threatTypes:SOCIAL_ENGINEERING、MALWARE 和 UNWANTED_SOFTWARE。
  • 已淘汰,系統會使用 allow_scan 欄位,判斷 Web Risk 是否可掃描提供的網址。您無法再透過 Evaluate API 停用這項功能。如需免除檢索的選項,請參閱 LookupUpdate API。
  • HTTP POST 回應會傳回指定 threatType 的可信度分數。信賴度分數代表信賴水準,指出指定網址的風險程度。

API 要求

使用任何要求資料之前,請先替換以下項目:

URL:需要評估的網址。

HTTP 方法和網址:

POST https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY

JSON 要求主體:

{
  "uri": "URL",
  "threatTypes": ["SOCIAL_ENGINEERING", "MALWARE", "UNWANTED_SOFTWARE"]
}

如要傳送要求,請選擇以下其中一個選項:

curl

將要求主體儲存在名為 request.json 的檔案中,然後執行下列指令:

curl -X POST \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY"

PowerShell

將要求主體儲存在名為 request.json 的檔案中,然後執行下列指令:

$headers = @{  }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY" | Select-Object -Expand Content

您應該會收到如下的 JSON 回應:

{
  "scores": [
    {
      "threatType": "MALWARE",
      "confidenceLevel": "EXTREMELY_HIGH"
    },
    {
      "threatType": "SOCIAL_ENGINEERING",
      "confidenceLevel": "SAFE"
    },
    {
      "threatType": "UNWANTED_SOFTWARE",
      "confidenceLevel": "SAFE"
    }
  ]
}