क्विकस्टार्ट उस ऐप्लिकेशन को सेट अप करने और चलाने का तरीका बताता है जो Google Workspace API को कॉल करता है.
Google Workspace क्विकस्टार्ट, पुष्टि करने और अनुमति देने की प्रोसेस से जुड़ी कुछ जानकारी को मैनेज करने के लिए, एपीआई क्लाइंट लाइब्रेरी का इस्तेमाल करता है. हमारा सुझाव है कि आप अपने ऐप्लिकेशन के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल करें. यह क्विकस्टार्ट, पुष्टि करने के आसान तरीके का इस्तेमाल करता है. यह टेस्ट एनवायरमेंट के लिए सही है. प्रोडक्शन एनवायरमेंट के लिए, हमारा सुझाव है कि अपने ऐप्लिकेशन के लिए सही ऐक्सेस क्रेडेंशियल चुनने से पहले, पुष्टि करने और अनुमति देने के बारे में जानें.
ऐसा JavaScript वेब ऐप्लिकेशन बनाएं जो Google Classroom एपीआई से अनुरोध करता हो.
मकसद
- अपना एनवायरमेंट सेट अप करें.
- सैंपल सेट अप करें.
- सैंपल चलाएं.
ज़रूरी शर्तें
- Node.js और npm इंस्टॉल किए गए.
- Google Cloud प्रोजेक्ट.
- आपके पास एक Google for Education खाता होना चाहिए, जिसमें Google Classroom की सुविधा चालू हो.
अपना एनवायरमेंट सेट अप करें
इस क्विकस्टार्ट को पूरा करने के लिए, अपना एनवायरमेंट सेट अप करें.
एपीआई चालू करें
Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. किसी एक Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.Google Cloud कंसोल में, Google Classroom एपीआई को चालू करें.
उस स्क्रीन को कॉन्फ़िगर करना जहां OAuth के लिए सहमति दी जाती है
अगर इस क्विकस्टार्ट को पूरा करने के लिए, किसी नए Google Cloud प्रोजेक्ट का इस्तेमाल किया जा रहा है, तो OAuth के लिए सहमति देने वाली स्क्रीन को कॉन्फ़िगर करें और खुद को टेस्ट उपयोगकर्ता के तौर पर जोड़ें. अगर आपने अपने Cloud प्रोजेक्ट के लिए यह चरण पहले ही पूरा कर लिया है, तो अगले सेक्शन पर जाएं.
- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन पर जाएं.
- उपयोगकर्ता टाइप के लिए, अंदरूनी चुनें. इसके बाद, बनाएं पर क्लिक करें.
- ऐप्लिकेशन रजिस्ट्रेशन फ़ॉर्म भरें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.
फ़िलहाल, दायरों को छोड़कर आगे बढ़ा जा सकता है. साथ ही, सेव करें और जारी रखें पर क्लिक करें. आने वाले समय में, जब अपने Google Workspace संगठन से बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाया जाएगा, तो आपको उपयोगकर्ता टाइप को बाहरी उपयोगकर्ता में बदलना होगा. इसके बाद, आपको अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति के दायरे जोड़ने होंगे.
- अपने ऐप्लिकेशन रजिस्ट्रेशन की खास जानकारी देखें. बदलाव करने के लिए, बदलाव करें पर क्लिक करें. अगर ऐप्लिकेशन रजिस्ट्रेशन ठीक लग रहा है, तो डैशबोर्ड पर वापस जाएं पर क्लिक करें.
किसी वेब ऐप्लिकेशन के लिए क्रेडेंशियल की अनुमति देना
असली उपयोगकर्ताओं की पुष्टि करने और अपने ऐप्लिकेशन में उपयोगकर्ता का डेटा ऐक्सेस करने के लिए, आपको एक या उससे ज़्यादा OAuth 2.0 क्लाइंट आईडी बनाने होंगे. Client-ID का इस्तेमाल, Google के OAuth सर्वर पर किसी एक ऐप्लिकेशन की पहचान करने के लिए किया जाता है. अगर आपका ऐप्लिकेशन एक से ज़्यादा प्लैटफ़ॉर्म पर चलता है, तो आपको हर प्लैटफ़ॉर्म के लिए अलग-अलग क्लाइंट आईडी बनाना होगा.- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
- ऐप्लिकेशन का टाइप > वेब ऐप्लिकेशन पर क्लिक करें.
- नाम फ़ील्ड में, क्रेडेंशियल के लिए नाम लिखें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
- अपने ऐप्लिकेशन से जुड़े अनुमति वाले यूआरआई जोड़ें:
- क्लाइंट-साइड ऐप्लिकेशन (JavaScript)–अनुमति वाले JavaScript ऑरिजिन में जाकर, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, ब्राउज़र के अनुरोधों के लिए यूआरआई डालें. यह उन डोमेन की पहचान करता है जिनसे आपका ऐप्लिकेशन OAuth 2.0 सर्वर को एपीआई अनुरोध भेज सकता है.
- सर्वर-साइड ऐप्लिकेशन (Java, Python वगैरह)–अनुमति वाले रीडायरेक्ट यूआरआई में, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, एंडपॉइंट यूआरआई डालें जिस पर OAuth 2.0 सर्वर जवाब भेज सके.
- बनाएं पर क्लिक करें. अब OAuth क्लाइंट की स्क्रीन पर आपका नया क्लाइंट आईडी और क्लाइंट सीक्रेट दिखेगा.
Client-ID नोट करें. क्लाइंट सीक्रेट का इस्तेमाल वेब ऐप्लिकेशन के लिए नहीं किया जाता है.
- ठीक है पर क्लिक करें. नया क्रेडेंशियल, OAuth 2.0 Client ID में दिखता है.
इन क्रेडेंशियल को नोट कर लें, क्योंकि आपको बाद में इस क्विकस्टार्ट में उनकी ज़रूरत होगी.
एपीआई पासकोड बनाना
- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें.
- ऐसा करने पर, आपकी नई एपीआई कुंजी दिखेगी.
- एपीआई पासकोड को कॉपी करने के लिए, पर क्लिक करें, ताकि ऐप्लिकेशन के कोड में उसका इस्तेमाल किया जा सके. एपीआई पासकोड, आपके प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी देखा जा सकता है.
- बेहतर सेटिंग को अपडेट करने और अपनी एपीआई कुंजी के इस्तेमाल को सीमित करने के लिए, कुंजी पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड से जुड़ी पाबंदियां लागू करना लेख पढ़ें.
सैंपल सेट अप करना
- अपनी वर्किंग डायरेक्ट्री में,
index.html
नाम की एक फ़ाइल बनाएं. index.html
फ़ाइल में, यह सैंपल कोड चिपकाएं:इन्हें बदलें:
YOUR_CLIENT_ID
: वह क्लाइंट आईडी जो आपने किसी वेब ऐप्लिकेशन के लिए अनुमति वाले क्रेडेंशियल बनाते समय बनाया था.YOUR_API_KEY
: वह एपीआई पासकोड जिसे आपने ज़रूरी शर्त के तौर पर बनाया है.
सैंपल चलाएं
अपनी वर्किंग डायरेक्ट्री में, http-server पैकेज इंस्टॉल करें:
npm install http-server
अपनी वर्किंग डायरेक्ट्री में, कोई वेब सर्वर शुरू करें:
npx http-server -p 8000
- अपने ब्राउज़र में,
http://localhost:8000
पर जाएं. -
आपको ऐक्सेस की अनुमति देने का अनुरोध दिखेगा:
- अगर आपने अपने Google खाते में पहले से साइन इन नहीं किया है, तो मांगे जाने पर साइन इन करें. अगर आपने एक से ज़्यादा खातों में साइन इन किया हुआ है, तो अनुमति देने के लिए एक खाता चुनें.
- स्वीकार करें पर क्लिक करें.
आपका JavaScript ऐप्लिकेशन, Google Classroom एपीआई को चलाता और कॉल करता है.
अगले चरण
- पुष्टि करने और अनुमति देने से जुड़ी समस्याओं को हल करना
- Classroom API के रेफ़रंस के लिए दस्तावेज़
- GitHub का
google-api-javascript-client
सेक्शन