שימוש במפתחות API עם Roads API

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

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

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

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

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

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

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

מסוף

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

   כניסה לדף Credentials

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

Cloud SDK

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

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

• gcloud alpha services api-keys create

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

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

כשמגבילים מפתח API ב-Cloud Console, ההגבלות על אפליקציות מבטלות כל ממשקי API שמופעלים בהגבלות ה-API. כדאי לפעול לפי השיטות המומלצות על ידי יצירת מפתח API נפרד לכל אפליקציה ולכל פלטפורמה שבה היא זמינה.

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

מסוף

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

   כניסה לדף Credentials

2. בוחרים את מפתח ה-API שרוצים להגדיר עבורו הגבלה. הדף של נכס ה-API יופיע.
3. בקטע הגבלות מפתח, מגדירים את ההגבלות הבאות:
• הגבלות על אפליקציות:
1. כדי לאשר בקשות מרשימת כתובות ה-IP של שרתי האינטרנט שאתם מספקים, בוחרים באפשרות כתובות IP (שרתי אינטרנט, משימות cron וכו') מתוך הרשימה הגבלות על אפליקציות. יש לציין כתובת IPv4 או IPv6 אחת או תת-רשת אחת באמצעות סימון CIDR (למשל: 192.168.0.0/22). מאחר שבקשה לשירותי אינטרנט בודקת את כתובת ה-IP החיצונית ומשווה אותה להגבלה של מפתח ה-API, צריך להשתמש בכתובת ה-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 install ועל הפקודות הבאות:

• 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.