שימוש במפתחות API עם ממשק API של דרכים

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

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

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

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

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

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

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

המסוף

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

    כניסה לדף Credentials

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

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

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

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

המסוף

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

    כניסה לדף Credentials

  2. בוחרים את מפתח ה-API שבו רוצים להגדיר הגבלה. יופיע דף המאפיין של מפתח API.
  3. בקטע Key restrictions, מגדירים את ההגבלות הבאות:
    • הגבלות על אפליקציות:
      1. כדי לקבל בקשות מרשימת כתובות ה-IP של שרתי האינטרנט שאתם מספקים, בוחרים באפשרות כתובות IP (שרתי אינטרנט, משימות cron וכו') מהרשימה של הגבלות על אפליקציות. מציינים כתובת IPv4 או IPv6 אחת או יותר, או תת-רשת עם סימון CIDR. כתובות ה-IP חייבות להתאים לכתובת המקור תצפית על השרתים של הפלטפורמה של מפות Google. אם משתמשים רשת תרגום כתובת (NAT), בדרך כלל כתובת ה-IP הזו תואמת לכתובת ה-IP הציבורית של המחשב שלך.
    • הגבלות על ממשקי API:
      1. לוחצים על Restrict key.
      2. בוחרים באפשרות Roads API בתפריט הנפתח Select APIs. אם Roads 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="roads.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

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

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

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

נדרש HTTPS בבקשות שמשתמשות במפתח API.