שימוש ב-OAuth

'אימות כתובת' תומך ב-OAuth 2.0 לאימות. Google תומכת בתרחישי OAuth 2.0 נפוצים כמו אלה של שרת אינטרנט.

במסמך הזה מוסבר איך להעביר אסימון OAuth לקריאה ל-Address Authentication API בסביבת הפיתוח. להוראות על השימוש ב-OAuth בסביבת production קראו את המאמר אימות ב-Google.

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

לפני שמתחילים להשתמש ב-Address Authentication API, נדרש פרויקט עם חשבון לחיוב ו-Address Authentication API מופעל. מומלץ ליצור מספר בעלים ואדמינים של חשבונות לחיוב, כדי שתמיד יהיה לצוות שלכם תפקיד בתפקידים האלה. למידע נוסף, קראו את המאמר הגדרה ב-Cloud Console.

מידע על OAuth

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

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

לחלופין, תוכלו להשתמש ב-Address Authentication API כחלק מאפליקציה לנייד ב-Android או ב-iOS.

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

כדי להשתמש ב-OAuth עם אימות כתובות, יש להקצות את אסימון ה-OAuth להיקף:

  • https://www.googleapis.com/auth/cloud-platform

דוגמה: ביצוע קריאות ל-API ל-REST בסביבת הפיתוח המקומית

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

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

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

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

  1. אם עדיין לא עשית זאת, עליך ליצור פרויקט ולהפעיל את החיוב לפי השלבים המפורטים במאמר הגדרה במסוף Google 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 Console.

בדוגמה הבאה מוצגת קריאה ל-API לאימות כתובות באמצעות אסימון OAuth:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://addressvalidation.googleapis.com/v1:validateAddress"

פתרון בעיות

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