OAuth की मदद से खाता लिंक करना

OAuth लिंकिंग टाइप, दो इंडस्ट्री स्टैंडर्ड वाले OAuth 2.0 फ़्लो के साथ काम करता है. इनमें इंप्लिसिट और ऑथराइज़ेशन कोड फ़्लो शामिल है.

इंप्लिसिट कोड फ़्लो में, Google, उपयोगकर्ता के ब्राउज़र में ऑथराइज़ेशन एंडपॉइंट दिखाता है. साइन इन करने के बाद, Google को लंबे समय तक चलने वाला ऐक्सेस टोकन दिखाया जाता है. यह ऐक्सेस टोकन अब Assistant से आपकी कार्रवाई को किए गए हर अनुरोध में शामिल किया गया है.

ऑथराइज़ेशन कोड फ़्लो में, आपको दो एंडपॉइंट की ज़रूरत होगी:

• ऑथराइज़ेशन एंडपॉइंट, जो उन उपयोगकर्ताओं के साइन-इन यूज़र इंटरफ़ेस (यूआई) को दिखाने के लिए ज़िम्मेदार है जिन्होंने पहले से साइन इन नहीं किया है. साथ ही, उपयोगकर्ता को कुछ समय तक इस्तेमाल किए जाने वाले ऑथराइज़ेशन कोड के तौर पर ऐक्सेस का अनुरोध करने के लिए सहमति लेनी होती है.
• टोकन एक्सचेंज एंडपॉइंट, दो तरह के एक्सचेंज के लिए ज़िम्मेदार है:
  1. लंबे समय तक चलने वाले रीफ़्रेश टोकन और कुछ समय तक चलने वाले ऐक्सेस टोकन के लिए ऑथराइज़ेशन कोड बदलता है. यह एक्सचेंज तब होता है, जब उपयोगकर्ता, खाता जोड़ने के फ़्लो से गुज़रता है.
  2. वह कम समय तक चलने वाले ऐक्सेस टोकन के लिए, लंबे समय तक चलने वाले रीफ़्रेश टोकन की अदला-बदली करता है. यह ऐसा तब होता है, जब Google को नए ऐक्सेस टोकन की ज़रूरत होती है, क्योंकि उसकी समयसीमा खत्म हो चुकी होती है.

इंप्लिसिट कोड फ़्लो को लागू करना आसान है. हालांकि, Google का सुझाव है कि इंप्लिसिट फ़्लो का इस्तेमाल करके जारी किए गए ऐक्सेस टोकन की समयसीमा कभी खत्म न हो. ऐसा इसलिए, क्योंकि इंप्लिसिट फ़्लो वाले टोकन एंडपॉइंट का इस्तेमाल करने से, उपयोगकर्ता को अपने खाते को फिर से जोड़ने के लिए मजबूर कर दिया जाता है. अगर आपको सुरक्षा से जुड़ी वजहों से टोकन की समयसीमा खत्म होने की ज़रूरत है, तो आपको इसके बजाय ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करना चाहिए.

ध्यान दें: कृपया चुनें कि आपको कौनसा OAuth 2.0 फ़्लो लागू करना है. ज़रूरत पड़ने पर, इस गाइड का कॉन्टेंट आपके चुने हुए paywall के मुताबिक फिर से लोड हो जाता है.

पुष्टि करने का कोड इंप्लिसिट फ़्लो

OAuth खाता जोड़ने की प्रोसेस को लागू करना

ध्यान दें: अगर वित्तीय जानकारी को मैनेज करने के लिए खाता जोड़ने की सुविधा लागू की जा रही है, तो ध्यान दें कि आपकी सेट की गई कार्रवाई पर दूसरी नीतियां भी लागू हो सकती हैं. वित्तीय जानकारी के लिए खाता लिंक करने की किसी कार्रवाई की समीक्षा करने में हमें छह हफ़्ते लग सकते हैं. इसलिए, रिलीज़ के शेड्यूल को तैयार करते समय उस समय का ध्यान रखें. समीक्षा की प्रोसेस को आसान बनाने के लिए, अपनी कार्रवाई को समीक्षा के लिए सबमिट करने से पहले, पक्का करें कि वित्तीय सेवाओं की नीतियों का पालन किया जा रहा हो.

प्रोजेक्ट कॉन्फ़िगर करें

