מדריך זה מסביר כיצד להשתמש ב-OAuth 2.0 כדי לבקש גישה לחשבונות סוחרים של צדדים אחרים. אם אתם ספקים מצד שלישי, תוכלו להשתמש בתהליך העבודה הזה כדי לאפשר לאפליקציה לבקש גישה לחשבונות המוכרים של הלקוחות שלכם.
אם אתם מפתחים אפליקציה פנימית שדורשת גישה רק לחשבון המוכר שלכם, כדאי לעיין במקום זאת בקטע גישה לחשבון שלכם.
בקשה לאימות אפליקציות
אפליקציות שמקבלות גישה ל-Merchant API חייבות לעבור תהליך בדיקה של אימות OAuth. אפליקציות לא מאומתות יקבלו אזהרות והפונקציונליות שלהן מוגבלת.
אפליקציה היא כל דבר עם מזהה לקוח ייחודי של OAuth 2.0 ב-Google Cloud.
תהליך האימות נמשך בדרך כלל 3-5 ימי עסקים. למידע נוסף ולשליחת בקשת אימות, ניתן לעיין במאמר אימות לאפליקציות.
המדיניות הזו חלה על כל האפליקציות. אנחנו ממליצים לכל האפליקציות לעבור את תהליך האימות מוקדם ככל האפשר כדי למנוע שיבושים בפעילות העסקית.
קבלת היקפי הרשאות של OAuth
כדאי להגדיר הרשאה מצטברת (Incremental authorization) כדי למנוע בעיות בבחירת ההיקף.
אם מבקשים יותר מאחת, כל היקפי ההרשאות של OAuth לא נבחרים כברירת מחדל במסך ההסכמה של האפליקציה. כשמסך ההסכמה מוצג למשתמש באפליקציה, המשתמש צריך לבחור ידנית כל היקף הרשאות כדי להעניק לו הרשאת גישה.
בודקים את התגובה מבקשת OAuth כדי לוודא שהאפליקציה קיבלה את היקפי ההרשאות המתאימים.
לפרטים נוספים, ראו מדיניות OAuth 2.0.
בקשות הרשאה
כל בקשה שהאפליקציה שולחת ל-Merchant API חייבת לכלול אסימון הרשאה. אסימון ההרשאה גם מזהה את האפליקציה שלכם ב-Google.
הסבר על פרוטוקולים של הרשאות
כדי לאשר בקשות, האפליקציה חייבת להשתמש בפרוטוקול OAuth 2.0. אין תמיכה בפרוטוקולים אחרים של הרשאות. אם האפליקציה משתמשת בכניסה באמצעות חשבון Google, היבטים מסוימים של ההרשאות מטופלים באופן אוטומטי.
הרשאת בקשות עם פרוטוקול OAuth 2.0
כל הבקשות ל-Merchant API חייבות להיות מאושרות על ידי משתמש מאומת.
הפרטים או ה"זרימה" של תהליך ההרשאה עם OAuth 2.0 עשויים להשתנות מעט, בהתאם לסוג האפליקציה שאתם מפתחים. התהליך הכללי הבא חל על כל סוגי האפליקציות:
- כשאתם יוצרים את האפליקציה, צריך לרשום אותה באמצעות Google API Console. לאחר הרישום, Google מספקת נתונים שיהיו דרושים לכם מאוחר יותר, כמו מזהה לקוח וסוד לקוח.
- מפעילים את Merchant API ב-Google API Console. (אם ממשק ה-API לא מופיע ב-API Console, אפשר לדלג על השלב הזה).
- כשהאפליקציה צריכה גישה לנתונים של משתמשים, היא מעבירה ל-Google בקשת גישה בהיקף ספציפי.
- Google מציגה למשתמש מסך הסכמה ומבקשת לאשר לאפליקציה לשלוח בקשה לחלק מהנתונים שלו.
- אם המשתמש מסכים, האפליקציה מקבלת מ-Google אסימון גישה לטווח קצר.
- האפליקציה מבקשת את נתוני המשתמש ומצרפת לבקשה את אסימון הגישה.
- אם Google תקבע שהבקשה והאסימון תקפים, היא תחזיר את הנתונים המבוקשים.
חלק מתהליכי העבודה כוללים שלבים נוספים, כמו שימוש באסימוני רענון כדי לקבל אסימוני גישה חדשים. למידע מפורט על תהליכי העבודה לסוגים שונים של אפליקציות, ניתן לעיין בתיעוד של OAuth 2.0 של Google.
אלה הפרטים לגבי היקפי OAuth 2.0 של Merchant API:
| היקף | משמעות |
|---|---|
https://www.googleapis.com/auth/content |
הרשאת קריאה/כתיבה. |
כדי לבקש גישה באמצעות פרוטוקול OAuth 2.0, האפליקציה שלכם זקוקה למידע על ההיקף ולמידע ש-Google מספקת בזמן רישום האפליקציה (כמו מזהה לקוח וסוד לקוח).
הנה דוגמה לשימוש לצורך הרשאה.