איך משתמשים במפתחות API ל-Firebase ומנהלים אותם

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

אלה הדברים שהכי חשוב ללמוד על מפתחות API ל-Firebase:

• ממשקי API שקשורים ל-Firebase משתמשים במפתחות API רק כדי לזהות את הפרויקט או האפליקציה ב-Firebase. לא להרשאה לקרוא ל-API (כמו חלק מממשקי ה-API האחרים ). מתבצע טיפול בהרשאות לממשקי API שקשורים ל-Firebase בנפרד ממפתח ה-API, באמצעות הרשאות IAM מסוג Google Cloud, Firebase Security Rules או Firebase App Check. לכן, מותר לכלול בקוד מפתחות API של Firebase כשמשתמשים בהם רק עם ממשקי API שקשורים ל-Firebase.
• מומלץ לעיין לבדוק ולהחיל את ההגבלות המתאימות ומוגבל לכל מפתחות ה-API שלכם (גם למפתחות API של Firebase). באופן ספציפי, הגבילו את המפתח לממשקי ה-API שבהם אתם משתמשים בפועל באפליקציה ולהגביל את המכסה, לפי הצורך. שימו לב כל הפריטים שהוקצו ל-Firebase למפתחות API יש 'הגבלות על ממשקי API' מוחלת כברירת מחדל.
• שימוש במפתחות API שהוקצו ל-Firebase רק לצורך ממשקי API שקשורים ל-Firebase. עבור כל שאר ממשקי ה-API (לדוגמה, Places API למפות Google או ב-Google AI Gemini API), מפתח API נפרד.
• מומלץ מאוד לאבטח את Realtime Database, Cloud Firestore ו-Cloud Storage נתונים באמצעות Firebase Security Rules. לא מסתמכים רק על הגבלות על מפתחות API.

מידע כללי על מפתחות API ו-Firebase

מפתחות API ל-Firebase שונים ממפתחות API רגילים

בניגוד לאופן שבו משתמשים בדרך כלל במפתחות API, מפתחות API לשירותי Firebase הם לא משמשת לשליטה בגישה למשאבים בקצה העורפי; שאפשר לעשות רק עם Firebase Security Rules (כדי לקבוע לאילו משתמשי קצה תהיה גישה למשאבים) וגם Firebase App Check (כדי לקבוע לאילו אפליקציות תהיה גישה למשאבים).

בדרך כלל צריך להגן במהירות על מפתחות API (לדוגמה, על ידי שימוש בשירות Vault או הגדרת המפתחות כמשתני סביבה), עם זאת, אפשר לכלול מפתחות API של שירותי Firebase בקוד או בהגדרות לצ'ק-אין .

אפשר להוסיף לקוד מפתחות API של שירותי Firebase, אבל מומלץ לבדוק ולהחיל את ההגבלות והמגבלות המתאימות.

אבטחה של Realtime Database, Cloud Firestore וגם Cloud Storage נתונים באמצעות Firebase Security Rules. לא להסתמך רק על הגבלה ו/או להסתיר את מפתחות ה-API.

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

לפרויקט Firebase יכולים להיות הרבה מפתחות API, אבל כל מפתח API יכול להיות רק שמשויכים לפרויקט Firebase אחד.

מערכת Firebase יוצרת מפתחות API לפרויקט באופן אוטומטי בכל פעם הבאים:

• יצירת פרויקט Firebase > Browser key נוצר באופן אוטומטי
• יצירת אפליקציה ל-Apple ב-Firebase > iOS key נוצרה באופן אוטומטי
• יצירת אפליקציית Firebase ל-Android > Android key נוצר באופן אוטומטי

חשוב: מפתחות ה-API שנוצרים באופן אוטומטי על ידי Firebase כברירת מחדל נוצרים באופן אוטומטי מוגבל לרשימה של ממשקי API שמחייבים את הלקוח לספק מפתח API יחד עם השיחה. לעיון בשאלות הנפוצות האם מפתחות ה-API של שירותי Firebase מוגבלים כברירת מחדל?

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

איך לאתר מפתחות API

