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

בחירת פלטפורמה: Android iOS JavaScript שירות אינטרנט

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

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

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

כדי להתחיל להשתמש ב-Places API, צריך ליצור פרויקט עם חשבון לחיוב ולהפעיל את Places 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 ועל הפקודות הבאות:

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

Google ממליצה מאוד להגביל את השימוש במפתחות ה-API, ולהגביל את השימוש בהם רק לממשקי ה-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. בתפריט הנפתח Select APIs, בוחרים באפשרות Places API או Places API (חדש), אבל לא בשתיהן. אם Places API או Places API (חדש) לא מופיעים, צריך enable אותם.
  4. כדי להשלים את השינויים, לוחצים על שמירה.

Cloud SDK

Places API (חדש)

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

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="places.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

Places API

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

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="places-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

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

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

https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY

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