OAuth लिंकिंग का इस्तेमाल करने के लिए, अपने प्रोजेक्ट को कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं:

1. Actions Console खोलें और वह प्रोजेक्ट चुनें जिसका आपको इस्तेमाल करना है.
2. डेवलप करें टैब पर क्लिक करें और खाता लिंक करना चुनें.
3. खाता लिंक करना के बगल में मौजूद स्विच को चालू करें.
4. खाता बनाना सेक्शन में, नहीं, मुझे सिर्फ़ अपनी वेबसाइट पर खाता बनाने की अनुमति देनी है चुनें.

5. लिंक करने का टाइप में, OAuth और Implicit चुनें.

   

6. क्लाइंट की जानकारी में:

   • Google से आने वाले अनुरोधों की पहचान करने के लिए, Google Actions से जारी किए गए Client-ID के लिए कोई वैल्यू असाइन करें.
   • अपने ऑथराइज़ेशन और टोकन एक्सचेंज एंडपॉइंट के यूआरएल डालें.

ध्यान दें: अगर आपको अपने क्लाइंट आईडी को base64 कोड वाली स्ट्रिंग के तौर पर भेजना है, तो अपने क्लाइंट को कॉन्फ़िगर करें (ज़रूरी नहीं) के आगे दिए गए ड्रॉप-डाउन ऐरो पर क्लिक करें. इसके बाद, एचटीटीपी के बेसिक ऑथराइज़ेशन हेडर के ज़रिए clientID और सीक्रेट को ट्रांसमिट करने के लिए Google वाले बॉक्स को चुनें.

6. सेव करें पर क्लिक करें.

अपना OAuth सर्वर लागू करना

OAuth 2.0 इंप्लिसिट फ़्लो की सुविधा के लिए, आपकी सेवा, एचटीटीपीएस से अनुमति देने वाला एक एंडपॉइंट उपलब्ध कराती है. यह एंडपॉइंट, डेटा ऐक्सेस करने के लिए उपयोगकर्ताओं की सहमति की पुष्टि करने और उन्हें स्वीकार करने के लिए ज़िम्मेदार है. ऑथराइज़ेशन एंडपॉइंट, आपके उन उपयोगकर्ताओं को साइन-इन यूज़र इंटरफ़ेस (यूआई) दिखाता है जिन्होंने पहले से साइन इन नहीं किया है. साथ ही, अनुरोध किए गए ऐक्सेस के लिए सहमति रिकॉर्ड करता है.

जब आपकी सेट की गई कार्रवाई को आपकी सेवा के किसी अनुमति वाले एपीआई को कॉल करना होता है, तो Google इस एंडपॉइंट का इस्तेमाल आपके उपयोगकर्ताओं से अनुमति लेने के लिए करता है, ताकि वे इन एपीआई को उनकी ओर से कॉल कर सकें.

Google जो सामान्य OAuth 2.0 इंप्लिसिट फ़्लो सेशन शुरू करता है उसमें यह फ़्लो होता है:

1. Google, उपयोगकर्ता के ब्राउज़र में आपका ऑथराइज़ेशन एंडपॉइंट खोलता है. अगर उपयोगकर्ता ने पहले से साइन इन नहीं किया है, तो वह साइन इन करता है. साथ ही, अगर उपयोगकर्ता ने पहले से अनुमति नहीं दी है, तो वह Google को आपके एपीआई से अपना डेटा ऐक्सेस करने की अनुमति देता है.
2. आपकी सेवा एक ऐक्सेस टोकन बनाती है और उपयोगकर्ता के ब्राउज़र को अनुरोध से अटैच किए गए ऐक्सेस टोकन के साथ, उपयोगकर्ता के ब्राउज़र को वापस Google पर रीडायरेक्ट करके उसे Google पर वापस भेज देती है.
3. Google आपकी सेवा के एपीआई को कॉल करता है और हर अनुरोध के साथ ऐक्सेस टोकन अटैच करता है. आपकी सेवा पुष्टि करती है कि ऐक्सेस टोकन Google को एपीआई ऐक्सेस करने की अनुमति देता है या नहीं. इसके बाद, वह एपीआई कॉल पूरा करता है.

अनुमति के अनुरोधों को मैनेज करना

