Firebase के लिए, एपीआई पासकोड इस्तेमाल और मैनेज करने के बारे में जानें

एपीआई पासकोड एक यूनीक स्ट्रिंग होती है, जिसका इस्तेमाल अनुरोधों को आपके Firebase पर भेजने के लिए किया जाता है Firebase और Google की सेवाओं के साथ इंटरैक्ट करते समय प्रोजेक्ट. इस पेज में बताया गया है कि एपीआई पासकोड के बारे में बुनियादी जानकारी, आपके एपीआई पासकोड के इस्तेमाल के सबसे सही तरीके और Firebase ऐप्लिकेशन की मदद से एपीआई पासकोड मैनेज किए जा सकते हैं.

Firebase के लिए एपीआई पासकोड के बारे में सबसे ज़रूरी बातें यहां दी गई हैं:

• Firebase से जुड़े एपीआई, एपीआई पासकोड का इस्तेमाल सिर्फ़ Firebase प्रोजेक्ट या ऐप्लिकेशन की पहचान करने के लिए करते हैं. एपीआई को कॉल करने के लिए, अनुमति देने के लिए इनका इस्तेमाल नहीं किया जाता. कुछ अन्य एपीआई ऐसा करते हैं. Firebase से जुड़े एपीआई के लिए अनुमति को मैनेज किया जाता है इसे एपीआई पासकोड से अलग किया जा सकता है. इसके लिए, Google Cloud की आईएएम अनुमतियों का इस्तेमाल करना होगा, Firebase Security Rules या Firebase App Check. इसलिए यह ठीक है अपने कोड में Firebase API कुंजियां शामिल तब करें, जब आप इनका इस्तेमाल सिर्फ़ Firebase से जुड़े एपीआई.
• हमारा सुझाव है कि आप अपनी सभी एपीआई कुंजियों (यहां तक कि Firebase एपीआई कुंजियों) के लिए, ज़रूरी पाबंदियां और सीमाएं देखें और उन्हें लागू करें. खास तौर पर, कुंजी को सिर्फ़ उन एपीआई तक सीमित रखें जिनका इस्तेमाल आपने वाकई में किया है और कोटा (जो भी लागू हो) को सीमित करेगा. ध्यान दें कि Firebase में प्रावधान किए गए सभी एपीआई पासकोड में "एपीआई से जुड़ी पाबंदियां" हैं डिफ़ॉल्ट रूप से लागू होता है.
• Firebase में प्रावधान की गई अपनी एपीआई कुंजियों का सिर्फ़ इस्तेमाल इनके लिए करें Firebase से जुड़े एपीआई. अन्य सभी एपीआई (उदाहरण के लिए, Maps के लिए Places API या Google AI Gemini API) के लिए, अलग एपीआई पासकोड का इस्तेमाल करें.
• हमारा सुझाव है कि आप Firebase Security Rules का इस्तेमाल करके, अपने Realtime Database, Cloud Firestore, और Cloud Storage डेटा को सुरक्षित करें. सिर्फ़ एपीआई पासकोड से जुड़ी पाबंदियों पर भरोसा न करें.

एपीआई पासकोड और Firebase के बारे में सामान्य जानकारी

Firebase के लिए एपीआई पासकोड, सामान्य एपीआई पासकोड से अलग होते हैं

आम तौर पर एपीआई पासकोड का इस्तेमाल करने के तरीके के उलट, Firebase सेवाओं के लिए एपीआई पासकोड का इस्तेमाल, बैकएंड संसाधनों के ऐक्सेस को कंट्रोल करने के लिए नहीं किया जाता. ऐसा सिर्फ़ Firebase Security Rules (यह कंट्रोल करने के लिए कि कौनसे असल उपयोगकर्ता संसाधनों को ऐक्सेस कर सकते हैं) और Firebase App Check (यह कंट्रोल करने के लिए कि कौनसे ऐप्लिकेशन संसाधनों को ऐक्सेस कर सकते हैं) की मदद से किया जा सकता है.

आम तौर पर, आपको एपीआई पासकोड को सुरक्षित रखने की ज़रूरत होती है. उदाहरण के लिए, वॉल्ट सेवा का इस्तेमाल करके या पासकोड को एनवायरमेंट वैरिएबल के तौर पर सेट करके. हालांकि, Firebase की सेवाओं के लिए एपीआई पासकोड को कोड या चेक इन की गई कॉन्फ़िगरेशन फ़ाइलों में शामिल किया जा सकता है.

हालांकि, कोड में Firebase सेवाओं के लिए एपीआई कुंजियां शामिल करना सुरक्षित है, लेकिन आपको सही पाबंदियां और सीमाएं देखें और उन्हें लागू करें.

अपने Realtime Database, Cloud Firestore, और Cloud Storage डेटा का उपयोग करके Firebase Security Rules. सिर्फ़ एपीआई पासकोड पर पाबंदी लगाने और/या उन्हें छिपाने पर भरोसा न करें.

एपीआई पासकोड बनाना

किसी Firebase प्रोजेक्ट में कई एपीआई पासकोड हो सकते हैं. हालांकि, हर एपीआई पासकोड को सिर्फ़ एक Firebase प्रोजेक्ट से जोड़ा जा सकता है.

Firebase आपके प्रोजेक्ट के लिए एपीआई कुंजियां अपने-आप बनाता है, जब आप इनमें से कोई भी काम करते हैं:

• Firebase प्रोजेक्ट बनाएं > Browser key अपने-आप बनने वाला
• Firebase Apple ऐप्लिकेशन बनाएं > iOS key अपने-आप बनने वाला
• Firebase Android ऐप्लिकेशन बनाएं > Android key अपने-आप बनाया गया

