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

खास जानकारी

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

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

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

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

उदाहरण: धमकी Matches.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 फ़ील्ड से, लागू किए गए क्लाइंट की पहचान खास तौर पर की जानी चाहिए, न कि किसी उपयोगकर्ता की. (क्लाइंट की जानकारी का इस्तेमाल, सर्वर-साइड में लॉग इन करने और अकाउंटिंग के लिए किया जाता है. Client-ID के लिए कोई भी नाम चुना जा सकता है. हालांकि, हमारा सुझाव है कि आप ऐसा नाम चुनें जो क्लाइंट की असली पहचान दिखाता हो. जैसे, आपकी कंपनी का नाम, जिसे अंग्रेज़ी के छोटे अक्षरों में लिखा गया हो.

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

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

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

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

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

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

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

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

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

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 ऑब्जेक्ट, सुरक्षित ब्राउज़िंग सूचियों और यूआरएल के नाम दिखाता है. इस उदाहरण में, सुरक्षित ब्राउज़िंग की किसी एक सूची (MALWARE/WINDOWS/URL) पर दो यूआरएल (urltocheck1.org और urltocheck2.org) पाए गए थे, इसलिए मिलती-जुलती जानकारी दी गई थी. तीसरा यूआरएल (urltocheck3.org) किसी भी सूची में नहीं मिला था, इसलिए इस यूआरएल के लिए कोई जानकारी नहीं मिली.

मेटाडेटा

threatEntryMetadata फ़ील्ड का इस्तेमाल करना ज़रूरी नहीं है. इससे खतरे के मैच के बारे में ज़्यादा जानकारी मिलती है. फ़िलहाल, मेटाडेटा, मैलवेयर/Windows/यूआरएल सुरक्षित ब्राउज़िंग सूची के लिए उपलब्ध है (मेटाडेटा देखें).

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

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