Safe Browsing Lookup API (第 4 版)

總覽

Lookup API 可讓用戶端應用程式將要求傳送至安全瀏覽功能 伺服器,檢查網址是否已加入安全瀏覽清單。如果系統在 Google 新聞 如果需要更多清單,則會傳回相符的資訊。

正在檢查網址

如要檢查某個網址是否列在「安全瀏覽」清單中,請將 HTTP POST 要求傳送至 threatMatches.find 方法:

  • HTTP POST 要求最多可包含 500 個網址。網址必須是有效網址 (請參閱 RFC 2396)。 但不必採用標準化或編碼
  • HTTP POST 回應會傳回相符的網址以及快取持續時間。

例如: Threat 比對.find

HTTP POST 要求

在以下範例中,系統會將兩份安全瀏覽清單和三個網址傳送至伺服器, 檢查是否有相符項目

要求標頭

要求標頭包含要求網址和內容類型。記得更換 網址中 API_KEY 的 API 金鑰。

  POST https://safebrowsing.googleapis.com/v4/threatMatches:find?key=API_KEY HTTP/1.1
  Content-Type: application/json
  

要求主體

要求主體包含用戶端資訊 (ID 和版本) 和威脅資訊 (名單名稱和網址)。詳情請參閱 threatMatch.find 要求主體 以及本程式碼範例的說明

  {
    "client": {
      "clientId":      "yourcompanyname",
      "clientVersion": "1.5.2"
    },
    "threatInfo": {
      "threatTypes":      ["MALWARE", "SOCIAL_ENGINEERING"],
      "platformTypes":    ["WINDOWS"],
      "threatEntryTypes": ["URL"],
      "threatEntries": [
        {"url": "http://www.urltocheck1.org/"},
        {"url": "http://www.urltocheck2.org/"},
        {"url": "http://www.urltocheck3.com/"}
      ]
    }
  }
客戶資訊

clientIDclientVersion 欄位應是用來識別用戶端實作項目,而非 。(用戶端資訊會用於伺服器端記錄和會計作業;您可以選擇 或用戶端 ID 的任何名稱,但建議選用能夠代表其真實身分的名稱

安全瀏覽清單

threatTypeplatformTypethreatEntryType 欄位 會結合識別 (名稱)「安全瀏覽」清單。本例中有兩個清單: 惡意軟體/WINDOWS/URL 和 SOCIAL_ENGINEERING/WINDOWS/URL。傳送要求前,請確認所需類型 有效的組合 (請參閱安全瀏覽清單)。

威脅網址

在這個例子中,threatEntries 陣列包含三個網址 (urltocheck1.org、urltocheck2.org、 和 urltocheck3.org),用於檢查兩份安全瀏覽清單。

注意:Lookup API 和 threatMatches 方法應一律使用 URL 欄位。 一律為 hash 欄位 (請參閱 ThreatEntry)。

HTTP POST 回應

在以下範例中,回應會傳回相符項目。指定範本中的兩個 該要求會出現在要求中指定的兩份「安全瀏覽」清單之一。

回應標頭

回應標頭包含 HTTP 狀態碼 以及內容類型

HTTP/1.1 200 OK
Content-Type: application/json

回應主體

回應主體會包含比對資訊 (清單名稱和網址 這些清單、中繼資料 (如有) 以及快取持續時間)。詳情請參閱 threatMatch.find 回應主體 以及本程式碼範例的說明

注意:如果找不到相符項目 (也就是說,如果指定的網址「沒有任何」) 出現在要求中指定的「任何」清單中),HTTP POST 回應就會傳回回應 只會在回應主體中傳回空白物件。

{
  "matches": [{
    "threatType":      "MALWARE",
    "platformType":    "WINDOWS",
    "threatEntryType": "URL",
    "threat":          {"url": "http://www.urltocheck1.org/"},
    "threatEntryMetadata": {
      "entries": [{
        "key": "malware_threat_type",
        "value": "landing"
     }]
    },
    "cacheDuration": "300.000s"
  }, {
    "threatType":      "MALWARE",
    "platformType":    "WINDOWS",
    "threatEntryType": "URL",
    "threat":          {"url": "http://www.urltocheck2.org/"},
    "threatEntryMetadata": {
      "entries": [{
        "key":   "malware_threat_type",
        "value": "landing"
     }]
    },
    "cacheDuration": "300.000s"
  }]
}
相符

matches 物件會列出安全瀏覽清單的名稱和網址 (如果 「 」中有符合。在本例中,系統在其中一個網址 (urltocheck1.org 和 urltocheck2.org) 找到兩個網址: 安全瀏覽清單 (MALWARE/WINDOWS/URL),以便傳回相符的資訊。第三個網址 (urltocheck3.org) 都找不到,因此這個網址不會傳回任何資訊。

中繼資料

threatEntryMetadata 為選填欄位,並提供有關 威脅比對。目前,中繼資料是否可供 MALWARE/WINDOWS/URL 安全瀏覽清單提供 請參閱「中繼資料」。

快取持續時間

cacheDuration 欄位表示系統將網址視為不安全的時間長度。 (請參閱快取)。