אפשר להציג ולנהל את כל מפתחות ה-API של הפרויקט ב ממשקי API שירותים > פרטי כניסה במסוף Google Cloud.

אפשר גם למצוא איזה מפתח API מותאם באופן אוטומטי אפליקציות Firebase במקומות הבאים. על ידי כברירת מחדל, כל אפליקציות Firebase בפרויקט של הפרויקט לאותה פלטפורמה (Apple לעומת Android לעומת אינטרנט) ישתמשו באותו מפתח API.

• Firebase Apple Apps – מוצאים את מפתח ה-API המותאם אוטומטית ב-Firebase בקובץ התצורה GoogleService-Info.plist, שדה API_KEY.

• אפליקציות Firebase ל-Android — מוצאים את מפתח ה-API בהתאמה אוטומטית בקטע קובץ התצורה של Firebase, google-services.json, בקטע שדה current_key.

• אפליקציות אינטרנט ב-Firebase – מוצאים את מפתח ה-API המותאם אוטומטית ב-Firebase אובייקט config, בשדה apiKey.

שימוש במפתח API

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

לדוגמה, אפשר להשתמש במפורש במפתח API על ידי העברת הערך שלו ל-REST קריאה ל-API כפרמטר של שאילתה. הדוגמה הזו מראה איך אפשר לשלוח בקשה ל Dynamic Links link ⌘er API:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=API_KEY

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

בדיקה והחלה של ההגבלות המתאימות על מפתחות API (מומלץ)

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

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

הערה: אם במפתח ה-API שבו משתמשים לשירותי Firebase יש 'הגבלות על ממשקי API' ומופיעה הודעת השגיאה API_KEY_SERVICE_BLOCKED או השגיאה 403 אסור, צריך לוודא שמפתח ה-API כולל את כל חובה לכלול ממשקי API בקטע 'הגבלות על ממשקי API' של המפתח רשימת היתרים.

בדיקת ממשקי ה-API שנוספו אוטומטית לרשימת ההיתרים של מפתחות Firebase API שלכם

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

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

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

כדאי להקפיץ את המכסה בשימוש ב-Authentication שמבוסס על סיסמה

לא משנה באיזו אפשרות אימות משתמשים, לאבטח את Realtime Database, Cloud Firestore ו-Cloud Storage נתונים באמצעות Firebase Security Rules.

אם אתם משתמשים ב-Firebase Authentication שמבוסס על סיסמה ומישהו מקבל גישה למפתח ה-API, הוא לא יוכל לגשת למסדי הנתונים או לנתוני Cloud Storage של פרויקט Firebase כל עוד הנתונים האלה מוגנים על ידי Firebase Security Rules. עם זאת, הוא יכול להשתמש במפתח ה-API שלכם כדי לגשת נקודות הקצה לאימות ב-Firebase ובקשות אימות כנגדן בפרויקט שלכם.

כדי למנוע את האפשרות שמישהו ישתמש לרעה במפתח API כדי לנסות לבצע תקיפה מסוג Brute Force, אפשר להגביל את מכסת ברירת המחדל של identitytoolkit.googleapis.com נקודות קצה (endpoint) שמשקפות את התנועה הרגילה של הציפיות שלנו מהאפליקציה. חשוב לדעת שאם תגבילו את המכסה הזו ואת האפליקציה שלכם רווחי משתמשים פתאום, ייתכן שתקבלו שגיאות כניסה עד שתגדילו את המכסה. תוכלו לשנות את מכסות ה-API בפרויקט שלכם מסוף Google Cloud.

שימוש במפתחות API נפרדים ומוגבלים לכל שירות שאינו Firebase

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

אם משתמשים ב-API של Google Cloud (בכל פלטפורמה) שלא מיועד ל-Firebase שירות / מוצר, מומלץ מאוד ליצור מפתחות API נפרדים ומוגבלים לשימוש עם ממשקי ה-API האלה. זה חשוב במיוחד אם ה-API מיועד שירות Google Cloud שניתן לחיוב.

לדוגמה, אם משתמשים ב-Firebase ML ובממשקי API של Cloud Vision ב-iOS, צריך ליצור מפתחות API נפרדים שבהם משתמשים רק בשביל גישה לממשקי Cloud Vision API.

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

