FirebaseUI का इस्तेमाल करके, अपने वेब ऐप्लिकेशन में आसानी से साइन इन करने की सुविधा जोड़ें

FirebaseUI, Firebase Authentication SDK पर बनी एक लाइब्रेरी है. यह आपके ऐप्लिकेशन में इस्तेमाल के लिए, ड्रॉप-इन यूज़र इंटरफ़ेस (यूआई) फ़्लो उपलब्ध कराती है. FirebaseUI के ये फ़ायदे हैं:

  • कई प्रोवाइडर - ईमेल/पासवर्ड, ईमेल लिंक, फ़ोन से पुष्टि, Google, Facebook, Twitter, और GitHub से साइन-इन करने के फ़्लो.
  • खाता लिंक करना - पहचान देने वाले अलग-अलग प्रोवाइडर के उपयोगकर्ताओं के खातों को सुरक्षित तरीके से लिंक करने के फ़्लो.
  • पसंद के मुताबिक बनाना - अपने ऐप्लिकेशन की ज़रूरतों के हिसाब से, FirebaseUI के सीएसएस स्टाइल को बदलें. इसके अलावा, FirebaseUI ओपन सोर्स है. इसलिए, प्रोजेक्ट को फ़ोर्क किया जा सकता है और अपनी ज़रूरतों के हिसाब से उसमें बदलाव किया जा सकता है.
  • One-tap साइन-अप और अपने-आप साइन इन होने की सुविधा - क्रॉस-डिवाइस पर तेज़ी से साइन-इन करने के लिए, One-tap साइन-अप के साथ अपने-आप इंटिग्रेशन.
  • स्थानीय भाषा में यूज़र इंटरफ़ेस (यूआई) - 40 से ज़्यादा भाषाओं के लिए अंतरराष्ट्रीयकरण.
  • पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करना - साइन-इन/साइन-अप की मदद से, पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करने की सुविधा. ज़्यादा जानकारी के लिए, पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करना सेक्शन पर जाएं.

शुरू करने से पहले

  1. अपने वेब ऐप्लिकेशन में Firebase Authentication जोड़ें, साथ ही, पक्का करें कि आपने v9 या उसके बाद का नेमस्पेस वाला एपीआई इस्तेमाल किया हो (मॉड्यूलर एपीआई का इस्तेमाल न करें. इसके बारे में ज़्यादा जानने के लिए, ऊपर साइडबार देखें).

  2. FirebaseUI को शामिल करने के लिए, इनमें से कोई एक विकल्प चुनें:

    • सीडीएन

      अपने पेज के <head> टैग में, कंसोल से मिले शुरुआती स्निपेट के नीचे, यह स्क्रिप्ट और सीएसएस फ़ाइल शामिल करें: Firebase

      <script src="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.js"></script>
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.css" />

    • एनपीएम मॉड्यूल

      एनपीएम की मदद से, FirebaseUI और उसकी डिपेंडेंसी इंस्टॉल करने के लिए, यह कमांड इस्तेमाल करें:

      $ npm install firebaseui --save

      अपनी सोर्स फ़ाइलों में, ये मॉड्यूल require करें:

      var firebase = require('firebase');
var firebaseui = require('firebaseui');

    • Bower कॉम्पोनेंट

      Bower की मदद से, FirebaseUI और उसकी डिपेंडेंसी इंस्टॉल करने के लिए, यह कमांड इस्तेमाल करें:

      $ bower install firebaseui --save

      अगर आपका एचटीटीपी सर्वर, bower_components/ में मौजूद फ़ाइलें दिखाता है, तो अपने एचटीएमएल में ज़रूरी फ़ाइलें शामिल करें:

      <script src="bower_components/firebaseui/dist/firebaseui.js"></script>
<link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />

FirebaseUI को शुरू करना

एसडीके इंपोर्ट करने के बाद, Auth यूज़र इंटरफ़ेस (यूआई) को शुरू करें.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

साइन-इन करने के तरीके सेट अप करना

Firebase का इस्तेमाल करके, लोगों को साइन-इन करने की अनुमति देने से पहले, आपको साइन-इन करने के उन तरीकों को चालू और कॉन्फ़िगर करना होगा जिन्हें आपको इस्तेमाल करना है.