अहम जानकारी: डिफ़ॉल्ट रूप से, Firebase में अपने-आप बनने वाली एपीआई कुंजियां अपने-आप सिर्फ़ उन एपीआई की सूची तक सीमित है जिनके लिए क्लाइंट को एपीआई पासकोड देना होता है कॉल के साथ. अक्सर पूछे जाने वाले सवाल देखें क्या Firebase की सेवाओं के लिए एपीआई कुंजियों पर डिफ़ॉल्ट रूप से पाबंदी है?.

यहां अपनी एपीआई कुंजियां भी बनाई जा सकती हैं: Google Cloud कंसोल, उदाहरण के लिए, डेवलपमेंट या डीबगिंग के लिए. इसके बारे में ज़्यादा जानें , तो इस पेज पर बाद में इसका सुझाव दिया जा सकता है.

अपनी एपीआई कुंजियां ढूंढना

आप यहां अपने प्रोजेक्ट की सभी API (एपीआई) कुंजियां देख और प्रबंधित कर सकते हैं: API और सेवाएं > क्रेडेंशियल पैनल से Google Cloud कंसोल में जोड़ सकते हैं.

यहां यह भी देखा जा सकता है कि कौनसी एपीआई पासकोड, Firebase ऐप्लिकेशन से अपने-आप मैच हो जाता है. डिफ़ॉल्ट रूप से, एक ही प्लैटफ़ॉर्म (Apple बनाम Android बनाम वेब) के लिए, आपके प्रोजेक्ट के सभी Firebase ऐप्लिकेशन एक ही एपीआई पासकोड का इस्तेमाल करेंगे.

• Firebase के Apple ऐप्लिकेशन — API_KEY फ़ील्ड में, Firebase कॉन्फ़िगरेशन फ़ाइल, GoogleService-Info.plist में अपने-आप मैच होने वाली API कुंजी ढूंढें.

• Firebase के Android ऐप्लिकेशन — google-services.json फ़ील्ड में, Firebase कॉन्फ़िगरेशन फ़ाइल में अपने-आप मैच होने वाली एपीआई पासकोड ढूंढें.

• Firebase वेब ऐप्लिकेशन — apiKey फ़ील्ड में, Firebase कॉन्फ़िगरेशन ऑब्जेक्ट में अपने-आप मैच होने वाली एपीआई पासकोड ढूंढें.

एपीआई पासकोड का इस्तेमाल करना

एपीआई पासकोड का इस्तेमाल, Firebase/Google की सेवाओं के साथ इंटरैक्ट करते समय, आपके Firebase प्रोजेक्ट की पहचान करने के लिए किया जाता है. खास तौर पर, इनका इस्तेमाल कोटा और बिलिंग के लिए, एपीआई अनुरोधों को आपके प्रोजेक्ट से जोड़ने के लिए किया जाता है. वे Google की मदद से सार्वजनिक डेटा.

उदाहरण के लिए, किसी एपीआई पासकोड की वैल्यू को REST में पास करके, उसे साफ़ तौर पर इस्तेमाल किया जा सकता है एपीआई कॉल को क्वेरी पैरामीटर के तौर पर इस्तेमाल करना. इस उदाहरण में, Dynamic Links लिंक छोटा करने वाले एपीआई से अनुरोध करने का तरीका बताया गया है:

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

जब आपका ऐप्लिकेशन किसी ऐसे Firebase API को कॉल करता है जिसके लिए एपीआई पासकोड देना ज़रूरी है मोबाइल/वेब क्लाइंट से, आपका ऐप्लिकेशन अपने आप आपके प्रोजेक्ट की एपीआई कुंजी के लिए, Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट. हालांकि, अपने ऐप्लिकेशन के लिए एपीआई पासकोड देने के लिए, किसी दूसरे तरीके का इस्तेमाल किया जा सकता है. जैसे, एनवायरमेंट वैरिएबल.

एपीआई पासकोड पर सही पाबंदियां देखें और उन्हें लागू करें (सुझाया गया)

Firebase की सेवाओं के लिए एपीआई पासकोड को गुप्त रखने की ज़रूरत नहीं है. हालांकि, आपको इस सेक्शन में बताई गई पाबंदियों और सीमाओं की समीक्षा करनी चाहिए और उन्हें लागू करना चाहिए.

प्रोडक्शन ट्रैक वाले ऐप्लिकेशन में इस्तेमाल की जा रही एपीआई कुंजियों की पाबंदियों या सीमाओं में बदलाव करते समय सावधानी बरतें. प्रोडक्शन एपीआई पासकोड की पाबंदियों या सीमाओं को बदलने से पहले, आपको जांच करने वाले ऐप्लिकेशन और टेस्ट एपीआई पासकोड की मदद से, नई सेटिंग की जांच करनी चाहिए.

ध्यान दें: अगर Firebase सेवाओं के लिए इस्तेमाल की जाने वाली एपीआई पासकोड में "एपीआई से जुड़ी पाबंदियां" हैं और आपको API_KEY_SERVICE_BLOCKED या फॉरबिडन 403 वाली गड़बड़ी मिल रही है, तो पक्का करें कि कि API कुंजी में वे सभी चीज़ें हैं कुंजी के "एपीआई से जुड़ी पाबंदियों" में शामिल ज़रूरी एपीआई अनुमति वाली सूची में शामिल करें.

अपनी Firebase एपीआई कुंजियों के लिए, अनुमति वाली सूची में अपने-आप जुड़े एपीआई की समीक्षा करना

जब Firebase आपके प्रोजेक्ट में एपीआई पासकोड बनाता है, तो हम उस पासकोड में "एपीआई से जुड़ी पाबंदियां" अपने-आप जोड़ देते हैं. इस अनुमति वाली सूची में जोड़े गए एपीआई, Firebase से जुड़े एपीआई हैं. इनके लिए, क्लाइंट को कॉल के साथ एपीआई पासकोड देना ज़रूरी है. ध्यान दें कि Firebase की सेवाओं का इस्तेमाल करने के लिए ज़रूरी ज़्यादातर एपीआई को, आपकी एपीआई कुंजियों की अनुमति वाली सूची में शामिल करने की ज़रूरत नहीं होती.

