שימוש במפתחות 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 key.
   תיבת הדו-שיח מפתח API שנוצר מציגה את מפתח ה-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 בתפריט הנפתח Select APIs. אם ה-API לאימות כתובת לא מופיע, צריך enable אותו.
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 צריכות להיות מקודדות באופן תקין כדי שיהיו חוקיות ומוגבלות ל-2,048 תווים בכל שירותי האינטרנט. חשוב לשים לב למגבלה הזו כשיוצרים את כתובות ה-URL. גם לדפדפנים, לשרתי proxy ולשרתים שונים יכולות להיות מגבלות תווים שונות בכתובות URL.