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

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

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

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

המסוף

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

   כניסה לדף Credentials

2. בדף Credentials, לוחצים על Create credentials > API key.
   תיבת הדו-שיח מפתח 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 והפקודות הבאות:

• gcloud alpha services api-keys create

הגבלת מפתחות API

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

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

כשמגבילים את מפתח ה-API, צריך לספק את טביעת האצבע לאישור SHA-1 של מפתח החתימה ששימש לחתימה על האפליקציה. יש שני סוגי אישורים:

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

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

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

• אם משתמשים בחתימת אפליקציה ב-Play, כדאי לעיין במאמר עבודה עם ספקי API.
• אם אתם מנהלים מפתח חתימה משלכם, תוכלו לעיין במאמר חתימה עצמית על האפליקציה או לעיין בהוראות שרלוונטיות לסביבת ה-build שלכם.

כדי להגביל מפתח 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. בוחרים באפשרות Navigation SDK בתפריט הנפתח Select APIs. אם ה-SDK לניווט לא מופיע ברשימה, עליך enable אותה.
הערה: ה-Navigation SDK זמין כרגע רק ללקוחות נבחרים. כדי להוסיף את ה-SDK לפרויקט ב-Google Cloud ולמפתח ה-API, צריך להפעיל את ה-SDK. למידע נוסף אפשר לפנות למחלקת המכירות.
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 והפקודות הבאות:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list