Firebase, सभी Firebase सेवाओं के लिए ज़रूरी एपीआई जोड़ता है. इसलिए, किसी एपीआई पासकोड की अनुमति वाली सूची में ऐसे प्रॉडक्ट के एपीआई शामिल हो सकते हैं जिनका इस्तेमाल नहीं किया जाता. अनुमति वाली सूची से एपीआई हटाए जा सकते हैं. हालांकि, आपको इस बात का ध्यान रखना होगा कि Firebase और इस्तेमाल की जा रही Firebase सेवाओं के लिए ज़रूरी एपीआई को न हटाएं. इसके लिए, Firebase से जुड़े उन एपीआई की सूची देखें जिन्हें हर सेवा / प्रॉडक्ट के लिए अनुमति वाली सूची में शामिल करना ज़रूरी है. नहीं तो, आप Firebase सेवाओं को कॉल करते समय गड़बड़ियां होंगी.

ध्यान दें: मई 2024 के दौरान, Firebase ने सभी एपीआई से जुड़ी पाबंदियां अपने-आप लागू कर दी हैं मौजूदा और पाबंदी के बिना Firebase में प्रावधान की गई एपीआई कुंजियां. ज़्यादा जानकारी के लिए, अक्सर पूछे जाने वाले सवाल पढ़ें क्या डिफ़ॉल्ट रूप से, Firebase की सेवाओं के लिए एपीआई पासकोड पर पाबंदी लगी होती है?.

पासवर्ड पर आधारित Authentication का इस्तेमाल करने पर, कोटा को कम करें

इससे कोई फ़र्क़ नहीं पड़ता कि पुष्टि करने के लिए कौनसा विकल्प इस्तेमाल किया जा रहा है, अपने Realtime Database, Cloud Firestore, और Cloud Storage को सुरक्षित करें data को मैन्युअल तरीके से Firebase Security Rules.

अगर पासवर्ड पर आधारित Firebase Authentication का इस्तेमाल किया जाता है और किसी व्यक्ति को आपकी एपीआई पासकोड मिल जाता है, तो वह आपके Firebase प्रोजेक्ट के किसी भी डेटाबेस या Cloud Storage डेटा को नहीं ऐक्सेस कर पाएगा. ऐसा तब तक होगा, जब तक यह डेटा Firebase Security Rules से सुरक्षित रहेगा. हालांकि, वे ऐक्सेस करने के लिए आपके एपीआई पासकोड का इस्तेमाल कर सकते हैं Firebase के पुष्टि करने वाले एंडपॉइंट और इनके लिए पुष्टि करने के अनुरोध करते हैं आपका प्रोजेक्ट.

एपीआई पासकोड के गलत इस्तेमाल की संभावना को कम करने के लिए क्रूर बल हमले का प्रयास करें, तो आप सामान्य ट्रैफ़िक दिखाने के लिए identitytoolkit.googleapis.com एंडपॉइंट ऐप की उम्मीदों का आकलन करने में मदद मिलती है. ध्यान रखें कि अगर आप इस कोटा और अपने ऐप्लिकेशन को सीमित करते हैं अचानक उपयोगकर्ता बढ़ जाते हैं, तो कोटा बढ़ाने तक आपको साइन-इन करने में गड़बड़ियां दिख सकती हैं. Google Cloud कंसोल में जाकर, अपने प्रोजेक्ट के एपीआई कोटा में बदलाव किया जा सकता है.

Firebase के अलावा, किसी भी सेवा के लिए अलग-अलग प्रतिबंधित एपीआई पासकोड का इस्तेमाल करना

आम तौर पर, Firebase की सेवाओं के लिए इस्तेमाल की जाने वाली एपीआई कुंजियों को गुप्त नहीं माना जाता. हालांकि, आपको उन एपीआई कुंजियों के लिए कुछ अतिरिक्त सावधानियां बरतनी चाहिए जिन्हें Google Cloud के अन्य एपीआई के साथ इस्तेमाल किया जाता है.

अगर किसी ऐसे प्लैटफ़ॉर्म पर Google Cloud एपीआई का इस्तेमाल किया जाता है जो Firebase के लिए नहीं है सेवा / प्रॉडक्ट के लिए, हमारा सुझाव है कि आप अलग-अलग एपीआई पासकोड बनाएं. का इस्तेमाल किया जा सकता है. यह खास तौर पर तब ज़रूरी है, जब एपीआई का इस्तेमाल, बिलिंग की सुविधा वाली Google Cloud सेवा के लिए किया जा रहा हो.

उदाहरण के लिए, अगर iOS पर Firebase ML और Cloud Vision API का इस्तेमाल किया जाता है, तो को अलग-अलग एपीआई पासकोड बनाना चाहिए, जिनका इस्तेमाल सिर्फ़ आप करते हैं Cloud Vision API ऐक्सेस करने के लिए.

Firebase के अलावा अन्य एपीआई के लिए, पाबंदी वाली अलग-अलग एपीआई कुंजियों का इस्तेमाल करके, ज़रूरत पड़ने पर कुंजियों को घुमाया या बदला जा सकता है. साथ ही, Firebase की सेवाओं के इस्तेमाल में रुकावट डाले बिना, एपीआई कुंजियों पर और पाबंदियां जोड़ी जा सकती हैं.

एपीआई के हिसाब से पासकोड बनाने के लिए निर्देश देखना

इन निर्देशों में, Super Service API नाम के नकली एपीआई के लिए, पाबंदी वाली अलग एपीआई पासकोड बनाने का तरीका बताया गया है.

