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

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

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

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

יצירת מפתחות 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, צריך לספק את טביעת האצבע לאישור SHA-1 של מפתח החתימה ששימש לחתימה על האפליקציה. יש שני סוגי אישורים:

  • אישור לניפוי באגים: צריך להשתמש בסוג האישור הזה רק באפליקציות שבודקים וקודים אחרים ללא ייצור. לא לנסות לפרסם אפליקציה שנחתמה באמצעות ניפוי באגים אישור. הכלים ל-Android SDK יוצרים את האישור הזה באופן אוטומטי כשמריצים ניפוי באגים build.
  • אישור הפצה: השתמשו באישור הזה כשתהיו מוכנים לפרסם את את האפליקציה לחנות אפליקציות. הכלים ל-Android SDK יוצרים את האישור הזה כשמריצים גרסת 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 (New). מהתפריט הנפתח Select APIs, אבל לא את שניהם. אם Places API לא מופיע ברשימה, עליך להפעיל אותו.
  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.