הסוג קישור OAuth תומך בשני תהליכי OAuth 2.0 מקובלים בתחום, התהליכים המשתמעת וההרשאה.
In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.
In the authorization code flow, you need two endpoints:
- The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
- The token exchange endpoint, which is responsible for two types of exchanges:
- Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
- Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.
Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.
הטמעה של קישור חשבון OAuth
הגדרת הפרויקט
כדי להגדיר בפרויקט שימוש בקישור OAuth, פועלים לפי השלבים הבאים:
- פותחים את Actions Console ובוחרים את הפרויקט שבו רוצים להשתמש.
- לוחצים על הכרטיסייה פיתוח ובוחרים באפשרות קישור חשבונות.
- מפעילים את המתג שלצד קישור חשבונות.
- בקטע יצירת חשבון, בוחרים באפשרות לא, אני רוצה לאפשר רק יצירת חשבון באתר שלי.
בקטע Linking type (סוג הקישור), בוחרים באפשרות OAuth ו-Implicit (מרומז).
בקטע פרטי לקוח:
- כדי לזהות בקשות שמגיעות מ-Google, מקצים ערך ל-Client-ID שהונפק על ידי Actions to Google.
- עליך להזין את כתובות ה-URL של נקודות הקצה Authorization ו-Token Exchange.
- לוחצים על שמירה.
הטמעה של שרת OAuth
כדי לתמוך בזרם הענקת גישה משתמע ב-OAuth 2.0, השירות שלכם יוצר הרשאה נקודת הקצה שזמינה ב-HTTPS. נקודת הקצה (endpoint) הזו אחראית לאימות קבלת הסכמה מהמשתמשים לצורך גישה לנתונים. נקודת הקצה של ההרשאה שמציג ממשק משתמש לכניסה למשתמשים שעדיין לא מחוברים לחשבון, להסכים להרשאת הגישה המבוקשת.
כשהפעולה צריכה להפעיל את אחד מממשקי ה-API המורשים של השירות שלך, Google משתמשת את נקודת הקצה הזו כדי לקבל הרשאה מהמשתמשים שלך לקרוא לממשקי ה-API האלה בשם.
בסשן זרם הענקת גישה משתמע ב-OAuth 2.0 ש-Google יזמה, התהליך הבא:
- Google פותחת את נקודת הקצה להרשאה בדפדפן של המשתמש. משתמש נכנס לחשבון אם הוא עדיין לא מחובר, ומעניק ל-Google הרשאת גישה את הנתונים שלהם באמצעות ה-API, אם הם עדיין לא העניקו הרשאה.
- השירות שלכם יוצר אסימון גישה ומחזיר אותו אל Google מפנה את דפדפן המשתמש חזרה אל Google באמצעות אסימון הגישה שמצורף לבקשה.
- Google קוראת לממשקי ה-API של השירות, ומצרפת את אסימון הגישה עם בכל בקשה. השירות שלך מאמת שאסימון הגישה מעניק ל-Google הרשאה לגשת ל-API ואז משלימה את הקריאה ל-API.
טיפול בבקשות הרשאה
כשהפעולה צריכה לבצע קישור חשבונות באמצעות זרם הענקת גישה משתמע ב-OAuth 2.0, Google שולחת את המשתמש לנקודת הקצה (endpoint) של ההרשאה עם בקשה שכוללת את הפרמטרים הבאים:
פרמטרים של נקודת קצה להרשאה | |
---|---|
client_id |
מזהה הלקוח שהקצית ל-Google. |
redirect_uri |
כתובת ה-URL שאליה שולחים את התגובה לבקשה הזו. |
state |
ערך של ניהול חשבונות שמועבר אל Google ללא שינוי URI להפניה אוטומטית. |
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. - מוודאים שכתובת ה-URL שצוינה ב-
redirect_uri
נראה כך:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID הוא המזהה שמופיע בדף הגדרות הפרויקט של 'מסוף הפעולות'.
- צריך לוודא שה-
לבדוק אם המשתמש נכנס לשירות. אם המשתמש לא חתום להשלים את תהליך הכניסה או ההרשמה לשירות.
יוצרים אסימון גישה שבו Google תשתמש כדי לגשת ל-API. אסימון גישה יכול להיות כל ערך מחרוזת, אבל הוא חייב לייצג באופן ייחודי את למשתמש וללקוח שבשבילם האסימון מיועד והם חייבים להיות ניתנים לניחוש.
לשלוח תגובת 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
ה-handler של Google להפניה אוטומטית ב-OAuth 2.0 יקבל את אסימון הגישה ויאשר
שהערך של state
לא השתנה. לאחר ש-Google קיבלה
אסימון הגישה לשירות שלך, Google תצרף את האסימון לשיחות הבאות
לפעולה כחלק מה-AppRequest.
עיצוב ממשק המשתמש הקולי לתהליך האימות
בודקים אם המשתמש מאומת ומתחילים בתהליך קישור החשבון
- פותחים את הפרויקט ב-Actions Builder ב-Actions Console.
- יוצרים סצנה חדשה כדי להתחיל את קישור החשבונות בפעולה:
- לוחצים על סצנות.
- לוחצים על הסמל הוספה (+) כדי להוסיף סצנה חדשה.
- בסצנה החדשה שנוצרה, לוחצים על סמל ההוספה add של Conditions.
- אפשר להוסיף תנאי שבודק אם המשתמש שמשויך לשיחה הוא משתמש מאומת. אם הבדיקה נכשלת, הפעולה לא יכולה לבצע קישור חשבונות במהלך השיחה. במקום זאת, אתם אמורים לקבל גישה לפונקציונליות שלא מחייבת קישור חשבונות.
- בשדה
Enter new expression
בקטע תנאי, מזינים את הלוגיקה הבאה:user.verificationStatus != "VERIFIED"
- בקטע Transition, בוחרים סצנה שלא מחייבת קישור של חשבונות, או סצנה שהיא נקודת הכניסה לפונקציונליות לאורחים בלבד.
- בשדה
- לוחצים על סמל ההוספה add עבור תנאים.
- אפשר להוסיף תנאי שמפעיל תהליך של קישור חשבון אם למשתמש
לא משויכת זהות.
- בשדה
Enter new expression
בקטע תנאי, מזינים את הלוגיקה הבאה:user.verificationStatus == "VERIFIED"
- בקטע מעבר, בוחרים בסצנה של המערכת קישור חשבונות.
- לוחצים על שמירה.
- בשדה
אחרי השמירה, תתווסף לפרויקט סצנה חדשה של מערכת קישור חשבונות בשם <SceneName>_AccountLinking
.
התאמה אישית של הסצנה של קישור החשבונות
- בקטע סצנות, בוחרים את סצנת המערכת לקישור החשבונות.
- לוחצים על שליחת בקשה ומוסיפים משפט קצר שיתאר למשתמש למה הפעולה צריכה לגשת לזהות שלו (לדוגמה, 'כדי לשמור את ההעדפות שלך').
- לוחצים על שמירה.
- בקטע תנאים, לוחצים על אם המשתמש השלים את קישור החשבון.
- יש להגדיר את המשך התהליך אם המשתמש מסכים לקשר את החשבון שלו. לדוגמה, אפשר לקרוא ל-webhook כדי לעבד כל לוגיקה עסקית מותאמת אישית שנדרשת ולחזור לסצנת המקור.
- לוחצים על שמירה.
- בקטע תנאים, לוחצים על אם המשתמש מבטל או סוגר קישור חשבונות.
- מגדירים את הפעולות שהמשתמשים צריכים לבצע אם הם לא מסכימים לקשר את החשבון. לדוגמה, שלחו הודעה תודה והפנו את המשתמשים לסצנות עם פונקציונליות שלא מחייבת קישור חשבונות.
- לוחצים על שמירה.
- בקטע תנאים, לוחצים על אם מתרחשת שגיאת מערכת או רשת.
- אתם יכולים להגדיר איך להמשיך בתהליך אם לא ניתן להשלים את תהליך קישור החשבונות בגלל שגיאות מערכת או רשת. לדוגמה, שלחו הודעה תודה והפנו את המשתמשים לסצנות עם פונקציונליות שלא מחייבת קישור חשבונות.
- לוחצים על שמירה.
טיפול בבקשות גישה לנתונים
אם הבקשה מ-Assistant מכילה אסימון גישה, קודם צריך לוודא שאסימון הגישה תקין (ותוקפו לא פג) ואז לאחזר ממסד הנתונים את חשבון המשתמש המשויך.