OAuth लिंकिंग टाइप, दो इंडस्ट्री स्टैंडर्ड वाले OAuth 2.0 फ़्लो के साथ काम करता है. इनमें इंप्लिसिट और ऑथराइज़ेशन कोड फ़्लो शामिल है.
इंप्लिसिट कोड फ़्लो में, Google, उपयोगकर्ता के ब्राउज़र में ऑथराइज़ेशन एंडपॉइंट दिखाता है. साइन इन करने के बाद, Google को लंबे समय तक चलने वाला ऐक्सेस टोकन दिखाया जाता है. यह ऐक्सेस टोकन अब Assistant से आपकी कार्रवाई को किए गए हर अनुरोध में शामिल किया गया है.
ऑथराइज़ेशन कोड फ़्लो में, आपको दो एंडपॉइंट की ज़रूरत होगी:
- ऑथराइज़ेशन एंडपॉइंट, जो उन उपयोगकर्ताओं के साइन-इन यूज़र इंटरफ़ेस (यूआई) को दिखाने के लिए ज़िम्मेदार है जिन्होंने पहले से साइन इन नहीं किया है. साथ ही, उपयोगकर्ता को कुछ समय तक इस्तेमाल किए जाने वाले ऑथराइज़ेशन कोड के तौर पर ऐक्सेस का अनुरोध करने के लिए सहमति लेनी होती है.
- टोकन एक्सचेंज एंडपॉइंट, दो तरह के एक्सचेंज के लिए ज़िम्मेदार है:
- लंबे समय तक चलने वाले रीफ़्रेश टोकन और कुछ समय तक चलने वाले ऐक्सेस टोकन के लिए ऑथराइज़ेशन कोड बदलता है. यह एक्सचेंज तब होता है, जब उपयोगकर्ता, खाता जोड़ने के फ़्लो से गुज़रता है.
- वह कम समय तक चलने वाले ऐक्सेस टोकन के लिए, लंबे समय तक चलने वाले रीफ़्रेश टोकन की अदला-बदली करता है. यह ऐसा तब होता है, जब Google को नए ऐक्सेस टोकन की ज़रूरत होती है, क्योंकि उसकी समयसीमा खत्म हो चुकी होती है.
इंप्लिसिट कोड फ़्लो को लागू करना आसान है. हालांकि, Google का सुझाव है कि इंप्लिसिट फ़्लो का इस्तेमाल करके जारी किए गए ऐक्सेस टोकन की समयसीमा कभी खत्म न हो. ऐसा इसलिए, क्योंकि इंप्लिसिट फ़्लो वाले टोकन एंडपॉइंट का इस्तेमाल करने से, उपयोगकर्ता को अपने खाते को फिर से जोड़ने के लिए मजबूर कर दिया जाता है. अगर आपको सुरक्षा से जुड़ी वजहों से टोकन की समयसीमा खत्म होने की ज़रूरत है, तो आपको इसके बजाय ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करना चाहिए.
OAuth खाता जोड़ने की प्रोसेस को लागू करना
प्रोजेक्ट कॉन्फ़िगर करें
OAuth खाता जोड़ने के लिए, अपना प्रोजेक्ट कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं:
- Actions Console खोलें और वह प्रोजेक्ट चुनें जिसका आपको इस्तेमाल करना है.
- डेवलप करें टैब पर क्लिक करें और खाता लिंक करना चुनें.
- खाता लिंक करना के बगल में मौजूद स्विच को चालू करें.
- खाता बनाना सेक्शन में, नहीं, मुझे सिर्फ़ अपनी वेबसाइट पर खाता बनाने की अनुमति देनी है चुनें.
लिंक करने का टाइप में, OAuth और Implicit चुनें.
क्लाइंट की जानकारी में:
- Google से आने वाले अनुरोधों की पहचान करने के लिए, Google Actions से जारी किए गए Client-ID के लिए कोई वैल्यू असाइन करें.
- अपने ऑथराइज़ेशन और टोकन एक्सचेंज एंडपॉइंट के यूआरएल डालें.
- सेव करें पर क्लिक करें.
अपना OAuth सर्वर लागू करना
OAuth 2.0 इंप्लिसिट फ़्लो की सुविधा के लिए, आपकी सेवा, एचटीटीपीएस से अनुमति देने वाला एक एंडपॉइंट उपलब्ध कराती है. यह एंडपॉइंट, डेटा ऐक्सेस करने के लिए उपयोगकर्ताओं की सहमति की पुष्टि करने और उन्हें स्वीकार करने के लिए ज़िम्मेदार है. ऑथराइज़ेशन एंडपॉइंट, आपके उन उपयोगकर्ताओं को साइन-इन यूज़र इंटरफ़ेस (यूआई) दिखाता है जिन्होंने पहले से साइन इन नहीं किया है. साथ ही, अनुरोध किए गए ऐक्सेस के लिए सहमति रिकॉर्ड करता है.
जब आपकी सेट की गई कार्रवाई को आपकी सेवा के किसी अनुमति वाले एपीआई को कॉल करना होता है, तो Google इस एंडपॉइंट का इस्तेमाल आपके उपयोगकर्ताओं से अनुमति लेने के लिए करता है, ताकि वे इन एपीआई को उनकी ओर से कॉल कर सकें.
Google जो सामान्य OAuth 2.0 इंप्लिसिट फ़्लो सेशन शुरू करता है उसमें यह फ़्लो होता है:
- Google, उपयोगकर्ता के ब्राउज़र में आपका ऑथराइज़ेशन एंडपॉइंट खोलता है. अगर उपयोगकर्ता ने पहले से साइन इन नहीं किया है, तो वह साइन इन करता है. साथ ही, अगर उपयोगकर्ता ने पहले से अनुमति नहीं दी है, तो वह Google को आपके एपीआई से अपना डेटा ऐक्सेस करने की अनुमति देता है.
- आपकी सेवा एक ऐक्सेस टोकन बनाती है और उपयोगकर्ता के ब्राउज़र को अनुरोध से अटैच किए गए ऐक्सेस टोकन के साथ, उपयोगकर्ता के ब्राउज़र को वापस Google पर रीडायरेक्ट करके उसे Google पर वापस भेज देती है.
- Google आपकी सेवा के एपीआई को कॉल करता है और हर अनुरोध के साथ ऐक्सेस टोकन अटैच करता है. आपकी सेवा पुष्टि करती है कि ऐक्सेस टोकन Google को एपीआई ऐक्सेस करने की अनुमति देता है या नहीं. इसके बाद, वह एपीआई कॉल पूरा करता है.
अनुमति के अनुरोधों को मैनेज करना
जब आपकी सेट की गई कार्रवाई को किसी OAuth2 इंप्लिसिट फ़्लो के ज़रिए खाता लिंक करने की ज़रूरत होती है, तो Google उपयोगकर्ता को आपके ऑथराइज़ेशन एंडपॉइंट पर एक अनुरोध भेजता है. इस अनुरोध में, ये पैरामीटर शामिल होते हैं:
ऑथराइज़ेशन एंडपॉइंट पैरामीटर | |
---|---|
client_id |
वह क्लाइंट आईडी जो आपने Google को असाइन किया है. |
redirect_uri |
वह यूआरएल जिस पर इस अनुरोध का जवाब भेजा जाता है. |
state |
हिसाब-किताब की ऐसी वैल्यू जिसे रीडायरेक्ट करने वाले यूआरआई में, Google को वापस भेजा जाता है. इसमें कोई बदलाव नहीं होता. |
response_type |
रिस्पॉन्स में दी जाने वाली वैल्यू का टाइप. OAuth 2.0 इंप्लिसिट फ़्लो के लिए, रिस्पॉन्स का टाइप हमेशा token होता है. |
उदाहरण के लिए, अगर आपका ऑथराइज़ेशन एंडपॉइंट https://myservice.example.com/auth
पर उपलब्ध है,
तो अनुरोध ऐसा दिख सकता है:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
आपका ऑथराइज़ेशन एंडपॉइंट, साइन इन करने के अनुरोधों को मैनेज कर सके, इसके लिए यह तरीका अपनाएं:
अनचाहे या गलत तरीके से कॉन्फ़िगर किए गए क्लाइंट ऐप्लिकेशन को ऐक्सेस देने से रोकने के लिए,
client_id
औरredirect_uri
वैल्यू की पुष्टि करें:- पक्का करें कि
client_id
, Google को असाइन किए गए आपके क्लाइंट आईडी से मेल खाता हो. - पक्का करें कि
redirect_uri
पैरामीटर से दिए गए यूआरएल का फ़ॉर्म यह है:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID, Actions Console के प्रोजेक्ट सेटिंग पेज पर मौजूद आईडी है.
- पक्का करें कि
देखें कि उपयोगकर्ता ने आपकी सेवा में साइन इन किया हुआ है या नहीं. अगर उपयोगकर्ता ने साइन इन नहीं किया है, तो अपनी सेवा के साइन-इन या साइन-अप फ़्लो को पूरा करें.
ऐक्सेस टोकन जनरेट करें. Google इसका इस्तेमाल आपके एपीआई को ऐक्सेस करने के लिए करेगा. ऐक्सेस टोकन, किसी भी स्ट्रिंग की वैल्यू हो सकता है. हालांकि, यह खास तौर पर उस उपयोगकर्ता और क्लाइंट के बारे में बताना चाहिए जिसके लिए टोकन मौजूद है. साथ ही, इसका अंदाज़ा भी नहीं लगाया जा सकता.
ऐसा एचटीटीपी रिस्पॉन्स भेजें जो उपयोगकर्ता के ब्राउज़र को
redirect_uri
पैरामीटर से तय किए गए यूआरएल पर रीडायरेक्ट करे. यूआरएल फ़्रैगमेंट में ये सभी पैरामीटर शामिल करें:access_token
: आपने अभी-अभी ऐक्सेस टोकन जनरेट किया हैtoken_type
: स्ट्रिंगbearer
state
: मूल अनुरोध की स्थिति में कोई बदलाव नहीं की गई वैल्यू यहां मिलने वाले यूआरएल का एक उदाहरण दिया गया है:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Google के OAuth 2.0 रीडायरेक्ट हैंडलर को ऐक्सेस टोकन मिलेगा. साथ ही, यह पुष्टि करेगा कि state
वैल्यू में कोई बदलाव नहीं हुआ है. जब Google को आपकी सेवा के लिए ऐक्सेस टोकन मिल जाता है, तब Google इस टोकन को AppRequest के हिस्से के तौर पर आपकी सेट की गई कार्रवाई के बाद के कॉल में अटैच कर देगा.
पुष्टि करना शुरू करें
पुष्टि करने की प्रोसेस शुरू करने के लिए, खाता साइन-इन हेल्पर इंटेंट का इस्तेमाल करें. इन कोड स्निपेट में बताया गया है कि इस हेल्पर का इस्तेमाल करने के लिए, Dialogflow और Actions SDK टूल में जवाब कैसे भेजा जाता है.
डायलॉग फ़्लो:
const {dialogflow, SignIn} = require('actions-on-google'); const app = dialogflow({ // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT clientId: CLIENT_ID, }); // Intent that starts the account linking flow. app.intent('Start Signin', (conv) => { conv.ask(new SignIn('To get your account details')); });
@ForIntent("Start Signin") public ActionResponse text(ActionRequest request) { ResponseBuilder rb = getResponseBuilder(request); return rb.add(new SignIn().setContext("To get your account details")).build(); }
{ "payload": { "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "PLACEHOLDER" } } ] }, "userStorage": "{\"data\":{}}", "systemIntent": { "intent": "actions.intent.SIGN_IN", "data": { "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec", "optContext": "To get your account details" } } } }, "outputContexts": [ { "name": "/contexts/_actions_on_google", "lifespanCount": 99, "parameters": { "data": "{}" } } ] }
ऐक्शन SDK टूल:
const {actionssdk, SignIn} = require('actions-on-google'); const app = actionssdk({ // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT clientId: CLIENT_ID, }); // Intent that starts the account linking flow. app.intent('actions.intent.TEXT', (conv) => { conv.ask(new SignIn('To get your account details')); });
@ForIntent("actions.intent.TEXT") public ActionResponse text(ActionRequest request) { ResponseBuilder rb = getResponseBuilder(request); return rb.add(new SignIn().setContext("To get your account details")).build(); }
{ "expectUserResponse": true, "expectedInputs": [ { "inputPrompt": { "richInitialPrompt": { "items": [ { "simpleResponse": { "textToSpeech": "PLACEHOLDER" } } ] } }, "possibleIntents": [ { "intent": "actions.intent.SIGN_IN", "inputValueData": { "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec", "optContext": "To get your account details" } } ] } ], "conversationToken": "{\"data\":{}}", "userStorage": "{\"data\":{}}" }
डेटा ऐक्सेस करने के अनुरोधों को मैनेज करना
अगर Assistant के अनुरोध में कोई ऐक्सेस टोकन है, तो पहले देखें कि ऐक्सेस टोकन मान्य है या नहीं और उसकी समयसीमा खत्म नहीं हुई है. इसके बाद, अपने डेटाबेस से जुड़ा हुआ उपयोगकर्ता खाता वापस पाएं.