जब आपकी सेट की गई कार्रवाई को किसी OAuth 2.0 इंप्लिसिट फ़्लो के ज़रिए खाता लिंक करने की ज़रूरत होती है, तो 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

आपका ऑथराइज़ेशन एंडपॉइंट, साइन इन करने के अनुरोधों को मैनेज कर सके, इसके लिए यह तरीका अपनाएं:

1. अनचाहे या गलत तरीके से कॉन्फ़िगर किए गए क्लाइंट ऐप्लिकेशन को ऐक्सेस देने से रोकने के लिए, client_id और redirect_uri वैल्यू की पुष्टि करें:

   • पक्का करें कि client_id, Google को असाइन किए गए आपके क्लाइंट आईडी से मेल खाता हो.
   • पक्का करें कि redirect_uri पैरामीटर से दिए गए यूआरएल का फ़ॉर्म यह है:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID, Actions Console के प्रोजेक्ट सेटिंग पेज पर मौजूद आईडी है.

2. देखें कि उपयोगकर्ता ने आपकी सेवा में साइन इन किया हुआ है या नहीं. अगर उपयोगकर्ता ने साइन इन नहीं किया है, तो अपनी सेवा के साइन-इन या साइन-अप फ़्लो को पूरा करें.

3. ऐक्सेस टोकन जनरेट करें. Google इसका इस्तेमाल आपके एपीआई को ऐक्सेस करने के लिए करेगा. ऐक्सेस टोकन, किसी भी स्ट्रिंग की वैल्यू हो सकता है. हालांकि, यह खास तौर पर उस उपयोगकर्ता और क्लाइंट के बारे में बताना चाहिए जिसके लिए टोकन मौजूद है. साथ ही, इसका अंदाज़ा भी नहीं लगाया जा सकता.

4. ऐसा एचटीटीपी रिस्पॉन्स भेजें जो उपयोगकर्ता के ब्राउज़र को 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 के हिस्से के तौर पर आपकी सेट की गई कार्रवाई के बाद के कॉल में अटैच कर देगा.

पुष्टि करने के लिए, वॉइस यूज़र इंटरफ़ेस डिज़ाइन करें

चेतावनी: अपनी सेट की गई कार्रवाई से बातचीत की शुरुआत में, उपयोगकर्ताओं को खाता जोड़ने का ज़रूरी अनुरोध न दें. इसके बजाय, पुष्टि न किए गए उपयोगकर्ताओं को गेस्ट फ़्लो की मदद से दिखाएं कि आपकी सेट की गई कार्रवाई कैसे काम करती है. इसके बाद, खाता लिंक करने के लिए सिर्फ़ तब अनुरोध करें, जब आगे बढ़ने के लिए ऐसा करना ज़रूरी हो. अगर खाता जोड़ने से जुड़ी समस्याओं की वजह से उपयोगकर्ता, कार्रवाई को बार-बार छोड़ रहे हैं, तो Google उस कार्रवाई का प्रमोशन नहीं करेगा. इससे, उस कार्रवाई के लिए उपयोगकर्ता को मिलने वाले ट्रैफ़िक में कमी आ सकती है.

ध्यान दें: खाता जोड़ने की प्रोसेस लागू करने वाली कार्रवाई बनाने के लिए, आपको ऐक्शन बिल्डर का इस्तेमाल करना होगा.

यह पता करना कि उपयोगकर्ता की पुष्टि हो चुकी है या नहीं और खाता लिंक करने की प्रक्रिया शुरू करें

1. Actions कंसोल में अपना Actions Builder प्रोजेक्ट खोलें.
2. अपनी सेट की गई कार्रवाई में खाता लिंक करने की प्रोसेस शुरू करने के लिए, एक नया सीन बनाएं:
   1. सीन पर क्लिक करें.
   2. नया सीन जोड़ने के लिए, जोड़ें (+) आइकॉन पर क्लिक करें.
