آشنایی با کلیدهای میانای برنامه‌سازی کاربردی برای Firebase و مدیریت آن‌ها

کلید میانای برنامه‌سازی کاربردی رشته‌ای یکتا است که برای مسیریابی درخواست‌ها به پروژه Firebase شما هنگام تعامل با Firebase و سرویس‌های Google استفاده می‌شود. این صفحه اطلاعات پایه درباره کلیدهای میانای برنامه‌سازی کاربردی و همچنین روال‌های مطلوب برای استفاده و مدیریت کلیدهای میانای برنامه‌سازی کاربردی با برنامه‌های Firebase را شرح می‌دهد.

اگر ایمیلی از Google Cloud درباره «کلید Google API با دسترسی عمومی برای پروژه Google Cloud» دریافت کرده‌اید و کلید API فهرست‌شده در ایمیل کلید Firebase API شما است، مطمئن شوید که کلید API الزامات زیر را برآورده می‌کند تا بتوانید آن را به‌طور ایمن در کد یا فایل‌های پیکربندی خود قرار دهید. می‌توانید موارد زیر را در صفحه APIs & Services (میاناهای برنامه‌سازی کاربردی و سرویس‌ها) > Credentials (اطلاعات کاربری) در کنسول Google Cloud درستی‌سنجی کنید.

همچنین، مطمئن شوید که از Firebase Security Rules و App Check طبق توصیه برای محصولات Firebase که استفاده می‌کنید استفاده می‌کنید.

می‌توانید جزئیات مربوط به کلیدهای میانای برنامه‌سازی کاربردی برای Firebase را یاد بگیرید و فهرستی از پرسشگان را در آشنایی با استفاده و مدیریت کلیدهای میانای برنامه‌سازی کاربردی برای Firebase پیدا کنید


بقیه این صفحه اطلاعات دقیقی درباره کلیدهای API برای Firebase و همچنین فهرستی از پرسشگان درباره این کلیدها ارائه می‌دهد.

اطلاعات کلی درباره کلیدهای میانای برنامه‌سازی کاربردی و Firebase

کلیدهای میانای برنامه‌سازی کاربردی برای Firebase با کلیدهای میانای برنامه‌سازی کاربردی معمولی متفاوت است

برخلاف نحوه استفاده معمول از کلیدهای میانای برنامه‌سازی کاربردی، کلیدهای میانای برنامه‌سازی کاربردی برای سرویس‌های Firebase برای کنترل دسترسی به منابع پس‌بک استفاده نمی‌شوند؛ این کار فقط با Firebase Security Rules (برای کنترل اینکه کدام کاربران نهایی می‌توانند به منابع دسترسی داشته باشند) و Firebase App Check (برای کنترل اینکه کدام برنامه‌ها می‌توانند به منابع دسترسی داشته باشند) انجام می‌شود.

معمولاً باید از کلیدهای API به‌دقت محافظت کنید (برای مثال، بااستفاده از سرویس گاوصندوق یا تنظیم کلیدها به‌عنوان متغیرهای محیطی)؛ بااین‌حال، کلیدهای API برای سرویس‌های Firebase را می‌توان در کد یا فایل‌های پیکربندی اعلام وضعیت گنجاند.

اگرچه کلیدهای میانای API برای سرویس‌های Firebase برای گنجاندن در کد ایمن هستند، باید محدودیت‌ها و حد مجازهای مناسب را برای آن‌ها مرور و اعمال کنید.

درحال ایجاد کلیدهای میانای برنامه‌سازی کاربردی

یک پروژه Firebase می‌تواند چندین کلید میانای برنامه‌سازی کاربردی داشته باشد، اما هر کلید میانای برنامه‌سازی کاربردی فقط می‌تواند با یک پروژه Firebase مرتبط باشد.

کلیدهای میانای برنامه‌سازی کاربردی که Firebase به‌طور خودکار برای «برنامه‌های Firebase» شما ایجاد کرده است

وقتی هریک از کارهای زیر را انجام دهید، Firebase به‌طور خودکار کلیدهای میانای API برای پروژه‌تان ایجاد می‌کند:

  • ایجاد پروژه Firebase > Browser key به‌طور خودکار ایجاد شد
  • ایجاد برنامه Firebase Apple > iOS key به‌طور خودکار ایجاد شد
  • ایجاد برنامه Android در Firebase > Android key به‌طور خودکار ایجاد شد

همچنین می‌توانید کلیدهای میانای API خودتان را در کنسول Google Cloud ایجاد کنید، برای مثال برای توسعه یا اشکال‌زدایی. درباره اینکه چه زمانی ممکن است این مورد توصیه شود در ادامه این صفحه بیشتر بدانید.

پیدا کردن کلیدهای میانای برنامه‌سازی کاربردی

می‌توانید همه کلیدهای API پروژه‌تان را در صفحه میاناهای برنامه‌سازی کاربردی و سرویس‌ها > اطلاعات کاربری در کنسول Google Cloud مشاهده و مدیریت کنید.