पहला चरण: Super Service API का ऐक्सेस न देने के लिए, अपनी मौजूदा एपीआई कुंजियां कॉन्फ़िगर करें

1. क्रेडेंशियल खोलें Google Cloud कंसोल का पेज. जब कहा जाए, तब अपना प्रोजेक्ट चुनें.

2. सूची में पहले से मौजूद हर एपीआई पासकोड के लिए, बदलाव करने का व्यू खोलें.

3. एपीआई से जुड़ी पाबंदियां सेक्शन में, कुंजी पर पाबंदी लगाएं को चुनें. इसके बाद, उन सभी एपीआई को सूची में जोड़ें जिनका ऐक्सेस आपको एपीआई कुंजी को देना है. पक्का करें कि उस एपीआई को शामिल नहीं करें जिसके लिए अलग से एपीआई पासकोड बनाया जा रहा है (इस उदाहरण में, Super Service API).

   एपीआई पासकोड की एपीआई से जुड़ी पाबंदियां कॉन्फ़िगर करने पर, उन एपीआई के बारे में साफ़ तौर पर बताया जाता है जिनका ऐक्सेस पासकोड के पास है. डिफ़ॉल्ट रूप से, जब एपीआई से जुड़ी पाबंदियां सेक्शन में कुंजी पर पाबंदी न लगाएं चुना गया हो, तो प्रोजेक्ट के लिए चालू किए गए किसी भी एपीआई को ऐक्सेस करने के लिए, एपीआई पासकोड का इस्तेमाल किया जा सकता है.

अब आपकी मौजूदा एपीआई कुंजियां, Super Service API को ऐक्सेस नहीं देंगी, लेकिन हर कुंजी उस एपीआई के साथ काम करती रहेगी जिसे आपने एपीआई से जुड़ी पाबंदियों की सूची.

अहम जानकारी: अगर आने वाले समय में कोई और एपीआई चालू किया जाता है, तो आपको उसे लागू एपीआई पासकोड के लिए, एपीआई से जुड़ी पाबंदियों की सूची में जोड़ना होगा.

दूसरा चरण: Super Service API को ऐक्सेस करने के लिए, नई एपीआई कुंजी बनाना और उसका इस्तेमाल करना

1. क्रेडेंशियल पर वापस जाएं करें. पक्का करें कि आपका Firebase प्रोजेक्ट अब भी चुना गया हो.

2. क्रेडेंशियल बनाएं > API पासकोड. नए एपीआई पासकोड को नोट करें और इसके बाद कुंजी पर पाबंदी लगाएं पर क्लिक करें.

3. एपीआई से जुड़ी पाबंदियां सेक्शन में, पासकोड पर पाबंदी लगाएं को चुनें. इसके बाद, सूची में Super Service API को सिर्फ़ जोड़ें.

   यह नई एपीआई कुंजी, सिर्फ़ Super Service API को ऐक्सेस देती है.

4. नई एपीआई पासकोड का इस्तेमाल करने के लिए, अपने ऐप्लिकेशन और सेवाओं को कॉन्फ़िगर करें.

एनवायरमेंट के हिसाब से एपीआई पासकोड का इस्तेमाल करें (इसका सुझाव दिया जाता है)

अगर आपने अलग-अलग एनवायरमेंट के लिए अलग-अलग Firebase प्रोजेक्ट सेट अप किए हैं, जैसे कि स्टेजिंग और प्रोडक्शन, तो यह ज़रूरी है कि हर ऐप्लिकेशन इंस्टेंस, अपने संबंधित Firebase प्रोजेक्ट के साथ इंटरैक्ट करे. उदाहरण के लिए, आपके स्टेजिंग ऐप्लिकेशन इंस्टेंस को अपने प्रोडक्शन Firebase प्रोजेक्ट से कभी बात न करें. इसका यह भी मतलब है कि आपके स्टैगिंग ऐप्लिकेशन को, स्टैगिंग Firebase प्रोजेक्ट से जुड़ी एपीआई कुंजियों का इस्तेमाल करना होगा.

डेवलपमेंट से स्टैजिंग और फिर प्रोडक्शन में कोड में किए गए बदलावों को प्रोमोट करने से जुड़ी समस्याओं को कम करने के लिए, कोड में एपीआई कुंजियों को शामिल करने के बजाय, उन्हें एनवायरमेंट वैरिएबल के तौर पर सेट करें या उन्हें कॉन्फ़िगरेशन फ़ाइल में शामिल करें.

ध्यान दें कि अगर Firebase Local Emulator Suite का इस्तेमाल, डेवलपमेंट के लिए किया जा रहा है Firebase ML के साथ आपको सिर्फ़ डीबग एपीआई पासकोड बनाना और इस्तेमाल करना होगा. ग्राहक सूची बनाने का तरीका ऐसी कुंजी बनाने के लिए, आपको Firebase ML दस्तावेज़.

अक्सर पूछे जाने वाले सवाल और समस्या का हल

अक्सर पूछे जाने वाले सवाल

क्या एपीआई पासकोड डिफ़ॉल्ट रूप से प्रतिबंधित Firebase सेवाओं के लिए?

हां, डिफ़ॉल्ट रूप से, वे सभी एपीआई कुंजियां जिन्हें Firebase अपने-आप इस्तेमाल करने के लिए प्रावधान करता है Firebase से जुड़े एपीआई में "एपीआई से जुड़ी पाबंदियां" अपने-आप लागू हो जाता है. इस अनुमति वाली सूची में मौजूद, Firebase से जुड़े एपीआई की सूची देखें.

