Places API के साथ एपीआई पासकोड का इस्तेमाल करना

प्लैटफ़ॉर्म चुनें: Android iOS JavaScript वेब सेवा

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

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

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

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

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

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

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

कंसोल

  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. एपीआई चुनें ड्रॉपडाउन से, Places API या Places API (नया) में से किसी एक को चुनें, न कि दोनों को. अगर Places API या Places API (नया) सूची में नहीं है, तो आपको इसे चालू करना होगा.
  4. अपने बदलावों को लागू करने के लिए, सेव करें पर क्लिक करें.

Cloud SDK

Places API (नया प्रॉडक्ट)

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

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=places.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

Places API

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

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=places-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

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

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

https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY

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