सुरक्षित ब्राउज़िंग लुकअप एपीआई (v4)

खास जानकारी

lookup API, आपके क्लाइंट ऐप्लिकेशन को सुरक्षित ब्राउज़िंग की सुविधा को अनुरोध भेजने की सुविधा देता है सर्वर का इस्तेमाल करके यह जांच सकते हैं कि किसी सुरक्षित ब्राउज़िंग सूची में यूआरएल शामिल हैं या नहीं. अगर कोई यूआरएल किसी साइट पर पाया जाता है या और सूचियां बनाते हैं, तो मेल खाने वाली जानकारी दी जाती है.

यूआरएल की जांच की जा रही है

यह देखने के लिए कि कोई यूआरएल सुरक्षित ब्राउज़िंग की सूची में है या नहीं, उस यूआरएल पर एचटीटीपी POST अनुरोध भेजें threatMatches.find तरीका:

• एचटीटीपी POST अनुरोध में 500 यूआरएल शामिल किए जा सकते हैं. यूआरएल मान्य होने चाहिए (आरएफ़सी 2396 देखें) लेकिन उन्हें कैननिकल या कोड में बदलने की ज़रूरत नहीं होती.
• एचटीटीपी POST रिस्पॉन्स, कैश मेमोरी की अवधि के साथ मिलते-जुलते यूआरएल दिखाता है.

उदाहरण: audienceMatches.find

एचटीटीपी पोस्ट अनुरोध

नीचे दिए गए उदाहरण में, दो सुरक्षित ब्राउज़िंग सूचियां और तीन यूआरएल सर्वर को तय करते हैं कि कोई मैच है या नहीं.

अनुरोध का हेडर

अनुरोध के हेडर में अनुरोध का यूआरएल और कॉन्टेंट का टाइप शामिल होता है. स्थानापन्न इस्तेमाल करना याद रखें यूआरएल में API_KEY के लिए आपकी एपीआई कुंजी.

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

अनुरोध का मुख्य भाग

अनुरोध में क्लाइंट की जानकारी (आईडी और वर्शन) और खतरे के बारे में जानकारी शामिल होती है (सूची के नाम और यूआरएल). ज़्यादा जानकारी के लिए, यह देखें threatMatches.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/"}
      ]
    }
  }

क्लाइंट की जानकारी

clientID और clientVersion फ़ील्ड में, क्लाइंट लागू करने के तरीके की खास तौर पर पहचान की जानी चाहिए, न कि एक अलग उपयोगकर्ता है. (क्लाइंट की जानकारी का इस्तेमाल, सर्वर साइड लॉगिंग और अकाउंटिंग के लिए किया जाता है. आपके पास ये विकल्प हैं: लेकिन हमारा सुझाव है कि आप क्लाइंट आईडी के लिए कोई ऐसा नाम चुनें जो क्लाइंट, जैसे आपकी कंपनी का नाम, अंग्रेज़ी के छोटे अक्षर में, एक शब्द के रूप में दिखाया जाता है.)

सुरक्षित ब्राउज़िंग की सूचियां

threatType, platformType, और threatEntryType फ़ील्ड को (नाम) सुरक्षित ब्राउज़िंग सूचियों की पहचान करने के लिए जोड़ा जाता है. इस उदाहरण में, दो सूचियों की पहचान की गई है: MALWARE/WINDOWS/यूआरएल और SOCIAL_ सोची. अनुरोध भेजने से पहले, पक्का करें कि आपके दिए गए कॉम्बिनेशन मान्य होंगे (सुरक्षित ब्राउज़िंग की सूचियां देखें).

धमकाने वाले यूआरएल

इस उदाहरण में, threatEntries कलेक्शन में तीन यूआरएल शामिल हैं (urltocheck1.org, urltocheck2.org, और urltocheck3.org) दोनों ही सुरक्षित ब्राउज़िंग की सूचियों से जांच की जाएगी.

ध्यान दें: lookup API और threatMatches तरीके को हमेशा URL फ़ील्ड का इस्तेमाल करना चाहिए, hash फ़ील्ड को कभी नहीं देखें (ThreatEntry देखें).

एचटीटीपी पीओएसटी रिस्पॉन्स

नीचे दिए गए उदाहरण में, रिस्पॉन्स मैच दिखाता है; यूआरएल की पुष्टि करने के लिए, अनुरोध, अनुरोध में बताई गई दो सुरक्षित ब्राउज़िंग सूचियों में से किसी एक में मिलता है.

रिस्पॉन्स हेडर

रिस्पॉन्स हेडर में एचटीटीपी स्टेटस कोड शामिल होता है और कॉन्टेंट किस तरह का है.

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

जवाब का मुख्य भाग

जवाब के मुख्य हिस्से में, मैच होने वाली जानकारी शामिल होती है. जैसे, सूची के नाम और यूआरएल वे सूचियां, मेटाडेटा, और कैश मेमोरी का कुल समय). ज़्यादा जानकारी के लिए, यह देखें threatMatches.find जवाब का मुख्य हिस्सा और वे एक्सप्लेनेशंस भी होंगे जो कोड वाले उदाहरण के मुताबिक होंगे.

ध्यान दें: अगर कोई मिलान नहीं होता है (इसका मतलब है कि अगर दिए गए यूआरएल में से कोई नहीं है अगर अनुरोध में बताई गई किसी सूची में बताया गया है), तो एचटीटीपी 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 फ़ील्ड में जानकारी देना ज़रूरी नहीं है. यह इस बारे में ज़्यादा जानकारी देता है खतरा कम हो जाता है. फ़िलहाल, मेटाडेटा मैलवेयर/Windows/यूआरएल की सुरक्षित ब्राउज़िंग सूची के लिए उपलब्ध है (मेटाडेटा देखें).

कैश मेमोरी की अवधि

cacheDuration फ़ील्ड से पता चलता है कि यूआरएल को कितने समय के लिए असुरक्षित माना जाना चाहिए (कैशिंग देखें).