अपने पहले क्लाइंट ऐप्लिकेशन के लिए कोडिंग शुरू करने से पहले, आपको ये काम करने होंगे के लिए वे सभी काम जो आपको करने होंगे.
अपने क्लाइंट के लिए प्रोजेक्ट बनाना
अनुरोध भेजने से पहले, आपको Google को अपने क्लाइंट के बारे में बताना होगा. साथ ही, एपीआई का ऐक्सेस चालू करना होगा. ऐसा करने के लिए, Google API कंसोल का इस्तेमाल करके प्रोजेक्ट बनाया जा सकता है, जो कि एक नाम वाला कलेक्शन होता है और अपना ऐप्लिकेशन रजिस्टर करें.
Android Over The Air API का इस्तेमाल शुरू करने के लिए, आपको इस्तेमाल करें सेटअप टूल की मदद से, सेटअप टूल की मदद ली जा सकती है. Google API (एपीआई) कंसोल, एपीआई चालू करना, और क्रेडेंशियल बनाना.
प्रोजेक्ट को व्हाइटलिस्ट करें
Android Over The Air API सिर्फ़ वे प्रोजेक्ट के लिए उपलब्ध है जिन्हें अनुमति मिली हुई है. अगर आपके प्रोजेक्ट को अनुमति नहीं मिली है,
आपको इसका इस्तेमाल करने की कोशिश में 404
गड़बड़ियां मिलेंगी.
अगर आपको अनुमति मिल जाए, तो अपने Google TAM को ईमेल भेजकर अपने नए प्रोजेक्ट आईडी को अनुमति वाली सूची में शामिल करें.
प्रोजेक्ट आईडी आपके Cloud डैशबोर्ड में मिल सकता है. ज़्यादा जानकारी के लिए, यह सहायता दस्तावेज़ देखें.
ध्यान दें कि प्रोजेक्ट आईडी आम तौर पर इस फ़ॉर्मैट {company}-gota-api-{number} पर होना चाहिए
अनुमति मिल जाने के बाद, अपने प्रोजेक्ट के लिए Android Over The Air API चालू करें और देखें इसे ऐक्सेस करने की जानकारी के लिए, अनुमति देने का तरीका देखें.
ध्यान दें कि सिर्फ़ आपका दिया हुआ प्रोजेक्ट आईडी ही Android Over The Air API का इस्तेमाल कर पाएगा. बुध एपीआई का इस्तेमाल करने के लिए, सेवा खाता बनाने का सुझाव दिया जाता है (जैसा कि अनुमति में बताया गया है) ध्यान देने की ज़रूरत है.
Android Over The Air Dashboard आज़माएं
इस एपीआई दस्तावेज़ में यह माना गया है कि आपने Android Over The Air Dashboard का इस्तेमाल किया है. साथ ही, आपको वेब प्रोग्रामिंग के सिद्धांतों और वेब डेटा के फ़ॉर्मैट के बारे में जानकारी है.
अगर आपने Android Over The Air Dashboard इस्तेमाल नहीं किया है, तो कोड बनाने से पहले यूज़र इंटरफ़ेस आज़माएं.
REST के बारे में बुनियादी बातें जानें
एपीआई को शुरू करने के दो तरीके हैं:
- एचटीटीपी अनुरोध भेजना और जवाब पार्स करना.
- क्लाइंट लाइब्रेरी का इस्तेमाल करना.
अगर आपने क्लाइंट लाइब्रेरी का इस्तेमाल न करने का फ़ैसला किया है, तो आपको आरईएसटी की बुनियादी बातें जाननी होंगी.
REST, सॉफ़्टवेयर आर्किटेक्चर की एक स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने के लिए, आसान और एक जैसा तरीका उपलब्ध कराती है.
REST शब्द "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" का छोटा रूप है. Google API के संदर्भ में, यह Google के सेव किए गए डेटा को दिखाने और उसमें बदलाव करने के लिए एचटीटीपी क्रियाओं का इस्तेमाल करता है.
RESTful सिस्टम में, संसाधनों को डेटा स्टोर में सेव किया जाता है; जब कोई क्लाइंट अनुरोध भेजता है कि सर्वर कोई खास कार्रवाई करता है (जैसे कि संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना), तो सर्वर कार्रवाई करता है और रिस्पॉन्स भेजता है. यह रिस्पॉन्स, अक्सर बताए गए संसाधन के बारे में बताता है.
Google के RESTful एपीआई में, क्लाइंट एचटीटीपी कार्रवाई के बारे में बताता है, जैसे कि POST
, GET
, PUT
या DELETE
. यह ऐसे संसाधन के बारे में बताता है जो नीचे दिए गए फ़ॉर्म के, दुनिया भर में मौजूद यूनीक यूआरआई की मदद से मिलता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों में, एचटीटीपी से ऐक्सेस किए जा सकने वाले यूनीक यूआरआई होते हैं. इसलिए, REST डेटा कैश करने की सुविधा को चालू करती है. साथ ही, उसे वेब के डिस्ट्रिब्यूटेड इन्फ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 स्टैंडर्ड वाले दस्तावेज़ में तरीका की परिभाषाएं काम की लग सकती हैं; उनमें GET
, POST
, PUT
, और DELETE
के लिए खास जानकारी शामिल होती है.
Android Over The Air API में आराम से जाएं
Android Over The Air API कार्रवाइयां सीधे REST एचटीटीपी कार्रवाइयों पर मैप होती हैं.
Android Over The Air API के यूआरआई के लिए खास फ़ॉर्मैट ये हैं:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
एपीआई में काम करने वाली हर कार्रवाई के लिए इस्तेमाल किए जाने वाले यूआरआई के पूरे सेट की खास जानकारी Android Over The Air API रेफ़रंस दस्तावेज़ में दी गई है.
JSON के बारे में बुनियादी बातें जानें
Android Over The Air API, JSON फ़ॉर्मैट में डेटा दिखाता है.
JSON (JavaScript ऑब्जेक्ट नोटेशन), आम तौर पर भाषा पर आधारित डेटा फ़ॉर्मैट है. यह आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट में आसान तरीके से दिखाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.