3. नए सीन में, शर्तों के लिए, जोड़ें आइकॉन पर क्लिक करें.
4. एक शर्त जोड़ें जो यह जांच करती है कि बातचीत से जुड़ा उपयोगकर्ता, पुष्टि किया गया उपयोगकर्ता है या नहीं. अगर जांच पूरी नहीं हो पाती, तो आपकी सेट की गई कार्रवाई, बातचीत के दौरान खाता लिंक नहीं कर पाएगी. साथ ही, इसे ऐसे फ़ंक्शन का ऐक्सेस देना होगा जिसके लिए खाता लिंक करने की ज़रूरत नहीं होती.
   1. शर्त वाले Enter new expression फ़ील्ड में, यह लॉजिक डालें: user.verificationStatus != "VERIFIED"
   2. ट्रांज़िशन में, ऐसा सीन चुनें जिसमें खाता लिंक करने की ज़रूरत न हो या कोई ऐसा सीन चुनें जो सिर्फ़ मेहमान के लिए उपलब्ध सुविधा के लिए शुरुआती पॉइंट हो.

1. शर्तों के लिए, ' जोड़ें' आइकॉन पर क्लिक करें.
2. अगर उपयोगकर्ता की पहचान से जुड़ी जानकारी नहीं है, तो खाता लिंक करने के फ़्लो को ट्रिगर करने के लिए कोई शर्त जोड़ें.
   1. शर्त वाले Enter new expression फ़ील्ड में, यह लॉजिक डालें: user.verificationStatus == "VERIFIED"
   2. ट्रांज़िशन में जाकर, खाता लिंक करना सिस्टम सीन चुनें.
   3. सेव करें पर क्लिक करें.

सेव करने के बाद, आपके प्रोजेक्ट में खाता लिंक करने वाला <SceneName>_AccountLinking नाम का एक नया सीन जोड़ा जाता है.

खाता लिंक करने के सीन को पसंद के मुताबिक बनाना

1. सीन में जाकर, खाता लिंक करने वाले सिस्टम का सीन चुनें.
2. सूचना भेजें पर क्लिक करें. इसके बाद, एक छोटा वाक्य जोड़कर उपयोगकर्ता को बताएं कि कार्रवाई को उनकी पहचान का ऐक्सेस क्यों चाहिए. उदाहरण के लिए, "आपकी प्राथमिकताएं सेव करने के लिए".
3. सेव करें पर क्लिक करें.

1. शर्तें सेक्शन में, अगर उपयोगकर्ता खाता लिंक करने की प्रोसेस पूरी कर लेता है पर क्लिक करें.
2. अगर उपयोगकर्ता अपने खाते को लिंक करने की सहमति देता है, तो फ़्लो को कॉन्फ़िगर करना. उदाहरण के लिए, ज़रूरी किसी भी कारोबारी लॉजिक को प्रोसेस करने और मूल सीन पर वापस जाने के लिए वेबहुक को कॉल करें.
3. सेव करें पर क्लिक करें.

1. शर्तें सेक्शन में, अगर उपयोगकर्ता खाता जोड़ने की प्रोसेस को रद्द करता है या उसे खारिज करता है, तो उस पर क्लिक करें.
2. अगर उपयोगकर्ता अपने खाते को लिंक करने के लिए सहमत नहीं है, तो फ़्लो कॉन्फ़िगर करें. उदाहरण के लिए, स्वीकार करने वाला मैसेज भेजें और उन सीन पर रीडायरेक्ट करें जिनमें ऐसी सुविधाएं दी गई हों जिनके लिए खाता लिंक करने की ज़रूरत न हो.
3. सेव करें पर क्लिक करें.

1. शर्तें सेक्शन में, अगर सिस्टम या नेटवर्क की गड़बड़ी होती है पर क्लिक करें.
2. कॉन्फ़िगर करें कि अगर सिस्टम या नेटवर्क की गड़बड़ियों की वजह से खाता लिंक करने का फ़्लो पूरा नहीं हो पा रहा है, तो फ़्लो कैसे आगे बढ़ना चाहिए. उदाहरण के लिए, स्वीकार करने वाला मैसेज भेजें और उन सीन पर रीडायरेक्ट करें जिनमें ऐसी सुविधाएं दी गई हों जिनके लिए खाता लिंक करने की ज़रूरत न हो.
3. सेव करें पर क्लिक करें.

डेटा ऐक्सेस करने के अनुरोधों को मैनेज करना

अगर Assistant के अनुरोध में कोई ऐक्सेस टोकन है, तो पहले देखें कि ऐक्सेस टोकन मान्य है या नहीं और उसकी समयसीमा खत्म नहीं हुई है. इसके बाद, अपने डेटाबेस से जुड़ा हुआ उपयोगकर्ता खाता वापस पाएं.