अनुमति वाली इस सूची में जोड़े गए एपीआई वे एपीआई हैं जिन्हें Firebase सेवाओं ने कॉल किया है क्लाइंट-कोड और अपने Firebase प्रोजेक्ट की पहचान के लिए एपीआई कुंजियों की ज़रूरत होती है या है. ध्यान दें कि Firebase सेवाओं के इस्तेमाल के लिए ज़रूरी ज़्यादातर एपीआई असल में एपीआई पासकोड की अनुमति वाली सूची में शामिल होना चाहिए.

Firebase, सभी Firebase सेवाओं के लिए ज़रूरी एपीआई जोड़ता है. इसलिए, किसी एपीआई पासकोड की अनुमति वाली सूची में ऐसे प्रॉडक्ट के एपीआई शामिल हो सकते हैं जिनका इस्तेमाल नहीं किया जाता. अनुमति वाली सूची से एपीआई हटाए जा सकते हैं. हालांकि, आपको बहुत सावधानी बरतनी होगी, ताकि Firebase और इस्तेमाल की जा रही Firebase सेवाओं के लिए ज़रूरी एपीआई न हटाएं. हर सेवा / प्रॉडक्ट के लिए अनुमति वाली सूची में Firebase से जुड़े एपीआई की सूची देखें. ऐसा न करने पर, आपको Firebase की सेवाओं को कॉल करते समय गड़बड़ियां दिखेंगी.

अहम जानकारी: Firebase से जुड़ा कोई भी एपीआई, अनुमति के तौर पर एपीआई पासकोड का इस्तेमाल नहीं करता एपीआई को कॉल करने के लिए. एपीआई कॉल के साथ पास की गई एपीआई कुंजी का इस्तेमाल, सिर्फ़ Firebase प्रोजेक्ट या ऐप्लिकेशन की पहचान करने के लिए किया जाता है.

आपके पास अपनी सभी एपीआई कुंजियां और उनसे जुड़ी "एपीआई से जुड़ी पाबंदियां" देखने का विकल्प है में API और सेवाएं > क्रेडेंशियल पैनल से Google Cloud कंसोल में जोड़ सकते हैं.

Firebase, इन "एपीआई से जुड़ी पाबंदियों" को कैसे लागू करता है, इस बारे में इन बातों का ध्यान रखें:

• मई 2024 से, Firebase में अपने-आप प्रावधान होने वाली सभी नई एपीआई कुंजियां, अपने-आप सिर्फ़ इस सीमा तक सीमित Firebase से जुड़े एपीआई की सूची.

• मई 2024 के दौरान, Firebase के पास मौजूद सभी मौजूदा और पाबंदी के बिना एपीआई पासकोड पहले से अपने-आप प्रावधान होने की सुविधा Firebase से जुड़े एपीआई की सूची साथ ही, प्रोजेक्ट के मौजूदा चालू एपीआई में से किसी एक को भी शामिल कर सकते हैं.

• Firebase ने पहले जिन एपीआई कुंजियों को अपने-आप उपलब्ध कराया था उनमें कोई बदलाव नहीं किया गया. ये कुंजियां, मौजूदा और पहले से ही पाबंदी वाली हैं.

• ऐसी कोई भी मौजूदा एपीआई कुंजी, जिसे Firebase ने अपने-आप प्रावधान नहीं किया था बदल दिया गया है.

अहम जानकारी: अगर किसी प्लैटफ़ॉर्म पर ऐसे Google Cloud एपीआई का इस्तेमाल किया जाता है जो Firebase सेवा / प्रॉडक्ट. हमारा सुझाव है कि अलग-अलग, पाबंदी वाले एपीआई पासकोड बनाना ताकि इन एपीआई के साथ इस्तेमाल किया जा सके.

मैं यह कैसे पता लगाऊं कि मेरे Firebase ऐप्लिकेशन से कौनसी एपीआई पासकोड जुड़ी है?

यह पता लगाने के लिए कि आपके Firebase ऐप्लिकेशन से कौनसी एपीआई पासकोड जुड़ी है, इनमें से किसी भी विकल्प का इस्तेमाल किया जा सकता है:

Firebase कंसोल

1. प्रोजेक्ट की सेटिंग पर जाएं. इसके बाद, नीचे की ओर स्क्रोल करके आपके ऐप्लिकेशन कार्ड पर जाएं.

2. अपनी पसंद का ऐप्लिकेशन चुनें.

3. अपनी पसंद के ऐप्लिकेशन के लिए, Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट हासिल करें. इसके बाद इसकी API कुंजी ढूंढें:

   • Apple: GoogleService-Info.plist डाउनलोड करें. इसके बाद, API_KEY फ़ील्ड ढूंढें

   • Android: google-services.json डाउनलोड करें और पसंदीदा ऐप्लिकेशन (इसके पैकेज का नाम देखें) डाउनलोड करें. इसके बाद, current_key फ़ील्ड

   • वेब: कॉन्फ़िगरेशन विकल्प चुनें. इसके बाद, apiKey फ़ील्ड ढूंढें

Firebase सीएलआई

1. अपनी पसंद के ऐप्लिकेशन के लिए Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट पाएं. इसके लिए, यह कमांड चलाएं:

   firebase apps:sdkconfig PLATFORM FIREBASE_APP_ID

   • PLATFORM (इनमें से कोई एक): IOS | ANDROID | WEB
   • FIREBASE_APP_ID: इसके लिए Firebase से असाइन किया गया यूनीक आइडेंटिफ़ायर आपका Firebase ऐप्लिकेशन (अपना ऐप्लिकेशन आईडी ढूंढें)

2. ऐप्लिकेशन के प्रिंट किए गए Firebase कॉन्फ़िगरेशन में, उसकी एपीआई कुंजी ढूंढें:

   • Apple: API_KEY फ़ील्ड ढूंढें

   • Android: अपनी पसंद के ऐप्लिकेशन का कॉन्फ़िगरेशन ढूंढें (इसके पैकेज का नाम देखें). इसके बाद, current_key फ़ील्ड ढूंढें

   • वेब: apiKey फ़ील्ड खोजें

