שימוש במפתחות API עם API לאימות כתובות

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

במדריך הזה מוסבר איך ליצור מפתח API, להגביל אותו ולהשתמש בו בפלטפורמה של מפות Google.

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

יצירת מפתחות API

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

כך יוצרים מפתח API:

מסוף

1. עוברים לדף הפלטפורמה של מפות Google > פרטי כניסה.

   כניסה לדף Credentials

2. בדף Credentials, לוחצים על Create credentials > מפתח API.
   תיבת הדו-שיח API key created מציגה את מפתח ה-API החדש שיצרתם.
3. לוחצים על סגירה.
   מפתח ה-API החדש מופיע בדף Credentials בקטע API keys.
   (חשוב לזכור להגביל את מפתח ה-API לפני שמשתמשים בו בסביבת הייצור).

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

למידע נוסף על Google Cloud SDK , התקנת Cloud SDK , ועל הפקודות הבאות:

• gcloud alpha services api-keys create

הגבלת מפתחות API

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

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

כך מגבילים מפתח API:

מסוף

1. עוברים לדף הפלטפורמה של מפות Google > פרטי כניסה.

   כניסה לדף Credentials

2. בוחרים את מפתח ה-API שרוצים להגדיר עליו הגבלה. יופיע הדף של המאפיין של מפתח API.
3. בקטע Key restrictions, מגדירים את ההגבלות הבאות:
• הגבלות על אפליקציות:
1. כדי לקבל בקשות מרשימת כתובות ה-IP של שרתי האינטרנט שאתם מספקים, בוחרים באפשרות IP addresses (שרתי אינטרנט, משימות cron וכו') מהרשימה Application restrictions. צריך לציין כתובת IPv4 או IPv6 אחת או יותר, או רשת משנה, באמצעות סימון CIDR. כתובות ה-IP חייבות להיות זהות לכתובת המקור שמזהים לשרתים של הפלטפורמה של מפות Google. אם אתם משתמשים בתרגום כתובת רשת (NAT), בדרך כלל הכתובת הזו תהיה תואמת לכתובת ה-IP הציבורית של המכשיר שלכם.
• הגבלות על ממשקי API:
1. לוחצים על Restrict key.
2. בוחרים באפשרות Address Validation API (ממשק API לאימות כתובת) בתפריט הנפתח Select APIs. אם ה-Address Validation API לא מופיע ברשימה, עליכם להפעיל אותו.
4. כדי להשלים את השינויים, לוחצים על שמירה.
   

Cloud SDK

רשום את המפתחות הקיימים.

gcloud services api-keys list --project="PROJECT"

ניקוי ההגבלות הקיימות במפתח הקיים.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

הגדרת הגבלות חדשות על המפתח הקיים.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="addressvalidation.googleapis.com"
    --allowed-ips="IP_ADDRESS"

למידע נוסף על Google Cloud SDK , התקנת Cloud SDK , ועל הפקודות הבאות:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

הוספת מפתח ה-API לבקשה

צריך לכלול מפתח API בכל בקשה של כתובת API לאימות כתובת. בדוגמה הבאה מחליפים את הערך YOUR_API_KEY במפתח ה-API שלכם.

https://addressvalidation.googleapis.com/v1:validateAddress?key=YOUR_API_KEY

חובה לציין HTTPS לבקשות שמשתמשות במפתח API.

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