שימוש במפתחות API עם ממשק API של מטריצת מרחק

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

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

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

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

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

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

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

המסוף

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

    לדף Credentials

  2. בדף Credentials, לוחצים על Create credentials > API key.
    בתיבת הדו-שיח 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

מומלץ מאוד להגביל את מפתחות ה-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 jobs, etc.) (כתובות IP (שרתי אינטרנט, משימות cron וכו')) מתוך הרשימה Application restrictions (הגבלות על אפליקציות). מציינים כתובת IPv4 או IPv6 אחת או יותר, או תת-רשת באמצעות סימון CIDR. כתובות ה-IP צריכות להיות זהות לכתובת המקור שהשרתים של פלטפורמת מפות Google מזהים. אם אתם משתמשים בתרגום כתובות רשת (NAT), בדרך כלל זה יתאים לכתובת ה-IP הציבורית של המחשב.
    • הגבלות על ממשקי API:
      1. לוחצים על Restrict key.
      2. בתפריט הנפתח Select APIs (בחירת ממשקי API), בוחרים באפשרות Distance Matrix API (ממשק Distance Matrix API). אם Distance Matrix API לא מופיע ברשימה, צריך להפעיל אותו.
  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.