שימוש ב-OAuth

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

במאמר הזה מוסבר איך להעביר אסימון OAuth לקריאה ל-Map Management API בסביבת הפיתוח. במאמר אימות ב-Google מוסבר איך משתמשים ב-OAuth בסביבת ייצור.

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

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

מידע על OAuth

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

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

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

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

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

התנסות בקריאות ל-API בארכיטקטורת REST בסביבת הפיתוח המקומית

אם אתם רוצים לנסות את Map Management 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 שהחיוב מופעל בו בכותרת X-Goog-User-Project. מידע נוסף זמין במאמר הגדרה במסוף Cloud.

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

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs/

פתרון בעיות

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