REST API

1. एपीआई पासकोड का apiKeyId (यूआईडी) हासिल करें. इसके लिए, उपयोगकर्ता की पसंद के ऐप्लिकेशन के लिए लागू एंडपॉइंट और फिर अगले चरण पर जाने के लिए apiKeyId वैल्यू.

   • Apple: projects.iosApps.get पर कॉल करें
   • Android: projects.androidApps.get को कॉल करें
   • वेब: projects.webApps.get को कॉल करें

2. projects.locations.keys.getKeyString को कॉल करके, एपीआई पासकोड स्ट्रिंग पाएं.

   यह keyString वही वैल्यू है जो ऐप्लिकेशन के कॉन्फ़िगरेशन आर्टफ़ैक्ट (Apple | Android | वेब) में मिल सकती है.

क्या मेरे Firebase कॉन्फ़िगरेशन में, एक ही Firebase ऐप्लिकेशन के लिए दो एपीआई कुंजियां मौजूद हैं फ़ाइल/ऑब्जेक्ट?

• Firebase के Apple ऐप्लिकेशन — हर ऐप्लिकेशन की अपनी कॉन्फ़िगरेशन फ़ाइल होती है और उसमें सिर्फ़ एक एपीआई पासकोड शामिल किया जा सकता है.

• Firebase Android ऐप्लिकेशन — Firebase प्रोजेक्ट में मौजूद सभी Android ऐप्लिकेशन एक ही कॉन्फ़िगरेशन फ़ाइल में मौजूद हो और हर ऐप्लिकेशन में सिर्फ़ एक एपीआई पासकोड हो सकता है सूचीबद्ध हैं. हालांकि, इस कॉन्फ़िगरेशन फ़ाइल में हर ऐप्लिकेशन के लिए, एक अलग पासकोड हो सकता है.

• Firebase वेब ऐप्लिकेशन — हर ऐप्लिकेशन का अपना कॉन्फ़िगरेशन ऑब्जेक्ट होता है और एक एपीआई पासकोड लिस्ट किया गया है.

हालांकि, एक ऐप्लिकेशन के साथ कई एपीआई पासकोड का इस्तेमाल किया जा सकता है. आपको अपने ऐप्लिकेशन के लिए, इन अन्य एपीआई कुंजियों को ऐक्सेस करने का तरीका बताना होगा. जैसे, किसी एनवायरमेंट वैरिएबल के ज़रिए. अन्य एपीआई कुंजियों को ऐक्सेस करने का तरीका, सिर्फ़ आपकी Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट में मौजूद एपीआई कुंजियों पर निर्भर नहीं हो सकता.

Firebase को कैसे पता चलता है कि किसी ऐप्लिकेशन (जैसे, Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट) से किस एपीआई पासकोड को मैच करना है?

जब पहली बार अपने ऐप्लिकेशन का Firebase कॉन्फ़िगरेशन हासिल किया जाता है फ़ाइल/ऑब्जेक्ट, Firebase यह जांचता है कि क्या आपके प्रोजेक्ट में कोई मौजूदा एपीआई पासकोड है "ऐप्लिकेशन पर पाबंदियां" जो ऐप्लिकेशन से मेल खाती हो (उदाहरण के लिए, Apple ऐप्लिकेशन के लिए मेल खाने वाला बंडल आईडी).

अगर Firebase को कोई प्रतिबंधित कुंजी नहीं मिलती है, तो वह Apple ऐप्लिकेशन के लिए iOS key कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट, Android key Android ऐप्लिकेशन और वेब ऐप्लिकेशन के लिए Browser key (यह मानते हुए कि ये कुंजियां मौजूद हैं और जिनके पास "ऐप्लिकेशन के लिए कोई पाबंदी" नहीं है जो उन्हें उस प्रॉडक्ट से मैच नहीं करने देता ऐप्लिकेशन).

क्या मैन्युअल तरीके से किया जा सकता है मेरी Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट से एपीआई कुंजी और फ़ील्ड को मिटाना है?

हां, कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट से एपीआई पासकोड, मैन्युअल तरीके से मिटाया जा सकता है. हालांकि, आपको अपने ऐप्लिकेशन के लिए, एपीआई पासकोड ऐक्सेस करने का कोई दूसरा तरीका उपलब्ध कराना होगा. जैसे, किसी एनवायरमेंट वैरिएबल की मदद से. या फिर, Firebase सेवाओं को किए जाने वाले किसी भी कॉल विफल हो जाएगा.

क्या अलग-अलग एपीआई कुंजियों की मदद से, अपनी Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट में मैन्युअल रूप से बदलाव किया जा सकता है?

हां, दूसरा एपीआई पासकोड जोड़ने के लिए, कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट में मैन्युअल तरीके से बदलाव किया जा सकता है से जुड़ा हुआ है.

अपने Firebase कॉन्फ़िगरेशन में, एपीआई पासकोड में मैन्युअल तरीके से बदलाव करना फ़ाइल/ऑब्जेक्ट इस्तेमाल किया जा सकता है, लेकिन आम तौर पर इसका सुझाव नहीं दिया जाता. इससे, Firebase की सेवाओं को ऐक्सेस करने में समस्याएं होने की संभावना बढ़ जाती है. हालांकि, अगर आपको अपनी कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट में बदलाव करना है, तो यह तरीका अपनाएं:

• पक्का करें कि एपीआई पासकोड, कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट में दिए गए प्रोजेक्ट आईडी के दायरे में हो.
• पक्का करें कि कोई "एपीआई पासकोड से जुड़ी पाबंदियां", जो एपीआई को काम करने में रुकावट डालेगी कुंजी का भी इस्तेमाल किया जा सकता है.
• पक्का करें कि एपीआई पासकोड पर सही "एपीआई पाबंदियां" लागू हों. देखें यह सूची Firebase से जुड़े एपीआई, जिन्हें हर एपीआई के लिए अनुमति वाली सूची में शामिल किया जाना चाहिए Firebase सेवा / प्रॉडक्ट.

