המוצרים של הפלטפורמה של מפות Google מאובטחים מפני שימוש לא מורשה על ידי הגבלת הקריאות ל-API למשתמשים שמספקים פרטי כניסה תקינים לאימות. פרטי הכניסה האלה הם בצורה של מפתח API – מחרוזת אלפאנומרית ייחודית, שמשייכת את החשבון לחיוב ב-Google לפרויקט שלך ול-API או ה-SDK הספציפיים.
במדריך הזה מוסבר איך ליצור מפתח API, להגביל אותו ולהשתמש בו בפלטפורמה של מפות Google.
לפני שמתחילים
לפני שתתחילו להשתמש ב-Geolocation API, תצטרכו ליצור פרויקט עם חשבון לחיוב שמופעל בו ה-Geolocation API. מידע נוסף זמין במאמר הגדרה במסוף Cloud.
יצירת מפתחות API
מפתח ה-API הוא מזהה ייחודי שמאמת בקשות שמשויכות לפרויקט שלך למטרות שימוש וחיוב. צריך להיות לכם לפחות מפתח API אחד שמשויך לפרויקט.
כך יוצרים מפתח API:
מסוף
-
עוברים לדף הפלטפורמה של מפות Google > פרטי כניסה.
-
בדף Credentials, לוחצים על Create credentials > מפתח API.
תיבת הדו-שיח API key created מציגה את מפתח ה-API החדש שיצרתם. -
לוחצים על סגירה.
מפתח ה-API החדש מופיע בדף Credentials בקטע API keys.
(חשוב לזכור להגביל את מפתח ה-API לפני שמשתמשים בו בסביבת הייצור).
Cloud SDK
gcloud alpha services api-keys create \ --project "PROJECT" \ --display-name "DISPLAY_NAME"
למידע נוסף על Google Cloud SDK , התקנת Cloud SDK , ועל הפקודות הבאות:
הגבלת מפתחות API
Google ממליצה מאוד להגביל את מפתחות ה-API על ידי הגבלת השימוש בהם רק לממשקי ה-API הנדרשים לאפליקציה. הגבלת מפתחות API מוסיפה אבטחה לאפליקציה כי היא מגינה עליה מפני בקשות לא מוצדקות. מידע נוסף זמין במאמר שיטות מומלצות לאבטחת API.
כך מגבילים מפתח API:
מסוף
-
עוברים לדף הפלטפורמה של מפות Google > פרטי כניסה.
- בוחרים את מפתח ה-API שרוצים להגדיר עליו הגבלה. יופיע הדף של המאפיין של מפתח API.
- בקטע Key restrictions, מגדירים את ההגבלות הבאות:
- הגבלות על אפליקציות:
- כדי לקבל בקשות מרשימת כתובות ה-IP של שרתי האינטרנט שאתם מספקים, בוחרים באפשרות IP addresses (שרתי אינטרנט, משימות cron וכו') מהרשימה Application restrictions. צריך לציין כתובת IPv4 או IPv6 אחת או יותר, או רשת משנה, באמצעות סימון CIDR. כתובות ה-IP חייבות להיות זהות לכתובת המקור שמזהים לשרתים של הפלטפורמה של מפות Google. אם אתם משתמשים בתרגום כתובת רשת (NAT), בדרך כלל הכתובת הזו תהיה תואמת לכתובת ה-IP הציבורית של המכשיר שלכם.
- הגבלות על ממשקי API:
- לוחצים על Restrict key.
- בוחרים באפשרות Geolocation API בתפריט הנפתח Select APIs. אם Geolocation API לא מופיע ברשימה, עליך להפעיל אותו.
- כדי להשלים את השינויים, לוחצים על שמירה.
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="geolocation.googleapis.com" --allowed-ips="IP_ADDRESS"
למידע נוסף על Google Cloud SDK , התקנת Cloud SDK , ועל הפקודות הבאות:
הוספת מפתח ה-API לבקשה
עליכם לכלול מפתח API בכל בקשה של Geolocation API. בדוגמה הבאה מחליפים את הערך YOUR_API_KEY
במפתח ה-API שלכם.
https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY
חובה לציין HTTPS לבקשות שמשתמשות במפתח API.