पते की पुष्टि करने वाले एपीआई की वेब सेवाओं को इस्तेमाल करने के सबसे सही तरीके

Google Maps Platform वेब सेवाएं, Google सेवाओं के लिए एचटीटीपी इंटरफ़ेस का संग्रह हैं, जो आपके मैप ऐप्लिकेशन के लिए भौगोलिक डेटा उपलब्ध कराती हैं.

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

वेब सेवा क्या है?

Google Maps Platform की वेब सेवाएं एक इंटरफ़ेस है. इसकी मदद से, बाहरी सेवाओं से Maps API डेटा पाने का अनुरोध किया जा सकता है. साथ ही, इस डेटा का इस्तेमाल Maps ऐप्लिकेशन में किया जा सकता है. इन सेवाओं को Google Maps Platform की सेवा की शर्तों में दिए गए लाइसेंस से जुड़ी पाबंदियों के मुताबिक मैप के साथ इस्तेमाल करने के लिए डिज़ाइन किया गया है.

Maps API वेब सेवाएं, खास यूआरएल पर एचटीटीपी या एचटीटीपीएस अनुरोधों का इस्तेमाल करती हैं. ऐसा करके, वे यूआरएल पैरामीटर और/या सेवाओं में आर्ग्युमेंट के तौर पर JSON-फ़ॉर्मैट का इस्तेमाल कर रहे पोस्ट डेटा को पास करती हैं. आम तौर पर, ये सेवाएं आपके ऐप्लिकेशन से पार्स और/या प्रोसेस करने के लिए, रिस्पॉन्स के मुख्य भाग में JSON के रूप में डेटा दिखाती हैं.

VerifyAddress तरीके का इस्तेमाल करके, एचटीटीपी POST अनुरोध भेजकर पते की पुष्टि करें:

https://addressvalidation.googleapis.com/v1:validateAddress

पुष्टि करने के लिए, पता तय करने के अनुरोध के लिए एक JSON का मुख्य भाग पास करें

ध्यान दें: पते की पुष्टि करने वाले सभी एपीआई ऐप्लिकेशन के लिए पुष्टि करना ज़रूरी है. पुष्टि करने के क्रेडेंशियल के बारे में ज़्यादा जानकारी पाएं.

एसएसएल/TLS ऐक्सेस

एचटीटीपीएस उन सभी Google Maps Platform अनुरोधों के लिए ज़रूरी है जो एपीआई कुंजियों का इस्तेमाल करते हैं या जिनमें उपयोगकर्ता डेटा शामिल होता है. एचटीटीपी पर किए गए ऐसे अनुरोध जिनमें संवेदनशील जानकारी शामिल होती है उन्हें अस्वीकार किया जा सकता है.

मान्य यूआरएल बनाना

आपको लग सकता है कि एक "मान्य" यूआरएल खुद ही साफ़ तौर पर दिख रहा है, लेकिन यह पूरी तरह से सही नहीं है. उदाहरण के लिए, किसी ब्राउज़र के पता बार में डाले गए यूआरएल में विशेष वर्ण हो सकते हैं (जैसे, "上海+中國"); ब्राउज़र को ट्रांसमिशन से पहले उन वर्णों को अंदरूनी तौर पर किसी दूसरी एन्कोडिंग में अनुवाद करना होगा. इसी टोकन से, UTF-8 इनपुट जनरेट करने या स्वीकार करने वाला कोई भी कोड, UTF-8 वर्णों वाले यूआरएल को "मान्य" मान सकता है. हालांकि, किसी वेब सर्वर पर भेजने से पहले, आपको उन वर्णों का अनुवाद भी करना होगा. इस प्रोसेस को यूआरएल-एन्कोडिंग या प्रतिशत-एन्कोडिंग कहा जाता है.

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

खास वर्ण

हमें खास वर्णों का अनुवाद करना होगा, क्योंकि सभी यूआरएल यूनिफ़ॉर्म रिसॉर्स आइडेंटिफ़ायर (यूआरआई) के बताए गए सिंटैक्स के मुताबिक होने चाहिए. इसका मतलब यह है कि यूआरएल में ASCII वर्णों का सिर्फ़ एक खास सबसेट शामिल होना चाहिए: जाने-पहचाने अक्षर और अंकों वाले सिंबल और यूआरएल में कंट्रोल कैरेक्टर के तौर पर इस्तेमाल करने के लिए, कुछ रिज़र्व किए गए वर्ण. इस टेबल में इन वर्णों को संक्षेप में बताया गया है:

सेट करें	वर्ण	यूआरएल का इस्तेमाल
अक्षर और अंक	ए बी सी डी एफ़ एफ़ जी एच आई जे के एल एम n o p q र स ट यू वी वी x वाय ज़ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 7 6 6	टेक्स्ट स्ट्रिंग, स्कीम इस्तेमाल (http), पोर्ट (8080) वगैरह.
गैर-आरक्षित	- _ . ~	टेक्स्ट स्ट्रिंग
बुकिंग की गई	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	वर्ण और/या टेक्स्ट स्ट्रिंग को कंट्रोल करें

एक मान्य यूआरएल बनाते समय, आपको यह पक्का करना होगा कि उसमें सिर्फ़ वे वर्ण शामिल हों जो मान्य यूआरएल वर्णों की खास जानकारी वाली टेबल में दिखाए गए हैं. वर्णों के इस सेट का इस्तेमाल करने के लिए एक यूआरएल बनाने पर आम तौर पर दो समस्याएं आती हैं, एक चूक और एक विकल्प बदलता है:

• आपको जिन वर्णों को मैनेज करना है वे ऊपर दिए गए सेट से बाहर मौजूद हैं. उदाहरण के लिए, 上海+中國 जैसी विदेशी भाषाओं के वर्णों को, ऊपर दिए गए वर्णों का इस्तेमाल करके कोड में बदलना होगा. आम तौर पर, स्पेस (जिनकी यूआरएल में अनुमति नहीं है) को अक्सर प्लस '+' वर्ण का इस्तेमाल करके भी दिखाया जाता है.
• ऊपर दिए गए सेट में, रिज़र्व किए गए वर्णों के तौर पर वर्ण मौजूद हैं, लेकिन इनका लिटरल तौर पर इस्तेमाल किया जाना चाहिए. उदाहरण के लिए, ? का इस्तेमाल यूआरएल में क्वेरी स्ट्रिंग की शुरुआत को दिखाने के लिए किया जाता है. अगर आपको स्ट्रिंग "? और मिस्टीरियन" का इस्तेमाल करना है, तो आपको '?' वर्ण को कोड में बदलना होगा.

यूआरएल कोड में बदले जाने वाले सभी वर्णों को उनके UTF-8 वर्ण से मिलते-जुलते '%' वर्ण और दो वर्ण वाले हेक्स मान का इस्तेमाल करके एन्कोड किया जाता है. उदाहरण के लिए, UTF-8 में 上海+中國 को %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B के तौर पर यूआरएल कोड में बदला जाएगा. स्ट्रिंग ? and the Mysterians को %3F+and+the+Mysterians या %3F%20and%20the%20Mysterians के तौर पर यूआरएल कोड में बदला जाएगा.

वे सामान्य वर्ण जिन्हें कोड में बदलने की ज़रूरत होती है

कोड में बदले जाने वाले कुछ सामान्य वर्ण इस तरह हैं:

असुरक्षित वर्ण	कोड में बदली गई वैल्यू
स्पेस	%20
"	%22
<	%3C
>	%3E
#	%23
%	%25
|	%7C

उपयोगकर्ता के इनपुट से मिले यूआरएल को बदलना कभी-कभी मुश्किल होता है. उदाहरण के लिए, कोई उपयोगकर्ता किसी पते को "5th&Main St." के रूप में दर्ज कर सकता है. आम तौर पर, आपको उपयोगकर्ता के इनपुट को लिटरल वर्ण मानते हुए अपने यूआरएल को उसके हिस्सों से बनाना चाहिए.

इसके अलावा, Google Maps Platform की सभी वेब सेवाओं और स्टैटिक वेब एपीआई के लिए, यूआरएल में ज़्यादा से ज़्यादा 16384 वर्ण हो सकते हैं. ज़्यादातर सेवाओं के लिए, इस वर्ण सीमा तक शायद ही कभी पहुंचा जाए. हालांकि, ध्यान दें कि कुछ सेवाओं में कई पैरामीटर होते हैं जिनकी वजह से यूआरएल लंबे हो सकते हैं.

Google API का आसान इस्तेमाल

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

एक्सपोनेंशियल बैकऑफ़

बहुत कम मामलों में ऐसा हो सकता है कि आपका अनुरोध पूरा करने में किसी तरह की गड़बड़ी हो. आपको 4XX या 5XX का एचटीटीपी रिस्पॉन्स कोड मिल सकता है. इसके अलावा, यह भी हो सकता है कि टीसीपी कनेक्शन, आपके क्लाइंट और Google के सर्वर के बीच में कहीं फ़ेल हो जाए. अक्सर फिर से अनुरोध करना फ़ायदेमंद होता है, क्योंकि फ़ॉलोअप का अनुरोध तब कामयाब हो सकता है, जब मूल अनुरोध पूरा नहीं हो पाया. हालांकि, यह महत्वपूर्ण है कि Google के सर्वर से बार-बार अनुरोध न करें. लूप के इस तरीके का इस्तेमाल करने से, आपके क्लाइंट और Google के बीच का नेटवर्क ओवरलोड हो सकता है. इससे, कई पक्षों को समस्याएं आ सकती हैं.