ध्यान दें कि अगर अपने ऐप्लिकेशन की कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट फिर से पाना कंसोल से, यह हमेशा उन API कुंजियों को सूचीबद्ध करेगा, जो Firebase अपने-आप उस ऐप्लिकेशन से मैच करता है. इसलिए, आपको ज़रूरत के मुताबिक अपने मैन्युअल बदलावों को दोहराना होगा.

क्या किसी एपीआई पासकोड को एक Firebase प्रोजेक्ट से दूसरे में ट्रांसफ़र किया जा सकता है?

नहीं, एपीआई पासकोड सिर्फ़ किसी प्रोजेक्ट की पहचान करता है. इसे किसी दूसरे प्रोजेक्ट में नहीं ले जाया जा सकता प्रोजेक्ट.

क्या होगा अगर मैं क्या आपको Google Cloud कंसोल में मौजूद किसी एपीआई पासकोड को मिटाना है?

अगर किसी ऐप्लिकेशन में इस्तेमाल की जा रही एपीआई पासकोड को मिटाया जाता है, तो उस ऐप्लिकेशन से एपीआई कॉल किए जा रहे हैं विफल हो जाएगा. आपको रिपोर्ट, ईमेल या गड़बड़ियों के मैसेज मिल सकते हैं. इनसे पता चलता है कि आपने अमान्य एपीआई पासकोड का इस्तेमाल किया है.

किसी एपीआई पासकोड को मिटाने के बाद, उसे वापस नहीं लाया जा सकता.

Firebase एपीआई पासकोड के लिए, "एपीआई से जुड़ी पाबंदियां" की अनुमति वाली सूची में कौनसे एपीआई ज़रूरी हैं?

Firebase एपीआई पासकोड के लिए, सिर्फ़ उन एपीआई को पासकोड की "एपीआई पाबंदियां" अनुमति सूची में शामिल करना ज़रूरी है जिनके लिए क्लाइंट को कॉल के साथ एपीआई पासकोड देना ज़रूरी है. ध्यान दें कि Firebase से जुड़े बहुत कम एपीआई के लिए, यह ज़रूरी शर्त है. आपके प्रोजेक्ट में चालू किए गए ज़्यादातर Firebase से जुड़े एपीआई को कुंजी के "एपीआई से जुड़ी पाबंदियों" पर अनुमति वाली सूची में शामिल है.

अहम जानकारी: Firebase से जुड़ा कोई भी एपीआई, एपीआई को कॉल करने के लिए अनुमति के तौर पर एपीआई पासकोड का इस्तेमाल नहीं करता. एपीआई कॉल के साथ पास की गई एपीआई कुंजी, सिर्फ़ इनके लिए इस्तेमाल की जाती है पहचान.

नीचे दी गई टेबल का इस्तेमाल करके यह तय करें कि Firebase एपीआई कुंजी के लिए, "एपीआई से जुड़ी पाबंदियां" की अनुमति वाली सूची में किन Firebase से जुड़े एपीआई को शामिल करना है. याद रखें कि Firebase API पासकोड का इस्तेमाल सिर्फ़ Firebase की सेवाओं के लिए किया जाना चाहिए. इसके बारे में ज़्यादा जानें बना रहे हैं अलग-अलग तरह के एपीआई के लिए, पाबंदी वाले एपीआई पासकोड अलग करें.

यहां पर अपने प्रोजेक्ट की एपीआई कुंजियां देखी और मैनेज की जा सकती हैं API और सेवाएं > क्रेडेंशियल पैनल से Google Cloud कंसोल में जोड़ सकते हैं.

ध्यान दें: अगर आपको गड़बड़ी का API_KEY_SERVICE_BLOCKED या 403 कोड वाला मैसेज दिखता है, तो Firebase से जुड़े एपीआई को कॉल करने और इस्तेमाल की जा रही एपीआई कुंजी में इस टेबल में दिए गए ज़रूरी एपीआई के लिए, यहां जाएं Firebase की सहायता टीम.

एपीआई का नाम (सेवा का नाम)	एपीआई का डिसप्ले नेम	Firebase से जुड़ी सेवा / प्रॉडक्ट
firebase.googleapis.com	Firebase मैनेजमेंट एपीआई	सभी प्रॉडक्ट
logging.googleapis.com	Cloud Logging API	सभी प्रॉडक्ट
firebaseinstallations.googleapis.com	Firebase इंस्टॉलेशन एपीआई	Cloud Messaging, Crashlytics, In-App Messaging, Performance Monitoring, Remote Config, और Firebase ML
firebaseappcheck.googleapis.com	Firebase App Check API	App Check
firebaseappdistribution.googleapis.com	Firebase App Distribution API	App Distribution
firebaseapptesters.googleapis.com	Firebase App Testers API	App Distribution
identitytoolkit.googleapis.com	पहचान टूलकिट एपीआई	Authentication
securetoken.googleapis.com	Token Service API	Authentication
firebaserules.googleapis.com *	Firebase Rules API	Cloud Firestore, Cloud Storage, Realtime Database
datastore.googleapis.com	क्लाउड डेटास्टोर API	Cloud Firestore
firestore.googleapis.com	Google Cloud Firestore एपीआई	Cloud Firestore
fcmregistrations.googleapis.com	FCM रजिस्ट्रेशन एपीआई	Cloud Messaging
firebasestorage.googleapis.com	Firebase के लिए Cloud Storage API	Cloud Storage
firebasedynamiclinks.googleapis.com	Firebase डाइनैमिक लिंक एपीआई	Dynamic Links
firebasehosting.googleapis.com *	Firebase होस्टिंग एपीआई	Hosting
firebaseinappmessaging.googleapis.com	Firebase इन-ऐप्लिकेशन मैसेजिंग API	In-App Messaging
firebaseml.googleapis.com	Firebase ML API	Firebase ML
mlkit.googleapis.com **	ML Kit API	Firebase ML
mobilecrashreporting.googleapis.com	Mobile Crash Reporting API	Performance Monitoring
play.googleapis.com	Google Play Android डेवलपर API	Performance Monitoring
firebaseremoteconfig.googleapis.com	Firebase रिमोट कॉन्फ़िगरेशन एपीआई	Performance Monitoring, Remote Config
firebaseremoteconfigrealtime.googleapis.com	Firebase रिमोट कॉन्फ़िगरेशन रीयल टाइम एपीआई	Performance Monitoring, Remote Config
Cloudconfig.googleapis.com **	लागू नहीं	Remote Config
firebasedatabase.googleapis.com *	Firebase रीयलटाइम डेटाबेस एपीआई	Realtime Database
firebasevertexai.googleapis.com	Firebase API में Vertex AI	Vertex AI in Firebase