ईमेल पता और पासवर्ड

  1. Firebase कंसोल में, सुरक्षा > पुष्टि पर जाएं.

  2. साइन-इन करने का तरीका टैब में, ईमेल/पासवर्ड साइन-इन प्रोवाइडर को चालू करें.

  3. ईमेल प्रोवाइडर आईडी को, FirebaseUI signInOptions की सूची में जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.EmailAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. ज़रूरी नहीं: EmailAuthProvider को इस तरह कॉन्फ़िगर किया जा सकता है कि उपयोगकर्ता को डिसप्ले नाम डालना पड़े. इसकी डिफ़ॉल्ट वैल्यू true होती है.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      requireDisplayName: false
    }
  ]
});

  1. Firebase कंसोल में, सुरक्षा > पुष्टि पर जाएं.

  2. साइन-इन करने का तरीका टैब में, ईमेल/पासवर्ड साइन-इन प्रोवाइडर को चालू करें. ध्यान दें कि ईमेल लिंक से साइन-इन करने के लिए, ईमेल/पासवर्ड से साइन-इन करने की सुविधा चालू होनी चाहिए.

  3. इसी सेक्शन में, ईमेल लिंक (बिना पासवर्ड के साइन-इन) साइन-इन प्रोवाइडर को चालू करें.

  4. सेव करें पर क्लिक करें.

  5. ईमेल प्रोवाइडर आईडी को, FirebaseUI signInOptions की सूची में जोड़ें. साथ ही, ईमेल लिंक signInMethod को भी जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
    }
  ],
  // Other config options...
});

  6. साइन-इन यूज़र इंटरफ़ेस (यूआई) को शर्तों के हिसाब से रेंडर करते समय (सिंगल पेज ऐप्लिकेशन के लिए ज़रूरी), ui.isPendingRedirect() का इस्तेमाल करके यह पता लगाएं कि यूआरएल, ईमेल लिंक से साइन-इन करने से जुड़ा है या नहीं. साथ ही, यह भी पता लगाएं कि साइन-इन पूरा करने के लिए यूज़र इंटरफ़ेस (यूआई) को रेंडर करना ज़रूरी है या नहीं.

    // Is there an email link sign-in?
if (ui.isPendingRedirect()) {
  ui.start('#firebaseui-auth-container', uiConfig);
}
// This can also be done via:
if (firebase.auth().isSignInWithEmailLink(window.location.href)) {
  ui.start('#firebaseui-auth-container', uiConfig);
}

  7. ज़रूरी नहीं: ईमेल लिंक से साइन-इन करने के लिए, EmailAuthProvider को इस तरह कॉन्फ़िगर किया जा सकता है कि उपयोगकर्ता को अलग-अलग डिवाइसों पर साइन-इन करने की अनुमति दी जाए या नहीं.

    एक वैकल्पिक emailLinkSignIn कॉलबैक तय किया जा सकता है. इससे, लिंक भेजते समय इस्तेमाल करने के लिए, firebase.auth.ActionCodeSettings कॉन्फ़िगरेशन वापस मिलता है. इससे यह तय किया जा सकता है कि लिंक को कैसे हैंडल किया जाए, कस्टम डाइनैमिक लिंक, डीप लिंक में अतिरिक्त स्थिति वगैरह. अगर यह सुविधा चालू नहीं की जाती है, तो मौजूदा यूआरएल का इस्तेमाल किया जाता है और सिर्फ़ वेब फ़्लो ट्रिगर होता है.

    FirebaseUI-web में ईमेल लिंक से साइन-इन करने की सुविधा, FirebaseUI-Android और FirebaseUI-iOS के साथ काम करती है. इसका मतलब है कि FirebaseUI-Android से फ़्लो शुरू करने वाला कोई उपयोगकर्ता, लिंक खोलकर FirebaseUI-web से साइन-इन कर सकता है. इसके उलट फ़्लो के लिए भी यही नियम लागू होता है.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD,
      // Allow the user the ability to complete sign-in cross device,
      // including the mobile apps specified in the ActionCodeSettings
      // object below.
      forceSameDevice: false,
      // Used to define the optional firebase.auth.ActionCodeSettings if
      // additional state needs to be passed along request and whether to open
      // the link in a mobile app if it is installed.
      emailLinkSignIn: function() {
        return {
          // Additional state showPromo=1234 can be retrieved from URL on
          // sign-in completion in signInSuccess callback by checking
          // window.location.href.
          url: 'https://www.example.com/completeSignIn?showPromo=1234',
          // Custom FDL domain.
          dynamicLinkDomain: 'example.page.link',
          // Always true for email link sign-in.
          handleCodeInApp: true,
          // Whether to handle link in iOS app if installed.
          iOS: {
            bundleId: 'com.example.ios'
          },
          // Whether to handle link in Android app if opened in an Android
          // device.
          android: {
            packageName: 'com.example.android',
            installApp: true,
            minimumVersion: '12'
          }
        };
      }
    }
  ]
});

