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

בחירת פלטפורמה: Android iOS JavaScript Web Service
מפתחים באזור הכלכלי האירופי (EEA)

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

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

יצירת מפתחות 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 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 יוצרים את האישור הזה כשמריצים גרסה זמינה ל-release.

למידע נוסף על חתימת אפליקציות ב-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 לא מופיע ברשימה, צריך להפעיל אותו.
  4. כדי לסיים את השינויים, לוחצים על שמירה.

Cloud SDK

Places SDK ל-Android (חדש)

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

gcloud services api-keys list --project="PROJECT"

ביטול ההגבלות הקיימות על מפתח קיים. 

gcloud services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

להגדיר הגבלות חדשות על מפתח קיים. 

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=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 services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

להגדיר הגבלות חדשות על מפתח קיים. 

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=places-backend.googleapis.com
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

המאמרים הבאים

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