बेहतर तरीका यह है कि कोशिश करने के बीच में देरी करके फिर से कोशिश करें. आम तौर पर, हर बार कोशिश करने पर यह देरी एक गुणांक के फ़ैक्टर से बढ़ जाती है. इस अप्रोच को एक्सपोनेंशियल बैकऑफ़ कहा जाता है.

उदाहरण के लिए, उस ऐप्लिकेशन पर विचार करें जो टाइम ज़ोन एपीआई को यह अनुरोध करना चाहता है:

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

Python के इस उदाहरण में, एक्स्पोनेंशियल बैकऑफ़ के साथ अनुरोध करने का तरीका बताया गया है:

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

आपको इस बात का भी ध्यान रखना चाहिए कि ऐप्लिकेशन कॉल चेन में ऐसा कोई फिर से कोशिश न करें जो बार-बार अनुरोध करता हो.

सिंक किए गए अनुरोध

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

उदाहरण के लिए, कोई ऐसा ऐप्लिकेशन इस्तेमाल करें जो मौजूदा टाइम ज़ोन में समय दिखाता हो. यह ऐप्लिकेशन शायद क्लाइंट ऑपरेटिंग सिस्टम में, इसे मिनट की शुरुआत में चालू करके अलार्म सेट कर देगा, ताकि दिखने वाला समय अपडेट किया जा सके. ऐप्लिकेशन को उस अलार्म से जुड़ी प्रोसेसिंग के तहत, कोई एपीआई कॉल नहीं करना चाहिए.

किसी तय अलार्म के जवाब में एपीआई कॉल करना अच्छा नहीं होता, क्योंकि इससे एपीआई कॉल, अलग-अलग डिवाइसों के बीच भी, मिनट की शुरुआत में ही सिंक किए जाते हैं. अगर खराब तरीके से डिज़ाइन किया गया कोई ऐप्लिकेशन ऐसा करता है, तो यह हर मिनट की शुरुआत में ट्रैफ़िक को सामान्य लेवल से साठ गुना बढ़ा देगा.

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

मिनट की शुरुआत के अलावा, सिंक करने के दूसरे सामान्य समय जिन्हें आपको टारगेट न करना चाहिए, वे एक घंटे की शुरुआत से हैं. इसी तरह, हर दिन की शुरुआत आधी रात से होती है.

जवाब प्रोसेस किए जा रहे हैं

ध्यान दें: जैसा कि वेब सेवा के अनुरोध के साथ हर जवाब के लिए, सटीक फ़ॉर्मैट की गारंटी नहीं दी जाती (हो सकता है कि कुछ एलिमेंट मौजूद न हों या एक से ज़्यादा जगहों पर मौजूद हों), आपको यह कभी नहीं मानना चाहिए कि किसी जवाब के लिए दिया गया फ़ॉर्मैट, अलग-अलग क्वेरी के लिए एक ही होगा. इसके बजाय, आपको जवाब को प्रोसेस करना चाहिए और एक्सप्रेशन की मदद से सही वैल्यू चुनना चाहिए.

इस सेक्शन में, वेब सेवा जवाबों से डाइनैमिक तौर पर इन वैल्यू को निकालने के तरीके के बारे में बताया गया है.

Google Maps की वेब सेवाएं ऐसे जवाब देती हैं जिन्हें समझना आसान होता है, लेकिन ये उपयोगकर्ताओं के लिए एकदम आसान नहीं होते. डेटा का सेट दिखाने के बजाय क्वेरी करते समय, हो सकता है कि आप कुछ खास वैल्यू निकालना चाहें. आम तौर पर, आप वेब सेवा से मिलने वाले जवाबों को पार्स करना चाहेंगे और सिर्फ़ अपनी पसंद की वैल्यू एक्सट्रैक्ट करना चाहेंगे.

पार्स करने की जिस स्कीम का इस्तेमाल किया जाता है वह इस बात पर निर्भर करती है कि JSON में आउटपुट दिखाया जा रहा है या नहीं. JSON रिस्पॉन्स, जो पहले से ही JavaScript ऑब्जेक्ट के रूप में होते हैं, उन्हें क्लाइंट पर JavaScript में ही प्रोसेस किया जा सकता है.