همچنین می‌توانید ببینید کدام کلید میانای برنامه‌سازی کاربردی به‌طور خودکار با برنامه Firebase مطابقت داده شده است. به‌طور پیش‌فرض، همه «برنامه‌های Firebase» پروژه شما برای پلاتفرم یکسان (Apple درمقابل Android درمقابل وب) از کلید میانای برنامه‌سازی کاربردی یکسانی استفاده خواهند کرد.

  • برنامه‌های Firebase Apple — کلید میانای برنامه‌سازی کاربردی مطابقت‌داده‌شده خودکار را در فایل پیکربندی Firebase، GoogleService-Info.plist، در فیلد API_KEY پیدا کنید.

  • برنامه‌های Android در Firebase — کلید میانای برنامه‌سازی کاربردی منطبق‌شده خودکار را در فایل پیکربندی Firebase، google-services.json، در فیلد current_key پیدا کنید.

  • برنامه‌های وب Firebase — کلید میانای برنامه‌سازی کاربردی منطبق‌شده خودکار را در شیء پیکربندی Firebase، در فیلد apiKey پیدا کنید.

استفاده از کلید میانای برنامه‌سازی کاربردی

کلیدهای میانای برنامه‌سازی کاربردی برای Firebase برای شناسایی پروژه Firebase شما هنگام تعامل با Firebase یا سرویس‌های Google استفاده می‌شوند. به‌طور خاص، از آن‌ها برای مرتبط کردن درخواست‌های API با پروژه‌تان برای سهمیه و صورت‌حساب استفاده می‌شود. این ابزارها برای دسترسی به داده‌های عمومی نیز مفید هستند.

برای اکثریت قریب به اتفاق توسعه‌دهندگان و موارد استفاده، شما مستقیماً با این کلیدهای میانای برنامه‌سازی کاربردی تعامل ندارید. درعوض، وقتی برنامه‌تان با Firebase API تماس می‌گیرد که به کلید میانای برنامه‌سازی کاربردی ارائه‌شده توسط کارخواه وب یا تلفن همراه نیاز دارد، برنامه‌تان به‌طور خودکار به‌دنبال کلید میانای برنامه‌سازی کاربردی در پیکربندی Firebase برنامه‌تان می‌گردد. این پیکربندی وقتی برنامه‌تان را به Firebase متصل کردید به پایگاه کد برنامه‌تان اضافه شد.

توجه داشته باشید که می‌توانید کلید میانای برنامه‌سازی کاربردی برنامه‌تان را بااستفاده از سازوکار دیگری، مثل گزینه‌های Firebase یا بااستفاده از متغیرهای محیطی، در برنامه‌تان ارائه دهید.

همچنین، برای برخی‌از APIهای REST برای سرویس‌های Firebase، ممکن است لازم باشد مقدار کلید API را به‌طور صریح به‌عنوان پارامتر پُرسمان به فراخوانی ارسال کنید. این مثال نشان می‌دهد که چگونه می‌توانید بااستفاده از میانای برنامه‌سازی کاربردی Firebase Authentication درخواست ارسال کنید:

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=API_KEY

محدودیت‌های مناسب را برای کلیدهای میانای برنامه‌سازی کاربردی مرور و اعمال کنید

برای همه کلیدهای میانای برنامه‌سازی کاربردی در پروژه‌تان، بسیار مهم است که مطمئن شوید محدودیت‌ها و حدود میانای برنامه‌سازی کاربردی مناسبی دارند، همان‌طور که در این بخش شرح داده شده است.

میاناهای برنامه‌سازی کاربردی را که به‌طور خودکار به فهرست مجاز کلیدهای میانای برنامه‌سازی کاربردی Firebase شما اضافه شده‌اند مرور کنید

وقتی Firebase کلید میانای API در پروژه‌تان ایجاد می‌کند، ما به‌طور خودکار «محدودیت‌های میانای API» به آن کلید اضافه می‌کنیم. میاناهای برنامه‌سازی کاربردی اضافه‌شده به این فهرست مجاز، میاناهای برنامه‌سازی کاربردی مرتبط با Firebase هستند که کارخواه را ملزم می‌کنند کلید میانای برنامه‌سازی کاربردی را همراه با تماس ارائه دهد. توجه داشته باشید که اکثر میاناهای برنامه‌سازی کاربردی موردنیاز برای استفاده از سرویس‌های Firebase درواقع لازم نیست در فهرست مجاز کلیدهای میانای برنامه‌سازی کاربردی شما باشند.

ازآنجایی‌که Firebase میاناهای برنامه‌سازی کاربردی لازم را برای همه سرویس‌های Firebase اضافه می‌کند، فهرست مجاز برای کلید میانای برنامه‌سازی کاربردی ممکن است شامل میاناهای برنامه‌سازی کاربردی برای محصولاتی باشد که از آن‌ها استفاده نمی‌کنید. می‌توانید APIها را از فهرست مجاز حذف کنید، اما باید بسیار مراقب باشید که APIهای موردنیاز برای Firebase و سرویس‌های Firebase را که استفاده می‌کنید حذف نکنید (فهرست APIهای مرتبط با Firebase را که باید در فهرست مجاز برای هر سرویس / محصول باشند ببینید). درغیراین‌صورت، هنگام برقراری تماس با سرویس‌های Firebase با خطا مواجه خواهید شد.

