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

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

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

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

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

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

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

המסוף

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

    לדף Credentials

  2. בדף Credentials, לוחצים על Create credentials > מפתח API.
    תיבת הדו-שיח 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 לניפוי באגים.
  • פרסום אישור: יש להשתמש באישור הזה כשרוצים לפרסם את האפליקציה בחנות אפליקציות. כלי ה-SDK ל-Android יוצרים את האישור הזה כשמריצים גרסת build של גרסה.

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

להוראות על איתור טביעת האצבע של אישור החתימה, עיין בחומרי העזר הבאים:

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

המסוף

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

    לדף Credentials

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

Cloud SDK

Places SDK ל-Android (חדש)

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

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

SDK של מקומות ל-Android

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

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

מה השלב הבא

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