הוראות ליצירת מפתחות ספציפיים ל-API

בהוראות האלה מוסבר איך ליצור מפתח API מוגבל ונפרד API מזויף שנקרא Super Service API.

שלב 1: מגדירים את מפתחות ה-API הקיימים כך שלא יאפשרו גישה ל-Super Service API

1. פותחים את Credentials בדף במסוף Google Cloud. כשתתבקשו, בוחרים את הפרויקט.

2. פותחים את תצוגת העריכה לכל מפתח API קיים ברשימה.

3. בקטע API restrictions, בוחרים באפשרות Restrict key ומוסיפים לרשימה את כל ממשקי ה-API שרוצים לתת למפתח ה-API גישה אליהם. לוודא לא לכלול את ה-API שעבורו אתם יוצרים מפתח API נפרד (בדוגמה הזו, Super Service API).

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

מעכשיו, מפתחות ה-API הקיימים לא יעניקו גישה אל Super Service API, אבל כל מפתח ימשיך לפעול בממשקי API שהוספת לו רשימה של הגבלות על ממשקי API.

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

שלב 2: יוצרים מפתח API חדש ומשתמשים בו כדי לגשת אל Super Service API

1. חוזרים אל Credentials הדף הזה. צריך לוודא שפרויקט Firebase עדיין נבחר.

2. לוחצים על Create credentials > מפתח API. שימו לב למפתח ה-API החדש, ואז לוחצים על Restrict key.

3. בקטע API restrictions, בוחרים באפשרות Restrict key, ואז מוסיפים את מציינים רק את Super Service API.

   מפתח ה-API החדש הזה מעניק גישה רק ל-Super Service API.

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

שימוש במפתחות API שספציפיים לסביבה (מומלץ)

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

כדי לצמצם בעיות שמקדמות שינויים בקוד מפיתוח ל-Staging בסביבת הייצור, במקום לכלול מפתחות API בקוד עצמו, להגדיר אותם בתור את משתני הסביבה, או לכלול אותם בקובץ תצורה.

חשוב לשים לב שאם משתמשים ב-Firebase Local Emulator Suite לפיתוח לצד ב-Firebase ML, עליך ליצור מפתח API לניפוי באגים בלבד ולהשתמש בו. הוראות להתאמה אישית ליצירת מפתח כזה. Firebase ML מסמכים.

שאלות נפוצות ופתרון בעיות

שאלות נפוצות

הם מפתחות API לשירותי Firebase שמוגבלים כברירת מחדל?

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

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

מכיוון שמערכת Firebase מוסיפה את ממשקי ה-API הנדרשים לכל שירותי Firebase, רשימת ההיתרים של מפתח API עשויה לכלול ממשקי API למוצרים שאתם לא משתמשים בהם. שלך יכולים להסיר ממשקי API מרשימת ההיתרים, אבל צריך להיזהר מאוד ממשקי ה-API הנדרשים ל-Firebase ולשירותי Firebase שבהם אתם משתמשים (עיינו רשימת ממשקי ה-API שקשורים ל-Firebase צריכים להיות ברשימת ההיתרים של כל שירות או מוצר). אחרת, יזוהו שגיאות בזמן ביצוע קריאות לשירותי Firebase.

חשוב: אף אחד מממשקי ה-API שקשורים ל-Firebase לא משתמש במפתח API בתור הרשאה לשליחת קריאה ל-API. מפתח ה-API שהועבר עם הקריאה ל-API משמש רק למטרות הבאות: מזהה את הפרויקט או האפליקציה של Firebase.

אפשר להציג את כל מפתחות ה-API ואת 'ההגבלות על ממשקי ה-API' שלהם ב ממשקי API ו שירותים > פרטי כניסה במסוף Google Cloud.

חשוב לשים לב לפרטים הבאים לגבי האופן שבו מערכת Firebase מחילה את 'ההגבלות על ממשקי ה-API':

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