اگر از Authentication مبتنی بر گذرواژه استفاده می‌کنید، سهمیه را محدود کنید

اگر از Firebase Authentication مبتنی بر گذرواژه استفاده می‌کنید و کسی به کلید میانای برنامه‌سازی کاربردی شما دسترسی پیدا کند، نمی‌تواند به هیچ‌کدام از پایگاه‌های داده پروژه Firebase یا داده‌های Cloud Storage شما دسترسی پیدا کند تا زمانی که این داده‌ها توسط Firebase Security Rules محافظت می‌شوند. اما می‌توانند از کلید میانای برنامه‌سازی کاربردی شما برای دسترسی به نقاط پایانی اصالت‌سنجی Firebase و ارسال درخواست‌های اصالت‌سنجی به پروژه‌تان استفاده کنند.

برای کاهش احتمال سوءاستفاده از کلید میانای برنامه‌سازی کاربردی برای حمله جستجوی فراگیر، می‌توانید سهمیه پیش‌فرض نقطه‌های پایانی identitytoolkit.googleapis.com را محدود کنید تا ترافیک عادی موردانتظار برنامه‌تان را منعکس کند. توجه داشته باشید که اگر این سهمیه را محدود کنید و برنامه‌تان به‌طور ناگهانی کاربران بیشتری جذب کند، ممکن است تا زمانی که سهمیه را افزایش ندهید، خطاهای ورود به سیستم دریافت کنید. می‌توانید سهمیه‌های API پروژه‌تان را در کنسول Google Cloud تغییر دهید.

برای هر سرویس غیرFirebase، از کلیدهای میانای برنامه‌سازی کاربردی (API) جداگانه و محدودشده استفاده کنید

اگرچه کلیدهای میانای برنامه‌سازی کاربردی که برای سرویس‌های Firebase استفاده می‌شوند معمولاً نیازی به رفتار محرمانه ندارند، باید اقدامات احتیاطی بیشتری را درخصوص کلیدهای میانای برنامه‌سازی کاربردی که با دیگر میاناهای برنامه‌سازی کاربردی Google Cloud استفاده می‌کنید انجام دهید.

اگر از میانای برنامه‌سازی کاربردی Google Cloud (در هر پلاتفرمی) استفاده می‌کنید که برای سرویس/ محصول Firebase نیست، اکیداً توصیه می‌کنیم کلیدهای میانای برنامه‌سازی کاربردی محدودشده جداگانه‌ای برای استفاده با آن میاناهای برنامه‌سازی کاربردی ایجاد کنید. اگر API برای سرویس قابل‌صورت‌حساب Google Cloud باشد، این موضوع بسیار مهم است. به‌ویژه، هرگز Gemini Developer API را در فهرست مجاز برای کلید میانای برنامه‌سازی کاربردی با دسترسی عمومی یا کلیدی که برای سرویس‌های دیگر استفاده می‌شود قرار ندهید.

بااستفاده از کلیدهای میانای برنامه‌سازی کاربردی جداگانه و محدودشده برای میاناهای برنامه‌سازی کاربردی غیرFirebase، می‌توانید درصورت لزوم کلیدها را بچرخانید یا جایگزین کنید و محدودیت‌های بیشتری به کلیدهای میانای برنامه‌سازی کاربردی اضافه کنید بدون اینکه استفاده شما از سرویس‌های Firebase مختل شود.

استفاده از کلیدهای میانای برنامه‌سازی کاربردی مختص محیط

اگر پروژه‌های Firebase مختلفی را برای محیط‌های مختلف، مانند مرحله‌بندی و تولید، راه‌اندازی کرده‌اید، مهم است که هر نمونه برنامه با پروژه Firebase مربوطه خود تعامل داشته باشد. برای مثال، نمونه برنامه مرحله‌بندی شما هرگز نباید با پروژه Firebase تولید شما ارتباط برقرار کند. این یعنی برنامه مرحله آماده‌سازی شما باید از کلیدهای میانای برنامه‌سازی کاربردی مرتبط با پروژه Firebase مرحله آماده‌سازی شما استفاده کند.

برای کاهش مشکلات مربوط به ارتقای تغییرات کد از مرحله توسعه به مرحله آماده‌سازی و سپس به مرحله تولید، به‌جای گنجاندن کلیدهای میانای برنامه‌سازی کاربردی در خود کد، آن‌ها را به‌عنوان متغیرهای محیطی تنظیم کنید یا در فایل پیکربندی بگنجانید.

پرسشگان و عیب‌یابی

پرسشگان

عیب‌یابی