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

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

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

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

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

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

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

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

מסוף

1. עוברים לדף Google Maps Platform > Credentials (הפלטפורמה של מפות Google > פרטי כניסה).

   לדף Credentials

2. בדף Credentials, לוחצים על Create credentials > API key.
   תיבת הדו-שיח API key created מציגה את מפתח ה-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 Maps Platform > Credentials (הפלטפורמה של מפות Google > פרטי כניסה).

   לדף Credentials

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

הערה:כשמשתמשים בשירותי אינטרנט, כל התווים המיוחדים שבתוך הפרמטרים צריכים להיות מקודדים לכתובות URL. כתובות URL חייבות להיות מקודדות כראוי כדי שיהיו חוקיות ומוגבלות ל-2048 תווים לכל שירותי האינטרנט. חשוב לשים לב למגבלה הזו כשיוצרים את כתובות ה-URL. גם לדפדפנים, בשרתי proxy ובשרתים שונים יכולות להיות מגבלות תווים שונות על כתובות URL.