OAuth प्रोवाइडर (Google, Facebook, Twitter, और GitHub)

  1. Firebase कंसोल में, सुरक्षा > पुष्टि पर जाएं.

  2. साइन-इन करने का तरीका टैब में, बताए गए OAuth प्रोवाइडर से साइन-इन करने की सुविधा चालू करें. पक्का करें कि OAuth क्लाइंट आईडी और सीक्रेट भी तय किए गए हों.

  3. अगर आपने पहले से ही अपने ऐप्लिकेशन के डोमेन को अनुमति नहीं दी है, तो ऐसा करें:

    1. Firebase कंसोल में, सुरक्षा > पुष्टि > सेटिंग टैब पर जाएं.

    2. अनुमति वाले डोमेन सेक्शन में, डोमेन जोड़ें पर क्लिक करें. इसके बाद, अपना डोमेन जोड़ें .

  4. OAuth प्रोवाइडर आईडी को, FirebaseUI signInOptions की सूची में जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    // List of OAuth providers supported.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  5. ज़रूरी नहीं: हर प्रोवाइडर के लिए, कस्टम स्कोप या कस्टम OAuth पैरामीटर तय करने के लिए, सिर्फ़ प्रोवाइडर की वैल्यू के बजाय कोई ऑब्जेक्ट पास किया जा सकता है:

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.GoogleAuthProvider.PROVIDER_ID,
      scopes: [
        'https://www.googleapis.com/auth/contacts.readonly'
      ],
      customParameters: {
        // Forces account selection even when one account
        // is available.
        prompt: 'select_account'
      }
    },
    {
      provider: firebase.auth.FacebookAuthProvider.PROVIDER_ID,
      scopes: [
        'public_profile',
        'email',
        'user_likes',
        'user_friends'
      ],
      customParameters: {
        // Forces password re-entry.
        auth_type: 'reauthenticate'
      }
    },
    firebase.auth.TwitterAuthProvider.PROVIDER_ID, // Twitter does not support scopes.
    firebase.auth.EmailAuthProvider.PROVIDER_ID // Other providers don't need to be given as object.
  ]
});

फ़ोन नंबर

  1. Firebase कंसोल में, सुरक्षा > पुष्टि पर जाएं.

  2. साइन-इन करने का तरीका टैब में, फ़ोन साइन-इन प्रोवाइडर को चालू करें.

  3. अगर आपने पहले से ही अपने ऐप्लिकेशन के डोमेन को अनुमति नहीं दी है, तो ऐसा करें:

    1. Firebase कंसोल में, सुरक्षा> पुष्टि > सेटिंग टैब पर जाएं.

    2. अनुमति वाले डोमेन सेक्शन में, डोमेन जोड़ें पर क्लिक करें. इसके बाद, अपना डोमेन जोड़ें .

  4. फ़ोन नंबर प्रोवाइडर आईडी को, FirebaseUI signInOptions की सूची में जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  5. ज़रूरी नहीं: PhoneAuthProvider को, reCAPTCHA के कस्टम पैरामीटर के साथ कॉन्फ़िगर किया जा सकता है. भले ही, reCAPTCHA दिखे या न दिखे. इसकी डिफ़ॉल्ट वैल्यू सामान्य होती है. ज़्यादा जानकारी के लिए, reCAPTCHA API के दस्तावेज़ देखें.

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

    फ़िलहाल, ये विकल्प काम करते हैं.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,
      recaptchaParameters: {
        type: 'image', // 'audio'
        size: 'normal', // 'invisible' or 'compact'
        badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.
      },
      defaultCountry: 'GB', // Set default country to the United Kingdom (+44).
      // For prefilling the national number, set defaultNationNumber.
      // This will only be observed if only phone Auth provider is used since
      // for multiple providers, the NASCAR screen will always render first
      // with a 'sign in with phone number' button.
      defaultNationalNumber: '1234567890',
      // You can also pass the full phone number string instead of the
      // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,
      // the first country ID that matches the country code will be used to
      // populate the country selector. So for countries that share the same
      // country code, the selected country may not be the expected one.
      // In that case, pass the 'defaultCountry' instead to ensure the exact
      // country is selected. The 'defaultCountry' and 'defaultNationaNumber'
      // will always have higher priority than 'loginHint' which will be ignored
      // in their favor. In this case, the default country will be 'GB' even
      // though 'loginHint' specified the country code as '+1'.
      loginHint: '+11234567890'
    }
  ]
});

साइन इन करें

FirebaseUI से साइन-इन करने का फ़्लो शुरू करने के लिए, FirebaseUI इंस्टेंस को शुरू करें. इसके लिए, उसमें Auth का इंस्टेंस पास करें.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

वह एचटीएमएल एलिमेंट तय करें जहां FirebaseUI का साइन-इन विजेट रेंडर होगा.

<!-- The surrounding HTML is left untouched by FirebaseUI.
     Your app may use that space for branding, controls and other customizations.-->
