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

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

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

शुरू करने से पहले

Directions API का इस्तेमाल शुरू करने से पहले, आपके पास बिलिंग खाते वाला एक प्रोजेक्ट होना चाहिए. साथ ही, Directions API चालू होना चाहिए. ज़्यादा जानने के लिए, Cloud Console में सेट अप करना लेख पढ़ें.

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

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

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

कंसोल

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

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

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

Cloud SDK

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

Google Cloud SDK , Cloud SDK इंस्टॉल करने , और इन कमांड के बारे में ज़्यादा जानें:

एपीआई कुंजियों पर पाबंदी लगाना

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

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

कंसोल

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

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

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

Cloud SDK

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

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

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

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

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

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=directions-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

Google Cloud SDK , Cloud SDK इंस्टॉल करने , और इन कमांड के बारे में ज़्यादा जानें:

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

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

https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY

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