क्विकस्टार्ट में, Google Workspace API को कॉल करने वाले ऐप्लिकेशन को सेट अप करने और चलाने का तरीका बताया गया है.
पुष्टि करने और अनुमति देने के फ़्लो की कुछ जानकारी मैनेज करने के लिए, Google Workspace क्विकस्टार्ट एपीआई क्लाइंट लाइब्रेरी का इस्तेमाल करता है. हमारा सुझाव है कि आप अपने ऐप्लिकेशन के लिए क्लाइंट लाइब्रेरी का इस्तेमाल करें. यह क्विकस्टार्ट, पुष्टि करने के आसान तरीके का इस्तेमाल करता है, जो टेस्ट एनवायरमेंट के लिए सही है. हमारा सुझाव है कि प्रोडक्शन एनवायरमेंट के लिए, अपने ऐप्लिकेशन के लिए सही ऐक्सेस क्रेडेंशियल चुनने से पहले, पुष्टि करने और अनुमति देने के बारे में जानें.
ऐसा JavaScript वेब ऐप्लिकेशन बनाएं जो People API के लिए अनुरोध करता हो.
मकसद
- अपना एनवायरमेंट सेट अप करें.
- सैंपल सेट अप करें.
- सैंपल चलाएं.
ज़रूरी शर्तें
- Node.js और npm इंस्टॉल किए गए.
- Google Cloud प्रोजेक्ट.
- Google Workspace डोमेन, जिसमें एपीआई का ऐक्सेस चालू हो.
- उस डोमेन में एडमिन के अधिकारों वाला Google खाता.
अपना एनवायरमेंट सेट अप करें
इस क्विकस्टार्ट को पूरा करने के लिए, अपना एनवायरमेंट सेट अप करें.
इस एपीआई को चालू करें
Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. किसी एक Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.Google Cloud Console में, People API को चालू करें.
उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है
अगर इस क्विकस्टार्ट को पूरा करने के लिए किसी नए Google Cloud प्रोजेक्ट का इस्तेमाल किया जा रहा है, तो OAuth के लिए सहमति वाली स्क्रीन कॉन्फ़िगर करें और खुद को टेस्ट उपयोगकर्ता के तौर पर जोड़ें. अगर आपने अपने Cloud प्रोजेक्ट के लिए यह चरण पहले ही पूरा कर लिया है, तो सीधे अगले सेक्शन पर जाएं.
- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > OAuth की सहमति वाली स्क्रीन पर जाएं.
- उपयोगकर्ता टाइप के लिए इंटरनल चुनें. इसके बाद, बनाएं पर क्लिक करें.
- ऐप्लिकेशन रजिस्ट्रेशन फ़ॉर्म भरें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें.
फ़िलहाल, दायरों को जोड़ना स्किप किया जा सकता है. इसके बाद, सेव करें और जारी रखें पर क्लिक करें. आने वाले समय में, जब आप अपने Google Workspace संगठन से बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाते हैं, तो आपको उपयोगकर्ता टाइप को बदलकर एक्सटर्नल करना होगा. इसके बाद, अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति के दायरे जोड़ना होगा.
- अपने ऐप्लिकेशन रजिस्ट्रेशन की खास जानकारी देखें. बदलाव करने के लिए, बदलाव करें पर क्लिक करें. अगर ऐप्लिकेशन रजिस्ट्रेशन ठीक लगता है, तो डैशबोर्ड पर वापस जाएं पर क्लिक करें.
वेब ऐप्लिकेशन के लिए क्रेडेंशियल को अनुमति देना
असली उपयोगकर्ताओं की पुष्टि करने और अपने ऐप्लिकेशन में उपयोगकर्ता के डेटा को ऐक्सेस करने के लिए, आपको एक या उससे ज़्यादा OAuth 2.0 क्लाइंट आईडी बनाने होंगे. Google के OAuth सर्वर पर किसी एक ऐप्लिकेशन की पहचान करने के लिए, Client-ID का इस्तेमाल किया जाता है. अगर आपका ऐप्लिकेशन एक से ज़्यादा प्लैटफ़ॉर्म पर चलता है, तो आपको हर प्लैटफ़ॉर्म के लिए एक अलग क्लाइंट आईडी बनाना होगा.- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
- ऐप्लिकेशन टाइप > वेब ऐप्लिकेशन पर क्लिक करें.
- नाम फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम लिखें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
- अपने ऐप्लिकेशन से जुड़े, अनुमति वाले यूआरआई जोड़ें:
- क्लाइंट-साइड ऐप्लिकेशन (JavaScript)–अनुमति वाले JavaScript ऑरिजिन में जाकर, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, ब्राउज़र अनुरोधों के इस्तेमाल के लिए यूआरआई डालें. यह उन डोमेन की पहचान करता है जिनसे आपका ऐप्लिकेशन, OAuth 2.0 सर्वर को एपीआई अनुरोध भेज सकता है.
- सर्वर-साइड ऐप्लिकेशन (Java, Python वगैरह)–अनुमति वाले रीडायरेक्ट यूआरआई में जाकर, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, एंडपॉइंट यूआरआई डालें जिस पर OAuth 2.0 सर्वर जवाब भेज सके.
- बनाएं पर क्लिक करें. OAuth क्लाइंट की बनाई गई स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट सीक्रेट दिखेगा.
Client-ID नोट करें. वेब ऐप्लिकेशन के लिए क्लाइंट सीक्रेट का इस्तेमाल नहीं किया जाता.
- ठीक है पर क्लिक करें. नया क्रेडेंशियल, OAuth 2.0 क्लाइंट आईडी के तहत दिखता है.
इन क्रेडेंशियल को नोट कर लें, क्योंकि आपको इस क्विकस्टार्ट में बाद में इनकी ज़रूरत होगी.
एपीआई पासकोड बनाना
- Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.
- क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें.
- आपकी नई API (एपीआई) कुंजी दिखाई गई.
- एपीआई पासकोड को कॉपी करके, अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, पर क्लिक करें. एपीआई पासकोड, आपके प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
- बेहतर सेटिंग अपडेट करने और एपीआई पासकोड का सीमित इस्तेमाल करने के लिए, कुंजी पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड से जुड़ी पाबंदियां लागू करना लेख पढ़ें.
सैंपल सेट अप करना
- अपनी वर्किंग डायरेक्ट्री में,
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 ऐप्लिकेशन, People API को चलाता है और उसे कॉल करता है.
अगले चरण
- पुष्टि करने और अनुमति देने से जुड़ी समस्याओं को हल करना
- People API का रेफ़रंस दस्तावेज़
- GitHub का
google-api-javascript-client
सेक्शन