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

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

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

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

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

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

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

מסוף

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

    כניסה לדף Credentials

  2. בדף Credentials, לוחצים על Create credentials > API key.
    תיבת הדו-שיח API key created מציגה את מפתח ה-API החדש שיצרתם.
  3. לוחצים על סגירה.
    מפתח ה-API החדש מופיע בדף Credentials בקטע מפתחות API.
    (חשוב לזכור להגביל את המפתח של ה-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, צריך לספק את טביעת האצבע לאישור SHA-1 של מפתח החתימה ששימש לחתימה על האפליקציה. יש שני סוגי אישורים:

  • אישור ניפוי באגים: יש להשתמש בסוג האישור הזה רק באפליקציות שבודקים ובקוד אחר ללא ייצור. אין לנסות לפרסם אפליקציה שחתומה באמצעות אישור ניפוי באגים. הכלים ל-Android SDK יוצרים את האישור הזה באופן אוטומטי כשמריצים build לניפוי באגים.
  • אישור גרסאות: אפשר להשתמש באישור הזה כשרוצים לפרסם את האפליקציה לחנות אפליקציות. הכלים ל-Android SDK יוצרים את האישור הזה כשמריצים גרסת build.

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

לקבלת הוראות לאיתור טביעת האצבע של אישור החתימה, עיינו בהפניות הבאות:

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

מסוף

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

    כניסה לדף Credentials

  2. בוחרים את מפתח ה-API שרוצים להגדיר עליו הגבלה. הדף של נכס מפתח ה-API מופיע.
  3. בקטע הגבלות עיקריות, מגדירים את ההגבלות הבאות:
    • הגבלות על אפליקציות:
      1. בוחרים באפשרות אפליקציות ל-Android.
      2. לוחצים על + הוספת שם חבילה וטביעת אצבע.
      3. מזינים את שם החבילה ואת טביעת האצבע לאישור SHA-1. לדוגמה: 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • הגבלות על ממשקי API:
      1. לוחצים על Restrict key.
      2. בוחרים באפשרות SDK של מפות ל-Android מהתפריט הנפתח בחירת ממשקי API. אם ה-SDK של מפות Google ל-Android לא מופיע ברשימה, עליכם להפעיל אותו.
  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="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

מה השלב הבא?

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