שימוש במפתחות API עם Distance Matrix API (דור קודם)

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

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

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

לפני שמתחילים להשתמש ב-Distance Matrix API (הדור הקודם), צריך פרויקט עם חשבון לחיוב ו-Distance Matrix API (הדור הקודם) מופעל. מידע נוסף זמין במאמר הגדרה במסוף Cloud.

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

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

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

המסוף

  1. נכנסים לדף Google Maps Platform > Credentials.

    כניסה לדף Credentials

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

Cloud SDK

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

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

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

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

כדי להגביל מפתח API:

המסוף

  1. נכנסים לדף Google Maps Platform > Credentials.

    כניסה לדף Credentials

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

Cloud SDK

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

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

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

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

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

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=distance-matrix-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

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

חובה לכלול מפתח API בכל בקשה ל-Distance Matrix API (דור קודם). בדוגמה הבאה, מחליפים את YOUR_API_KEY במפתח ה-API שלכם:

https://maps.googleapis.com/maps/api/distancematrix/json?origins=Seattle&destinations=San+Francisco&key=YOUR_API_KEY

אתם צריכים להשתמש ב-HTTPS לבקשות שמשתמשות במפתח API.