अपना पहला क्लाइंट ऐप्लिकेशन कोड करने से पहले, कुछ ऐसी चीज़ें हैं जिन्हें करना ज़रूरी है. खास तौर पर, जब आपने उन्हें पहले से नहीं किया हो.
Google खाता पाएं
Google API Console में प्रोजेक्ट बनाने के लिए, आपके पास Google खाता होना चाहिए. अगर आपके पास पहले से कोई खाता है, तो आप इसे इस्तेमाल करने के लिए तैयार हैं.
आपको जांच के लिए, अलग Google खाते की ज़रूरत भी पड़ सकती है.
Google Street View आज़माएं
इस एपीआई के दस्तावेज़ में यह माना गया है कि आपने Google Street View का इस्तेमाल किया है. साथ ही, आपको वेब प्रोग्रामिंग के कॉन्सेप्ट और वेब डेटा फ़ॉर्मैट के बारे में जानकारी है.
अगर आपने Google Street View का इस्तेमाल नहीं किया है, तो कोडिंग शुरू करने से पहले यूज़र इंटरफ़ेस पर जाकर इसे आज़माएं.
अपने क्लाइंट के लिए प्रोजेक्ट बनाना
Google Street View को अनुरोध भेजने के लिए यह ज़रूरी है कि आप पहले Google को अपने क्लाइंट के बारे में बताएं. साथ ही, एपीआई इस्तेमाल करने की सुविधा चालू करें. ऐसा Google API Console से प्रोजेक्ट बनाने के लिए किया जाता है. यह सेटिंग और एपीआई के इस्तेमाल की जानकारी वाले ग्रुप का एक नाम है. साथ ही, अपना ऐप्लिकेशन रजिस्टर करें.
Google Street View Publish API का इस्तेमाल शुरू करने से पहले, आपको सेटअप टूल इस्तेमाल करना होगा. यह आपको Google API Console में प्रोजेक्ट बनाने और एपीआई की सुविधा चालू करने के बारे में जानकारी देता है.
अगर आपने अब तक ऐसा नहीं किया है, तो क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करके, अपने ऐप्लिकेशन के लिए एपीआई पासकोड बनाएं. इसके बाद, एपीआई पासकोड सेक्शन में जाकर अपना एपीआई पासकोड ढूंढें.
REST के बारे में बुनियादी बातें जानें
एपीआई को दो तरीकों से इस्तेमाल किया जा सकता है:
- एचटीटीपी अनुरोध भेजना और जवाबों को पार्स करना.
- क्लाइंट लाइब्रेरी का इस्तेमाल करके.
अगर आपको क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करना है, तो आपके पास REST के बारे में बुनियादी जानकारी होनी चाहिए.
REST, सॉफ़्टवेयर आर्किटेक्चर का एक स्टाइल है. यह डेटा में बदलाव करने और डेटा का अनुरोध करने का आसान और एक जैसा तरीका उपलब्ध कराता है.
"Representational State Transfer" को कम शब्दों में REST कहते हैं. Google APIs के संदर्भ में, इसका मतलब Google के पास सेव किए गए डेटा को वापस पाने और उसमें बदलाव करने के लिए, एचटीटीपी वर्ब का इस्तेमाल करना है.
RESTful सिस्टम में, रिसॉर्स को डेटा स्टोर में सेव किया जाता है. क्लाइंट, सर्वर को ऐसा अनुरोध भेजता है कि वह कोई खास कार्रवाई करे. जैसे, किसी रिसॉर्स बनाना, वापस पाना, अपडेट करना या मिटाना. इसके बाद, सर्वर कार्रवाई करता है और जवाब भेजता है. यह जवाब अक्सर, बताए गए रिसॉर्स के तौर पर होता है.
Google के RESTful API में, क्लाइंट किसी कार्रवाई के लिए एचटीटीपी वर्ब का इस्तेमाल करता है. जैसे, POST, GET, PUT या DELETE. यह इस फ़ॉर्म में मौजूद, दुनिया भर में पहचाने जाने वाले यूआरआई के ज़रिए किसी रिसॉर्स के बारे में बताता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों के पास एचटीटीपी से ऐक्सेस किए जा सकने वाले यूआरआई होते हैं. इसलिए, REST से डेटा को कैश मेमोरी में सेव किया जा सकता है. साथ ही, इसे वेब के डिस्ट्रिब्यूटेड इंफ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 के स्टैंडर्ड के दस्तावेज़ में, मेथड की परिभाषाएं मिल सकती हैं. इनमें GET, POST, PUT, और DELETE के लिए खास जानकारी शामिल है.
Google Street View Publish API में REST
Google Street View Publish API के ऑपरेशन, सीधे तौर पर REST एचटीटीपी वर्ब से मैप होते हैं.
Google Street View Publish API के यूआरआई के लिए ये फ़ॉर्मैट इस्तेमाल किए जाते हैं:
https://www.googleapis.com/streetviewpublish/v1/resourcePath?parameters
एपीआई में काम करने वाली हर कार्रवाई के लिए इस्तेमाल किए गए यूआरआई के पूरे सेट की खास जानकारी, Google Street View Publish API के रेफ़रंस वाले दस्तावेज़ में दी गई है.
JSON के बारे में बुनियादी बातें जानें
Google Street View Publish API, डेटा को JSON फ़ॉर्मैट में दिखाता है.
JSON (JavaScript Object Notation) एक सामान्य डेटा फ़ॉर्मैट है. यह किसी भी भाषा पर निर्भर नहीं करता. यह किसी भी डेटा स्ट्रक्चर को टेक्स्ट के तौर पर दिखाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.