<h1>Welcome to My Awesome App</h1>
<div id="firebaseui-auth-container"></div>
<div id="loader">Loading...</div>

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

var uiConfig = {
  callbacks: {
    signInSuccessWithAuthResult: function(authResult, redirectUrl) {
      // User successfully signed in.
      // Return type determines whether we continue the redirect automatically
      // or whether we leave that to developer to handle.
      return true;
    },
    uiShown: function() {
      // The widget is rendered.
      // Hide the loader.
      document.getElementById('loader').style.display = 'none';
    }
  },
  // Will use popup for IDP Providers sign-in flow instead of the default, redirect.
  signInFlow: 'popup',
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    // Leave the lines as is for the providers you want to offer your users.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Terms of service url.
  tosUrl: '<your-tos-url>',
  // Privacy policy url.
  privacyPolicyUrl: '<your-privacy-policy-url>'
};

आखिर में, FirebaseUI Auth इंटरफ़ेस रेंडर करें:

// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);

पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करना

पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करने की सुविधा चालू करना

जब कोई व्यक्ति, पहचान छिपाकर इस्तेमाल करने वाले खाते से साइन-इन या साइन-अप करता है, तो आपको यह पक्का करना होता है कि वह साइन-अप करने से पहले जो काम कर रहा था उसे जारी रख सके. ऐसा करने के लिए, साइन-इन यूज़र इंटरफ़ेस (यूआई) को कॉन्फ़िगर करते समय, autoUpgradeAnonymousUsers को true पर सेट करें. यह विकल्प डिफ़ॉल्ट रूप से बंद होता है.

पहचान छिपाकर इस्तेमाल करने वाले लोगों को अपग्रेड करने के दौरान होने वाले मर्ज के टकरावों को हैंडल करना

कई बार, कोई व्यक्ति पहले पहचान छिपाकर इस्तेमाल करने वाले खाते से साइन-इन करता है. इसके बाद, वह Firebase के किसी मौजूदा खाते में अपग्रेड करने की कोशिश करता है. चूंकि किसी मौजूदा उपयोगकर्ता को किसी दूसरे मौजूदा उपयोगकर्ता से लिंक नहीं किया जा सकता, इसलिए ऐसा होने पर FirebaseUI, signInFailure कॉलबैक को firebaseui/anonymous-upgrade-merge-conflict गड़बड़ी कोड के साथ ट्रिगर करेगा. गड़बड़ी वाले ऑब्जेक्ट में, स्थायी क्रेडेंशियल भी शामिल होगा. साइन-इन पूरा करने के लिए, कॉलबैक में स्थायी क्रेडेंशियल से साइन-इन करने की सुविधा ट्रिगर की जानी चाहिए. auth.signInWithCredential(error.credential) की मदद से साइन-इन पूरा करने से पहले, आपको पहचान छिपाकर इस्तेमाल करने वाले व्यक्ति का डेटा सेव करना होगा और पहचान छिपाकर इस्तेमाल करने वाले व्यक्ति के खाते को मिटाना होगा. इसके बाद, साइन-इन पूरा होने पर, डेटा को पहचान छिपाकर इस्तेमाल न करने वाले व्यक्ति के खाते में वापस कॉपी करें. नीचे दिए गए उदाहरण में बताया गया है कि यह फ़्लो कैसे काम करेगा.

// Temp variable to hold the anonymous user data if needed.
var data = null;
// Hold a reference to the anonymous current user.
var anonymousUser = firebase.auth().currentUser;
ui.start('#firebaseui-auth-container', {
  // Whether to upgrade anonymous users should be explicitly provided.
  // The user must already be signed in anonymously before FirebaseUI is
  // rendered.
  autoUpgradeAnonymousUsers: true,
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  callbacks: {
    // signInFailure callback must be provided to handle merge conflicts which
    // occur when an existing credential is linked to an anonymous user.
    signInFailure: function(error) {
      // For merge conflicts, the error.code will be
      // 'firebaseui/anonymous-upgrade-merge-conflict'.
      if (error.code != 'firebaseui/anonymous-upgrade-merge-conflict') {
        return Promise.resolve();
      }
      // The credential the user tried to sign in with.
      var cred = error.credential;
      // Copy data from anonymous user to permanent user and delete anonymous
      // user.
      // ...
      // Finish sign-in after data is copied.
      return firebase.auth().signInWithCredential(cred);
    }
  }
});

अगले चरण

  • FirebaseUI का इस्तेमाल करने और उसे पसंद के मुताबिक बनाने के बारे में ज़्यादा जानने के लिए, README पर जाएं.
  • अगर आपको FirebaseUI में कोई समस्या मिलती है और उसकी रिपोर्ट करनी है, तो GitHub के समस्या ट्रैकर का इस्तेमाल करें.