• במהלך מאי 2024, כל מפתחות ה-API הקיימים והלא מוגבלים שהיו ל-Firebase שהוקצו באופן אוטומטי בעבר, מוגבלים רשימת ממשקי ה-API שקשורים ל-Firebase וגם כל ממשקי ה-API בפרויקט שמופעלים כרגע בפרויקט.

• מפתחות API קיימים שכבר מוגבלים שהיו ל-Firebase בעבר ניהול ההקצאות האוטומטי לא השתנה.

• מפתחות API קיימים שלא הוקצהו באופן אוטומטי על ידי Firebase השתנה.

חשוב: אם אתם משתמשים ב-API של Google Cloud (בכל פלטפורמה) שלא נועד השירות או המוצר של Firebase, מומלץ מאוד יצירת מפתחות API נפרדים ומוגבלים לשימוש עם ממשקי ה-API האלה.

איך אפשר לדעת איזה מפתח API משויך לאפליקציה ב-Firebase?

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

מסוף Firebase

1. צריך להיכנס אל הגדרות הפרויקט, ואז גוללים למטה אל הכרטיס האפליקציות שלך.

2. בוחרים את האפליקציה הרצויה.

3. מוצאים את קובץ התצורה או את האובייקט של Firebase בשביל האפליקציה הרצויה, ואז למצוא את מפתח ה-API שלו:

   • Apple: מורידים את GoogleService-Info.plist ואז מוצאים את השדה API_KEY

   • Android: מורידים את google-services.json, מוצאים את ההגדרה של את האפליקציה שמעניינת אותך (מחפשים את שם החבילה שלה), ואז מוצאים את השדה current_key

   • אינטרנט: בוחרים באפשרות הגדרה ואז מחפשים את השדה apiKey

Firebase CLI

1. כדי לקבל את קובץ התצורה או האובייקט של Firebase לאפליקציה הרלוונטית, מריצים את הפקודה הבאה:

   firebase apps:sdkconfig PLATFORM FIREBASE_APP_ID

   • PLATFORM (אחת מתוך): IOS | ANDROID | WEB
   • FIREBASE_APP_ID: המזהה הייחודי שהוקצה על ידי Firebase עבור אפליקציית Firebase (איתור מזהה האפליקציה)

2. בתצורת Firebase המודפסת של האפליקציה, מחפשים את מפתח ה-API שלה:

   • Apple: מחפשים את השדה API_KEY

   • Android: מחפשים את קובץ התצורה של האפליקציה הרצויה (מחפשים את שם החבילה שלה) ואז מחפשים את השדה current_key.

   • אינטרנט: מאתרים את השדה apiKey

API ל-REST

1. מקבלים את ה-apiKeyId (ה-UID) של מפתח ה-API על ידי שליחת קריאה ל את נקודת הקצה הרלוונטית של האפליקציה הרלוונטית, ולאחר מכן מעבירים את apiKeyId לשלב הבא.

   • Apple: התקשרות אל projects.iosApps.get
   • Android: שיחה אל projects.androidApps.get
   • אינטרנט: התקשרות אל projects.webApps.get

2. כדי לקבל את מחרוזת מפתח ה-API צריך לשלוח קריאה projects.locations.keys.getKeyString

   ה-keyString הזה הוא אותו הערך שמופיע בדף האפליקציה ארטיפקט של הגדרה (Apple | Android | אינטרנט).

האם אפשר רשומים שני מפתחות API לאותה אפליקציית Firebase בהגדרה של Firebase לקובץ/לאובייקט?

• Firebase Apple Apps — לכל אפליקציה יש קובץ תצורה משלה, שיכול להיות לו רק רשום מפתח API אחד.

• אפליקציות Firebase ל-Android — כל האפליקציות ל-Android בפרויקט Firebase רשומות באותו קובץ תצורה, ולכל אפליקציה יכול להיות רק מפתח API אחד רשום. לכל אפליקציה בקובץ התצורה הזה יכול להיות מפתח שונה, אבל.

• אפליקציות אינטרנט של Firebase – לכל אפליקציה יש אובייקט הגדרה משלה ויכול להיות רק רשום מפתח API אחד.

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

איך Firebase לדעת איזה מפתח API להתאים לאפליקציה (כמו בהגדרה של Firebase) קובץ/אובייקט)?

