रास्तों की जानकारी देने के लिए एपीआई कुंजियों का इस्तेमाल करें

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

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

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

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

एपीआई कुंजियां बनाई जा रही हैं

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

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

Console

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 का सुझाव है कि आप अपनी एपीआई कुंजियों के इस्तेमाल को सिर्फ़ उन एपीआई तक सीमित करें जो आपके ऐप्लिकेशन के लिए ज़रूरी हैं. API कुंजियों को प्रतिबंधित करने से आपके ऐप्लिकेशन को अनचाहे अनुरोधों से बचाकर उसे और भी सुरक्षित बनाया जाता है. ज़्यादा जानकारी के लिए, एपीआई की सुरक्षा से जुड़े सबसे सही तरीके देखें.

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

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

Console

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

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

2. वह एपीआई पासकोड चुनें जिस पर पाबंदी सेट करनी है. एपीआई पासकोड प्रॉपर्टी का पेज दिखेगा.
3. मुख्य पाबंदियां में जाकर, ये पाबंदियां सेट करें:
• ऐप्स प्रतिबंध:
1. आपकी ओर से दिए गए वेब सर्वर के आईपी पतों की सूची से अनुरोध स्वीकार करने के लिए, ऐप्लिकेशन पर पाबंदियों की सूची से आईपी पते (वेब सर्वर, क्रॉन जॉब वगैरह) चुनें. एक या एक से ज़्यादा IPv4 या IPv6 पते या सीआईडीआर नोटेशन का इस्तेमाल करके सबनेट बताएं. आईपी पते, Google Maps Platform के सर्वर में बताए गए सोर्स पते से मेल खाने चाहिए. नेटवर्क एड्रेस ट्रांसलेशन (एनएटी) का इस्तेमाल करने पर, यह आम तौर पर आपकी मशीन के सार्वजनिक आईपी पते से जुड़ा होगा.
• एपीआई से जुड़ी पाबंदियां:
1. कुंजी पर पाबंदी लगाएं पर क्लिक करें.
2. एपीआई चुनें ड्रॉपडाउन में से, रोड एपीआई चुनें. अगर रोड्स एपीआई सूची में नहीं है, तो आपको उसे चालू करना होगा.
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="roads.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

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

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

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

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

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