^{* यह सिर्फ़ तब ज़रूरी है, जब तीसरे पक्ष के टूल के साथ Firebase API पासकोड का इस्तेमाल किया जा रहा हो या Firebase सेवा / प्रॉडक्ट के लिए सीधे REST ऐक्सेस का इस्तेमाल किया जा रहा हो.}

^{** प्रॉडक्ट के SDK टूल के पुराने वर्शन के लिए ज़रूरी है. अगर SDK टूल का नया वर्शन इस्तेमाल किया जा रहा है, तो एपीआई को पासकोड की अनुमति वाली सूची में शामिल करने की ज़रूरत नहीं है.}

समस्या का हल

मैं API_KEY_SERVICE_BLOCKED या 403 कोड वाली उस गड़बड़ी को कैसे ठीक करूं जिसमें लिखा हो कि इस एपीआई के लिए अनुरोध ब्लॉक किए गए हैं?

अगर आपको 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.

ऐसा हो सकता है कि आपके ऐप्लिकेशन ने एपीआई को कॉल करने के लिए जिस एपीआई पासकोड का इस्तेमाल किया है उस पर "एपीआई से जुड़ी पाबंदियां" लागू हों. साथ ही, पासकोड की अनुमति वाली सूची में वह एपीआई शामिल न हो.

• अगर आपको Firebase से जुड़ी सेवा / प्रॉडक्ट का इस्तेमाल करते समय यह गड़बड़ी दिख रही है, तो पक्का करें कि आपके इस्तेमाल किए जा रहे एपीआई पासकोड में, पासकोड की "एपीआई से जुड़ी पाबंदियों" की अनुमति वाली सूची में शामिल सभी ज़रूरी एपीआई शामिल हों.

• अगर आपको Firebase के अलावा दूसरी सेवा का इस्तेमाल करते समय यह गड़बड़ी दिख रही है, तो हमारी सलाह है कि आप खास तौर पर, इस सेवा के लिए एक नई एपीआई पासकोड बनाएं. एपीआई. Firebase एपीआई कुंजियों का इस्तेमाल सिर्फ़ Firebase सेवाओं / प्रॉडक्ट के लिए किया जाना चाहिए. इमेज बनाने के बारे में ज़्यादा जानें अलग-अलग तरह के एपीआई के लिए, पाबंदी वाले एपीआई पासकोड अलग करें.

मैं ऐसा कैसे करूँ इस गड़बड़ी को ठीक करें? "सर्वर से इस Firebase ऐप्लिकेशन का मेज़रमेंट आईडी फ़ेच नहीं किया जा सका."

आपके वेब ऐप्लिकेशन में इस्तेमाल की गई एपीआई पासकोड पर, शायद "एपीआई से जुड़ी पाबंदियां" लागू हों. अगर ऐसा है, तो पक्का करें कि Firebase Management API अनुमति वाले एपीआई की सूची में है.

मुझे ऐसा ईमेल या गड़बड़ी मिली मेरी एपीआई कुंजी अमान्य है. क्या हुआ और मैं इसे कैसे ठीक करूं?

अमान्य एपीआई पासकोड की कुछ सबसे सामान्य वजहें यहां दी गई हैं:

• एपीआई पासकोड पर "एपीआई पासकोड से जुड़ी पाबंदियां" लागू हैं. इनकी वजह से, यह पासकोड उस ऐप्लिकेशन के साथ काम नहीं करता जो इसका इस्तेमाल करने की कोशिश कर रहा है ("ऐप्लिकेशन से जुड़ी पाबंदियां") या जिस एपीआई को कॉल किया जा रहा है उसके साथ काम नहीं करता ("एपीआई से जुड़ी पाबंदियां").

• Google Cloud कंसोल में, प्रोजेक्ट से एपीआई पासकोड मिटाया गया.

• ऐप्लिकेशन के Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट.

इस समस्या को हल करने का एक तरीका यह है कि आप अपने ऐप्लिकेशन के अपडेट किए गए वर्शन को अपडेट करें Firebase कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट, इसके बाद, अपनी पुरानी कॉन्फ़िगरेशन फ़ाइल/ऑब्जेक्ट को अपडेट की गई नई फ़ाइल/ऑब्जेक्ट से बदलें. डाउनलोड करने के लिए कॉन्फ़िगरेशन फ़ाइल भेजने या कंसोल में कॉन्फ़िगरेशन ऑब्जेक्ट दिखाने से पहले, Firebase यह जांच करता है कि सूची में दी गई एपीआई कुंजी, ऐप्लिकेशन से मेल खाती है या नहीं.