שימוש ב-OAuth

‫Roads Selection API משתמש ב-Roads Selection API כרכיב ליבה שמספק נתוני כבישים ל-BigQuery ול-Pub/Sub.

‫Roads Selection API תומך בשימוש ב-OAuth 2.0 לצורך אימות. ‫Google תומכת בתרחישים נפוצים של OAuth 2.0, כמו אלה של שרת אינטרנט.

במאמר הזה מוסבר איך להעביר טוקן OAuth לקריאה ל-Roads Selection API בסביבת הפיתוח. למידע נוסף על השימוש ב-OAuth בסביבת ייצור, קראו את המאמר אימות ב-Google.

לפני שמתחילים

כדי להשתמש ב-Roads Selection API, צריך פרויקט עם חשבון לחיוב שבו ה-API מופעל. מידע נוסף זמין במאמר הגדרה במסוף Cloud.

מידע על OAuth

יש כמה דרכים ליצור ולנהל טוקני גישה באמצעות OAuth, בהתאם לסביבת הפריסה.

לדוגמה, מערכת Google OAuth 2.0 תומכת באינטראקציות משרת לשרת, כמו אלה שבין האפליקציה שלכם לשירות של Google. בתרחיש הזה, צריך להיות לכם חשבון שירות, שהוא חשבון ששייך לאפליקציה שלכם ולא למשתמש ספציפי. האפליקציה שולחת קריאות ל-Google APIs בשם חשבון השירות, כי המשתמשים לא מעורבים באופן ישיר. למידע נוסף על שיטות אימות, קראו את המאמר אימות ב-Google.

לחלופין, אתם יכולים להשתמש ב-Roads Selection API כחלק מאפליקציה לנייד ל-Android או ל-iOS. מידע נוסף על השימוש ב-OAuth עם Roads Selection API, כולל מידע על ניהול טוקני גישה לסביבות פריסה שונות, זמין במאמר שימוש ב-OAuth 2.0 לגישה ל-Google APIs.

מידע על היקפי ההרשאות של OAuth

כדי להשתמש ב-OAuth עם Roads Selection API, לאסימון ה-OAuth צריך להיות היקף ההרשאות https://www.googleapis.com/auth/cloud-platform.

דוגמה: ניסיון של קריאות ל-API בארכיטקטורת REST בסביבת הפיתוח המקומית

אם אתם רוצים לנסות את Roads Selection API באמצעות טוקן OAuth, אבל אין לכם סביבה שמוגדרת ליצירת טוקנים, אתם יכולים לשלוח את הבקשה לפי התהליך שמתואר בקטע הזה.

בדוגמה הזו נסביר איך להשתמש באסימון OAuth שסופק על ידי Application Default Credentials ‏ (ADC) כדי לבצע את הקריאה. במאמר אימות לשירותי Cloud באמצעות ספריות לקוח תוכלו ללמוד איך משתמשים ב-ADC כדי לקרוא ל-Google APIs באמצעות ספריות לקוח.

דרישות מוקדמות

כדי שתוכלו לשלוח בקשת REST באמצעות ADC, אתם צריכים קודם לספק ל-ADC את פרטי הכניסה באמצעות Google Cloud CLI:

  1. אם עדיין לא עשיתם זאת, יוצרים פרויקט ומפעילים את החיוב לפי השלבים שמפורטים במאמר הגדרה במסוף Cloud.
  2. מתקינים ומפעילים את ה-CLI של gcloud.

  3. כדי ליצור את קובץ פרטי הכניסה, מריצים את הפקודה gcloud במחשב המקומי:

    gcloud auth application-default login
  4. כשמופיעה בקשה, נכנסים לחשבון. אחרי שנכנסים, פרטי הכניסה נשמרים בקובץ פרטי הכניסה המקומי שמשמש את ADC.

למידע נוסף, קראו את הקטע סביבת פיתוח מקומית במאמר מתן פרטי כניסה ל-Application Default Credentials.

שליחת בקשת REST

בדוגמה הזו, אתם מעבירים שתי כותרות של בקשות:

  • מעבירים את אסימון ה-OAuth בכותרת Authorization באמצעות הפקודה הבאה כדי ליצור את האסימון:

    gcloud auth application-default print-access-token

    ההיקף של האסימון שמוחזר הוא https://www.googleapis.com/auth/cloud-platform.

  • מעבירים את המזהה או השם של פרויקט בענן ב-Google Cloud שהחיוב מופעל בו בכותרת X-Goog-User-Project. מידע נוסף זמין במאמר הגדרה במסוף Cloud.

שולחים קריאה ל-Roads Selection API באמצעות אסימון OAuth:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
https://roads.googleapis.com/selection/v1/projects/PROJECT_NUMBER/selectedRoutes/SELECTED_ROUTE_ID

פתרון בעיות

אם הבקשה מחזירה הודעת שגיאה שלפיה ה-API לא תומך בפרטי הכניסה של משתמשי הקצה, עיינו בקטע פרטי הכניסה של משתמשים לא פועלים.