שימוש במפתחות API

שימוש במפתחות API

יצירת מפתחות 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, מגדירים את ההגבלות הבאות:
    • הגבלות על אפליקציות:
    • הגבלות על ממשקי API:
      1. לוחצים על Restrict key.
      2. בוחרים באפשרות Navigation SDK בתפריט הנפתח Select APIs. אם ערכת ה-SDK לניווט לא מופיעה ברשימה, עליך להפעיל אותו.
  4. כדי להשלים את השינויים, לוחצים על שמירה.

CLI של gcloud

הצגת רשימה של המפתחות הקיימים. 

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="navigationsdk.googleapis.com"

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