בפעם הראשונה שמקבלים את הקובץ או האובייקט של הגדרות Firebase של האפליקציה, מערכת Firebase בודקת אם יש בפרויקט מפתחות API קיימים עם Application Restrictions (הגבלות על אפליקציות) שתואמים לאפליקציה (לדוגמה, מזהה חבילה תואם לאפליקציה של Apple).

אם מערכת Firebase לא תמצא מפתחות מוגבלים תואמים, היא תופיע ב קובץ התצורה/האובייקט iOS key של אפליקציות Apple, ה-Android key של אפליקציות ל-Android והשדה Browser key של אפליקציות אינטרנט (בהנחה שהמפתחות האלה קיימים הן לא מכילות "הגבלות על אפליקציות". שמונעת מהם להתאים באפליקציה).

האם אפשר באופן ידני למחוק את מפתח ה-API והשדה מקובץ התצורה או מהאובייקט של Firebase?

כן, אפשר למחוק באופן ידני את מפתח ה-API מקובץ התצורה או מהאובייקט. אבל, לפעמים צריך לספק מנגנון אחר לאפליקציה כדי לגשת למפתח API (למשל באמצעות משתנה סביבה). אחרת, כל קריאה לשירותי Firebase ייכשל.

האם אפשר לערוך באופן ידני את קובץ התצורה או האובייקט של Firebase עם מפתחות API שונים?

כן, אפשר לערוך קובץ או אובייקט באופן ידני כדי לשייך מפתח API אחר באמצעות אפליקציה.

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

• מוודאים שמפתח ה-API בהיקף של מזהה הפרויקט שרשום בקטע קובץ תצורה/אובייקט.
• צריך לוודא שאין שגיאות "הגבלות על מפתחות API" שיעכבו את ה-API בשימוש באותה אפליקציה.
• מוודאים שמפתח ה-API כולל את 'ההגבלות על ממשקי ה-API' המתאימות הוחלו עליו. לצפייה של ממשקי API שקשורים ל-Firebase שצריכים להופיע ברשימת ההיתרים של כל אחד מהם שירות או מוצר של Firebase.

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

האם אפשר להעביר מפתח API מפרויקט Firebase אחד לפרויקט אחר?

לא, מפתח API מזהה רק פרויקט ספציפי ואי אפשר להעביר אותו לאחר פרויקט.

מה קורה אם מוחקים מפתח API שמופיע במסוף Google Cloud?

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

מחיקה של מפתח API היא פעולה בלתי הפיכה ואי אפשר לבטל אותה.

איזה נדרשים ממשקי API בקטע 'הגבלות על ממשקי API' להוסיף לרשימת ההיתרים מפתח API של Firebase?

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

חשוב: אף אחד מממשקי ה-API שקשורים ל-Firebase לא משתמש במפתח API בתור הרשאה לשליחת קריאה ל-API. מפתח ה-API שמוענק בקריאה ל-API משמש רק לזיהוי של הפרויקט או האפליקציה ב-Firebase.

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

אפשר להציג ולנהל את מפתחות ה-API של הפרויקט בחלונית APIs & Services > Credentials במסוף Google Cloud.

הערה: אם מופיעה הודעת השגיאה API_KEY_SERVICE_BLOCKED או שגיאה 403 אסורה בניסיון לשלוח קריאה ל-API שקשור ל-Firebase ולמפתח ה-API שבו אתם משתמשים, כל הנתונים את ממשקי ה-API הנדרשים שמפורטים בטבלה הזו, התמיכה של Firebase.

