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

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

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

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

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

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

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

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

कंसोल

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

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

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

Cloud SDK

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

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

• gcloud alpha services api-keys create

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

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

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

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

कंसोल

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 alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

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

gcloud alpha 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 टूल इंस्टॉल करने , और इन निर्देशों के बारे में ज़्यादा पढ़ें:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

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

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

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

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

ध्यान दें: वेब सेवाओं का इस्तेमाल करते समय, पैरामीटर में मौजूद सभी खास वर्णों को कोड में बदलना ज़रूरी है. यूआरएल मान्य होने के लिए, उन्हें सही तरीके से कोड में बदला जाना चाहिए. साथ ही, सभी वेब सेवाओं के लिए यूआरएल में 2048 से ज़्यादा वर्ण नहीं होने चाहिए. यूआरएल बनाते समय इस सीमा का ध्यान रखें. अलग-अलग ब्राउज़र, प्रोक्सी, और सर्वर के लिए, यूआरएल में वर्णों की सीमा भी अलग-अलग हो सकती है.