שימוש ב-OAuth

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

כאן מוסבר איך להעביר אסימון OAuth לקריאה ל-Address Validation API בסביבת הפיתוח. במאמר אימות ב-Google תוכלו לקרוא הוראות על השימוש ב-OAuth בסביבת ייצור.

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

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

מידע על OAuth

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

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

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

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

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

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

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

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

בדוגמה הזו מוסבר איך להשתמש באסימון ה-OAuth שסופק על ידי Application Default Credentials (ADC) כדי לבצע את הקריאה. במאמר אימות לשירותי Cloud באמצעות ספריות לקוח תוכלו ללמוד איך משתמשים ב-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.

בדוגמה הבאה מתבצעת קריאה לממשק ה-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 הזה לא תומך בפרטי הכניסה של משתמשי הקצה, עיינו בקטע פרטי הכניסה של משתמשים לא תקינים.

הקודם
שימוש במפתחות API
הבא
שליחת בקשה לאימות כתובת