پیوند دادن حساب با OAuth

نوع پیوند OAuth از دو جریان استاندارد صنعتی OAuth 2.0 پشتیبانی می کند، جریان کد ضمنی و مجوز .

در جریان کد ضمنی، Google نقطه پایانی مجوز شما را در مرورگر کاربر باز می‌کند. پس از ورود موفقیت آمیز به سیستم، یک توکن دسترسی طولانی مدت به Google برمی گردانید. این نشانه دسترسی اکنون در هر درخواست ارسال شده از دستیار به Action شما گنجانده شده است.

در جریان کد مجوز، به دو نقطه پایانی نیاز دارید:

• نقطه پایانی مجوز ، که مسئول ارائه رابط کاربری ورود به سیستم به کاربرانی است که قبلاً وارد سیستم نشده‌اند و رضایت دسترسی درخواستی را در قالب یک کد مجوز کوتاه مدت ثبت می‌کند.
• نقطه پایانی تبادل توکن ، که مسئول دو نوع مبادله است:
  1. یک کد مجوز را برای یک نشانه رفرش طولانی مدت و یک رمز دسترسی کوتاه مدت مبادله می کند. این تبادل زمانی اتفاق می‌افتد که کاربر از جریان پیوند حساب عبور کند.
  2. یک نشانه رفرش طولانی مدت را با یک توکن دسترسی کوتاه مدت مبادله می کند. این مبادله زمانی اتفاق می‌افتد که گوگل به یک توکن دسترسی جدید نیاز دارد، زیرا رمز دسترسی منقضی شده است.

اگرچه اجرای جریان کد ضمنی ساده‌تر است، اما گوگل توصیه می‌کند که توکن‌های دسترسی صادر شده با استفاده از جریان ضمنی هرگز منقضی نمی‌شوند، زیرا استفاده از انقضای رمز با جریان ضمنی کاربر را مجبور می‌کند تا حساب خود را دوباره پیوند دهد. اگر به دلایل امنیتی نیاز به انقضای توکن دارید، باید قویاً از جریان کد تأیید استفاده کنید.

توجه: لطفاً انتخاب کنید که کدام جریان OAuth 2.0 را می خواهید پیاده سازی کنید. در صورت نیاز، محتوای این راهنما مجدداً بارگیری می شود تا با انتخاب شما سازگار شود.

کد تأیید جریان ضمنی

پیوند حساب OAuth را پیاده سازی کنید

توجه: اگر پیوند حساب را برای مدیریت اطلاعات مالی پیاده‌سازی می‌کنید، توجه داشته باشید که ممکن است خط‌مشی‌های بیشتری برای Action شما اعمال شود. بررسی یک Action با پیوند دادن حساب برای اطلاعات مالی ممکن است تا شش هفته طول بکشد، بنابراین هنگام برنامه‌ریزی زمان‌بندی انتشار خود، آن زمان را در نظر بگیرید. برای تسهیل فرآیند بازبینی، قبل از ارسال Action برای بررسی، مطمئن شوید که از خط‌مشی‌های خدمات مالی پیروی می‌کنید.

پروژه را پیکربندی کنید

برای پیکربندی پروژه خود برای استفاده از پیوند OAuth، این مراحل را دنبال کنید:

1. Actions Console را باز کنید و پروژه ای را که می خواهید استفاده کنید انتخاب کنید.
2. روی تب Develop کلیک کنید و Account linking را انتخاب کنید.
3. سوئیچ کنار Account linking را فعال کنید.
4. در بخش ایجاد حساب ، خیر را انتخاب کنید، من فقط می‌خواهم اجازه ایجاد حساب در وب‌سایت خود را بدهم .

5. در نوع پیوند ، OAuth و Implicit را انتخاب کنید.

   

6. در اطلاعات مشتری :

   • یک مقدار به Client ID صادر شده توسط Actions شما به Google اختصاص دهید تا درخواست‌های ارسالی از Google را شناسایی کنید.
   • آدرس‌های اینترنتی را برای نقاط پایانی مجوز و مبادله رمز خود وارد کنید.

توجه: اگر می‌خواهید شناسه مشتری شما به‌عنوان یک رشته رمزگذاری‌شده base64 ارسال شود، روی پیکان کشویی در کنار Configure your client (اختیاری) کلیک کنید و کادر Google to transmit clientID and Secret را از طریق هدر تأیید اعتبار پایه HTTP علامت بزنید.

6. روی ذخیره کلیک کنید.

سرور OAuth خود را پیاده سازی کنید

