שימוש במפתחות API עם Air Quality API

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

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

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

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

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

המסוף

  1. עוברים לדף פלטפורמת מפות 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 > פרטי כניסה.

    כניסה לדף 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, בוחרים באפשרות Air Quality API. אם Air Quality 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/locations/global/keys/KEY_ID \
    --api-target=service=airquality.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

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

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

https://airquality.googleapis.com/v1/currentConditions:lookup?key=YOUR_API_KEY

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