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