एयर क्वालिटी एपीआई के साथ एपीआई पासकोड इस्तेमाल करना

Google Maps Platform के प्रॉडक्ट को एपीआई कॉल पर पाबंदी लगाकर, उन्हें बिना अनुमति के इस्तेमाल किए जाने से सुरक्षित रखा जाता है उनसे पुष्टि करने के लिए सही क्रेडेंशियल दें. ये क्रेडेंशियल इस तरह के होते हैं: API कुंजी - अक्षरों और अंकों से बनी एक यूनीक स्ट्रिंग होती है जो आपके Google बिलिंग खाते को प्रोजेक्ट में शामिल किया जा सकता है. साथ ही, एपीआई या SDK टूल का भी इस्तेमाल किया जा सकता है.

इस गाइड में Google Maps Platform के लिए एपीआई पासकोड बनाने, उस पर पाबंदी लगाने, और उसे इस्तेमाल करने का तरीका बताया गया है.

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

एपीआई पासकोड बनाना

एपीआई पासकोड ऐसा यूनीक आइडेंटिफ़ायर होता है जो आपके प्रोजेक्ट से जुड़े अनुरोधों की पुष्टि करता है इस्तेमाल और बिलिंग के मकसद से. आपके पास अपने प्रोजेक्ट के साथ कम से कम एक एपीआई पासकोड होना ज़रूरी है.

एपीआई पासकोड बनाने के लिए:

कंसोल

  1. Google Maps Platform > क्रेडेंशियल पेज पर जाएं.

    क्रेडेंशियल पेज पर जाएं

  2. क्रेडेंशियल पेज पर, क्रेडेंशियल बनाएं > API पासकोड.
    एपीआई पासकोड बनाया गया डायलॉग, आपकी नई बनाई गई एपीआई पासकोड दिखाता है.
  3. बंद करें पर क्लिक करें.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है नई एपीआई कुंजी, क्रेडेंशियल पेज पर एपीआई पासकोड में मौजूद है.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है एपीआई पर पाबंदी लगाना न भूलें कुंजी का इस्तेमाल करें.)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

यहां दी गई, Google Cloud SDK टूल , Cloud SDK टूल इंस्टॉल करना , और ये निर्देश दिए जा सकते हैं:

एपीआई पासकोड पर पाबंदी लगाना

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

किसी एपीआई पासकोड पर पाबंदी लगाने के लिए:

कंसोल

  1. Google Maps Platform > क्रेडेंशियल पेज पर जाएं.

    क्रेडेंशियल पेज पर जाएं

  2. वह एपीआई पासकोड चुनें जिस पर पाबंदी सेट करनी है. आपको एपीआई पासकोड प्रॉपर्टी पेज दिखेगा.
  3. मुख्य पाबंदियां में जाकर, इन पाबंदियों को सेट करें:
    • ऐप्लिकेशन से जुड़ी पाबंदियां:
      1. आपने जो वेब सर्वर आईपी पते दिए हैं उनकी सूची से अनुरोधों को स्वीकार करने के लिए, सूची में से IP पते (वेब सर्वर, क्रॉन जॉब वगैरह) ऐप्लिकेशन से जुड़ी पाबंदियां. एक या उससे ज़्यादा आईपीवी4 या आईपीवी6 पता बताएं, या सबनेट का इस्तेमाल सीआईडीआर नोटेशन का इस्तेमाल करके किया जा सकता है. IP पते, Google Maps Platform के सर्वर निगरानी करते हैं. अगर आपको नेटवर्क पते का अनुवाद (NAT), यह आम तौर पर आपकी मशीन के सार्वजनिक आईपी पते से जुड़ा होता है.
    • एपीआई से जुड़ी पाबंदियां:
      1. कुंजी पर पाबंदी लगाएं पर क्लिक करें.
      2. Select API ड्रॉपडाउन से Air Quality API चुनें. अगर Air Quality API सूची में नहीं है, तो आपको चालू करें.
  4. अपने बदलावों को पूरा करने के लिए, सेव करें पर क्लिक करें.

Cloud SDK

मौजूदा कुंजियों की सूची बनाएं. 

gcloud services api-keys list --project="PROJECT"

मौजूदा कुंजी पर लागू पाबंदियां हटाएं. 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

मौजूदा कुंजी पर नई पाबंदियां सेट करें. 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="airquality.googleapis.com"
    --allowed-ips="IP_ADDRESS"

यहां दी गई, Google Cloud SDK टूल , Cloud SDK टूल इंस्टॉल करना , और ये निर्देश दिए जा सकते हैं:

अपने अनुरोध में एपीआई पासकोड जोड़ना

आपको हर Air Quality API अनुरोध के साथ एक एपीआई पासकोड शामिल करना होगा. नीचे दिए गए उदाहरण में, YOUR_API_KEY को अपनी एपीआई कुंजी से बदलें.

https://airquality.googleapis.com/v1/currentConditions:lookup?key=YOUR_API_KEY

एचटीटीपीएस, एपीआई पासकोड का इस्तेमाल करने वाले अनुरोधों के लिए ज़रूरी है.