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

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

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

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

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

  2. इनमें से किसी एक विकल्प का इस्तेमाल करके, FirebaseUI शामिल करें:

    1. सीडीएन

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

      <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" />

    2. npm मॉड्यूल

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

      $ npm install firebaseui --save

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

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

    3. 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 को शुरू करना

SDK टूल इंपोर्ट करने के बाद, Auth UI को शुरू करें.

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

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

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

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

  1. Firebase कंसोल में, पुष्टि सेक्शन खोलें और ईमेल और पासवर्ड की मदद से पुष्टि करने की सुविधा चालू करें.

  2. ईमेल सेवा देने वाली कंपनी का आईडी, FirebaseUI signInOptions की सूची में जोड़ें.

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

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

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

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

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

  3. ईमेल सेवा देने वाली कंपनी का आईडी, 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...
});

  4. साइन-इन यूज़र इंटरफ़ेस (यूआई) को शर्त के हिसाब से रेंडर करते समय (सिंगल पेज ऐप्लिकेशन के लिए ज़रूरी), 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);
}

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

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

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

    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 कंसोल में, पुष्टि सेक्शन खोलें और OAuth प्रोवाइडर से साइन इन करने की सुविधा चालू करें. पक्का करें कि उससे जुड़ा OAuth क्लाइंट आईडी और सीक्रेट भी दिया गया हो.

  2. साथ ही, पुष्टि सेक्शन में, पक्का करें कि जिस डोमेन पर आपका साइन-इन पेज रेंडर किया जाएगा उसे भी अनुमति वाले डोमेन की सूची में जोड़ दिया गया हो.

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

    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...
});

  4. ज़रूरी नहीं: हर प्रोवाइडर के लिए कस्टम स्कोप या कस्टम 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. फ़ोन नंबर की सेवा देने वाली कंपनी का आईडी, FirebaseUI signInOptions की सूची में जोड़ें.

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

  4. ज़रूरी नहीं: 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 साइन इन फ़्लो शुरू करने के लिए, Auth इंस्टेंस को पास करके FirebaseUI इंस्टेंस को शुरू करें.

// 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, गड़बड़ी कोड firebaseui/anonymous-upgrade-merge-conflict के साथ signInFailure कॉलबैक को ट्रिगर करेगा. गड़बड़ी वाले ऑब्जेक्ट में, हमेशा के लिए इस्तेमाल होने वाला क्रेडेंशियल भी शामिल होगा. साइन इन की प्रक्रिया पूरी करने के लिए, कॉलबैक में हमेशा के लिए इस्तेमाल किए जा सकने वाले क्रेडेंशियल से साइन इन करने की सुविधा को ट्रिगर किया जाना चाहिए. 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 समस्या ट्रैकर का इस्तेमाल करें.