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

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

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

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

  1. अपने वेब ऐप्लिकेशन में Firebase से पुष्टि करने की सुविधा जोड़ें, ताकि यह पक्का किया जा सके कि v9 कॉम्पैट (सुझाया गया) या पुराने SDK टूल का इस्तेमाल किया जा रहा है (ऊपर मौजूद साइडबार देखें).

  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 मॉड्यूल

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

      $ npm install firebaseui --save

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

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

    3. बोवर कॉम्पोनेंट

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

// 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. ईमेल लिंक signInMethod के साथ, FirebaseUI signInOptions की सूची में ईमेल प्रोवाइडर का आईडी जोड़ें.

    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-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 कंसोल में, पुष्टि करने की सुविधा सेक्शन खोलें और तय की गई 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 डिफ़ॉल्ट रूप से दिख रहा है या नहीं. ज़्यादा जानकारी के लिए, reCap 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 पुष्टि वाले इंटरफ़ेस को रेंडर करें:

// 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 से जुड़ी समस्या को ट्रैक करने वाले टूल का इस्तेमाल करें.