שם ה-API (שם השירות)	השם המוצג של ה-API	שירות או מוצר של Firebase
firebase.googleapis.com	Firebase Management API	כל המוצרים
logging.googleapis.com	Cloud Logging API	כל המוצרים
firebaseinstallations.googleapis.com	Firebase Installations API	Cloud Messaging, Crashlytics, In-App Messaging Performance Monitoring, Remote Config, Firebase ML
firebaseappcheck.googleapis.com	API לבדיקת אפליקציות ב-Firebase	App Check
firebaseappdistribution.googleapis.com	Firebase App Distribution API	App Distribution
firebaseapptesters.googleapis.com	API של Firebase לבדיקת אפליקציות	App Distribution
identitytoolkit.googleapis.com	ממשק API של Identity Toolkit	Authentication
securetoken.googleapis.com	Token Service API	Authentication
firebaseכללים.googleapis.com *	ממשק API של כללים ב-Firebase	Cloud Firestore,‏ Cloud Storage,‏ Realtime Database
datastore.googleapis.com	ממשק API של Cloud Datastore	Cloud Firestore
firestore.googleapis.com	ממשק ה-API של Google Cloud Firestore	Cloud Firestore
fcmregistrations.googleapis.com	ממשק API לרישום FCM	Cloud Messaging
firebasestorage.googleapis.com	Cloud Storage for Firebase API	Cloud Storage
firebasedynamiclinks.googleapis.com	API של קישורים דינמיים ב-Firebase	Dynamic Links
firebasehosting.googleapis.com *	ממשק API לאירוח ב-Firebase	Hosting
firebaseinappmessaging.googleapis.com	ממשק API של Firebase להעברת הודעות בתוך האפליקציה	In-App Messaging
firebaseml.googleapis.com	API של Firebase ML	Firebase ML, Vertex AI in Firebase
mlkit.googleapis.com **	ML Kit API	Firebase ML
mobilecrashreporting.googleapis.com	Mobile Crash Reporting API	Performance Monitoring
play.googleapis.com	ממשק API למפתח Google Play ב-Android	Performance Monitoring
firebaseremoteconfig.googleapis.com	API להגדרת תצורה מרחוק ב-Firebase	Performance Monitoring, Remote Config
firebaseremoteconfigrealtime.googleapis.com	API להגדרת תצורה מרחוק ב-Firebase	Performance Monitoring, Remote Config
cloudconfig.googleapis.com **	לא רלוונטי	Remote Config
firebasedatabase.googleapis.com *	Firebase Realtime Database API	Realtime Database

^{* חובה רק אם משתמשים במפתח ה-API של Firebase עם צד שלישי או גישה ישירה ל-REST לשירות או למוצר של Firebase.}

^{** חובה בגרסאות קודמות של ה-SDK של המוצר. אם אתם משתמשים את הגרסה האחרונה של ה-SDK, ה-API לא צריך להיות לרשימת ההיתרים.}

פתרון בעיות

איך משתמשים לתקן שגיאה מסוג API_KEY_SERVICE_BLOCKED או שגיאה 403 אסורה הבקשות ל-API הזה חסומות?

אם יש לך API_KEY_SERVICE_BLOCKED, כדאי לך לבצע את ההנחיות המפורטות בשאלות הנפוצות האלה. או שגיאה שנראית כך:

Forbidden: 403 POST https://example-service.googleapis.com/method: Requests to this API example-service.googleapis.com method google.example-service.rest.method are blocked.

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

• אם השגיאה הזו מופיעה כשאתם מנסים להשתמש בשירות או במוצר שקשור ל-Firebase, ודאו שכל ממשקי ה-API הנדרשים כלולים ברשימת ההיתרים 'הגבלות API' של המפתח.

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

איך משתמשים לתקן את השגיאה? "אחזור מזהה המדידה של אפליקציית Firebase הזו נכשל השרת".

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

קיבלתי אימייל או שגיאה מפתח ה-API שלי לא חוקי. מה קרה ואיך אפשר לתקן את זה?

הנה כמה מהסיבות הנפוצות ביותר למפתחות API לא חוקיים:

• למפתח ה-API הוחלו 'הגבלות על מפתחות API', כך שלא ניתן להתאים אותו לאפליקציה שמנסה להשתמש במפתח ('הגבלות על אפליקציות') או להשתמש בו בממשק ה-API שאליו קוראים ('הגבלות על ממשקי API').

• מפתח ה-API נמחק מהפרויקט במסוף Google Cloud.

• מפתח ה-API לא נוצר עבור מזהה הפרויקט שמופיע בקובץ או באובייקט התצורה של האפליקציה ב-Firebase.

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