برای پشتیبانی از جریان ضمنی OAuth 2.0، سرویس شما یک نقطه پایانی مجوز را توسط HTTPS در دسترس قرار می دهد. این نقطه پایانی مسئول احراز هویت و کسب رضایت از کاربران برای دسترسی به داده است. نقطه پایانی مجوز یک رابط کاربری برای ورود به سیستم به کاربرانی که قبلاً وارد سیستم نشده‌اند ارائه می‌کند و رضایت را برای دسترسی درخواستی ثبت می‌کند.

وقتی Action شما نیاز به تماس با یکی از APIهای مجاز سرویس شما دارد، Google از این نقطه پایانی استفاده می‌کند تا از کاربران شما اجازه بگیرد تا از طرف آنها با این APIها تماس بگیرد.

یک جلسه جریان ضمنی OAuth 2.0 که توسط Google آغاز شده است دارای جریان زیر است:

1. Google نقطه پایانی مجوز شما را در مرورگر کاربر باز می کند. اگر کاربر قبلاً وارد سیستم نشده باشد، به سیستم وارد می‌شود و اگر قبلاً مجوز نداده باشد، به Google اجازه می‌دهد با API شما به داده‌های خود دسترسی داشته باشد.
2. سرویس شما یک نشانه دسترسی ایجاد می‌کند و با هدایت مرورگر کاربر به Google با علامت دسترسی پیوست شده به درخواست، آن را به Google برمی‌گرداند.
3. Google APIهای سرویس شما را فراخوانی می‌کند و رمز دسترسی را با هر درخواست پیوست می‌کند. سرویس شما تأیید می‌کند که نشانه دسترسی به Google مجوز دسترسی به API را می‌دهد و سپس تماس API را تکمیل می‌کند.

رسیدگی به درخواست های مجوز

هنگامی که Action شما باید پیوند حساب را از طریق جریان ضمنی OAuth 2.0 انجام دهد، Google کاربر را با درخواستی که شامل پارامترهای زیر است به نقطه پایانی مجوز شما می‌فرستد:

پارامترهای نقطه پایانی مجوز
client_id	شناسه مشتری که به Google اختصاص داده اید.
redirect_uri	آدرس اینترنتی که پاسخ این درخواست را به آن ارسال می کنید.
state	یک مقدار حسابداری که بدون تغییر در URI تغییر مسیر به 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 اختصاص داده اید مطابقت دارد.
   • تأیید کنید که URL مشخص‌شده توسط پارامتر redirect_uri شکل زیر را دارد:

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

     YOUR_PROJECT_ID شناسه‌ای است که در صفحه تنظیمات پروژه در Actions Console یافت می‌شود.

2. بررسی کنید که آیا کاربر به سرویس شما وارد شده است یا خیر. اگر کاربر وارد سیستم نشده است، جریان ورود به سیستم یا ثبت نام سرویس خود را تکمیل کنید.

3. یک نشانه دسترسی ایجاد کنید که Google از آن برای دسترسی به API شما استفاده می کند. نشانه دسترسی می‌تواند هر مقدار رشته‌ای باشد، اما باید به‌طور منحصربه‌فرد نشان‌دهنده کاربر و کلاینتی باشد که نشانه برای آن است و نباید قابل حدس زدن باشد.

4. یک پاسخ HTTP ارسال کنید که مرورگر کاربر را به URL مشخص شده توسط پارامتر redirect_uri هدایت می کند. تمام پارامترهای زیر را در قطعه URL وارد کنید:

   • access_token : نشانه دسترسی که ایجاد کردید
   • token_type : bearer رشته
   • state : مقدار حالت اصلاح نشده از درخواست اصلی مثال زیر نمونه ای از URL به دست آمده است:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

کنترل‌کننده تغییر مسیر OAuth 2.0 Google نشانه دسترسی را دریافت می‌کند و تأیید می‌کند که مقدار state تغییر نکرده است. پس از اینکه Google یک رمز دسترسی برای سرویس شما به دست آورد، Google این رمز را به تماس‌های بعدی به Action شما به عنوان بخشی از AppRequest متصل می‌کند.

رابط کاربری صوتی را برای جریان احراز هویت طراحی کنید

هشدار: در ابتدای مکالمه با Action خود، درخواست پیوند حساب مورد نیاز را به کاربران ندهید. درعوض، به کاربران احراز هویت نشده یک جریان مهمان بدهید تا نحوه عملکرد Action شما را نشان دهد و سپس فقط در صورت نیاز به ادامه، درخواست پیوند حساب کنید. اگر کاربران به‌دلیل مشکلات مرتبط‌سازی حساب، به‌طور پیوسته از Action خارج می‌شوند، Google فعالانه Action را تبلیغ نمی‌کند، که ممکن است ترافیک کاربر Action را کاهش دهد.

توجه: برای ساخت اکشنی که پیوند حساب را پیاده سازی می کند، باید از Actions Builder استفاده کنید.

بررسی کنید که آیا کاربر تأیید شده است و جریان پیوند حساب را شروع کنید

1. پروژه Actions Builder خود را در Actions Console باز کنید.
2. یک صحنه جدید برای شروع پیوند دادن حساب در Action خود ایجاد کنید:
   1. روی صحنه ها کلیک کنید.
   2. برای افزودن یک صحنه جدید، روی نماد افزودن (+) کلیک کنید.
3. در صحنه جدید ایجاد شده، روی نماد افزودن برای Conditions کلیک کنید.
4. شرطی اضافه کنید که بررسی کند آیا کاربر مرتبط با مکالمه یک کاربر تأیید شده است یا خیر. اگر بررسی ناموفق باشد، Action شما نمی‌تواند پیوند حساب را در طول مکالمه انجام دهد و باید به ارائه دسترسی به عملکردی که نیازی به پیوند حساب ندارد بازگردد.
   1. در قسمت Enter new expression در Condition ، منطق زیر را وارد کنید: user.verificationStatus != "VERIFIED"
   2. در بخش انتقال ، صحنه‌ای را انتخاب کنید که نیازی به پیوند دادن حساب ندارد یا صحنه‌ای که نقطه ورود به عملکرد فقط مهمان است.

1. روی نماد افزودن برای شرایط کلیک کنید.
2. در صورتی که کاربر هویت مرتبطی نداشته باشد، شرطی را برای فعال کردن جریان پیوند حساب اضافه کنید.
   1. در قسمت Enter new expression در Condition ، منطق زیر را وارد کنید: user.verificationStatus == "VERIFIED"
   2. در بخش Transition ، صحنه سیستم پیوند حساب را انتخاب کنید.
   3. روی ذخیره کلیک کنید.

پس از ذخیره، یک صحنه سیستم پیوند حساب جدید به نام <SceneName>_AccountLinking به پروژه شما اضافه می شود.

صحنه پیوند حساب را سفارشی کنید

1. در بخش صحنه‌ها ، صحنه سیستم پیوند دهنده حساب را انتخاب کنید.
2. روی Send prompt کلیک کنید و یک جمله کوتاه اضافه کنید تا به کاربر توضیح دهد که چرا Action باید به هویت او دسترسی داشته باشد (به عنوان مثال "برای ذخیره تنظیمات برگزیده").
3. روی ذخیره کلیک کنید.

1. در زیر شرایط ، روی اگر کاربر با موفقیت پیوند حساب را انجام دهد کلیک کنید.
2. اگر کاربر موافقت کرد که حساب خود را پیوند دهد، نحوه جریان را پیکربندی کنید. به عنوان مثال، برای پردازش هرگونه منطق تجاری سفارشی مورد نیاز و انتقال به صحنه اصلی، با webhook تماس بگیرید.
3. روی ذخیره کلیک کنید.

1. در زیر شرایط ، روی اگر کاربر پیوند دادن حساب را لغو یا رد کرد، کلیک کنید.
2. اگر کاربر با پیوند دادن حساب خود موافقت نکرد، نحوه جریان را پیکربندی کنید. به عنوان مثال، یک پیام تأیید ارسال کنید و به صحنه‌هایی هدایت کنید که عملکردی را ارائه می‌کنند که نیازی به پیوند دادن حساب ندارد.
3. روی ذخیره کلیک کنید.

1. در قسمت Conditions ، روی If system or network error رخ می دهد کلیک کنید.
2. اگر به دلیل خطاهای سیستم یا شبکه نمی‌توان جریان پیوند حساب را تکمیل کرد، نحوه انجام جریان را پیکربندی کنید. به عنوان مثال، یک پیام تأیید ارسال کنید و به صحنه‌هایی هدایت کنید که عملکردی را ارائه می‌کنند که نیازی به پیوند دادن حساب ندارد.
3. روی ذخیره کلیک کنید.

رسیدگی به درخواست های دسترسی به داده ها

اگر درخواست دستیار حاوی یک نشانه دسترسی است ، ابتدا بررسی کنید که نشانه دسترسی معتبر است (و منقضی نشده است) و سپس حساب کاربری مرتبط را از پایگاه داده خود بازیابی کنید.