شروع به کار با تأیید شماره تلفن Firebase در اندروید کنید

این صفحه نحوه استفاده Firebase Phone Number Verification در یک برنامه اندروید را شرح می‌دهد. برای توضیحات کلی این ویژگی، به نمای کلی مراجعه کنید.

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

این API برای اکثر توسعه‌دهندگان توصیه می‌شود؛ با این حال، اگر الزامات خاصی دارید که توسط کتابخانه برآورده نمی‌شود، برای کسب اطلاعات در مورد پیاده‌سازی یک جریان سفارشی، به صفحه جریان Firebase Phone Number Verification سفارشی‌سازی مراجعه کنید.

قبل از اینکه شروع کنی

شما باید سیاست حفظ حریم خصوصی برنامه خود را در یک وب‌سایت عمومی منتشر کنید. در این صفحه، باید به کاربران خود توضیح دهید که چگونه از شماره تلفن‌های بازیابی شده با استفاده Firebase Phone Number Verification استفاده می‌کنید. کتابخانه Firebase PNV هنگام درخواست رضایت از کاربران برای به اشتراک گذاشتن شماره تلفن آنها با برنامه شما، به این صفحه پیوند می‌دهد.

۱. پروژه فایربیس خود را راه‌اندازی کنید

  1. اگر قبلاً Firebase را به پروژه اندروید خود اضافه نکرده‌اید، آن را اضافه کنید .

  2. Firebase PNV به طرح Blaze نیاز دارد. اگر هنوز پروژه خود را به طرح قیمت‌گذاری Pay-as-you-go Blaze ارتقا نداده‌اید، این کار را انجام دهید.

  3. اگر هنوز اثر انگشت SHA-256 برنامه خود را در کنسول Firebase مشخص نکرده‌اید، این کار را از تنظیمات پروژه انجام دهید. برای جزئیات بیشتر در مورد نحوه دریافت اثر انگشت SHA-256 برنامه خود، به بخش احراز هویت کلاینت خود مراجعه کنید.

  4. پروژه Firebase خود را در کنسول Google Cloud باز کنید و API Firebase Phone Number Verification فعال کنید .

  5. در صفحه اعتبارنامه‌های کنسول، کلید API اندروید خود را باز کنید و API Firebase Phone Number Verification به لیست APIهای انتخاب شده اضافه کنید.

۲. کتابخانه Firebase PNV را به برنامه خود اضافه کنید

در فایل Gradle ماژول (سطح برنامه) خود (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle )، وابستگی مربوط به کتابخانه Firebase Phone Number Verification برای اندروید را اضافه کنید.

dependencies {
    // Add the dependency for the Firebase Phone Number Verification library
    implementation("com.google.firebase:firebase-pnv:16.0.0-beta01")
}

۳. اختیاری: بررسی پشتیبانی Firebase PNV

قبل از شروع جریان تأیید، می‌توانید بررسی کنید که آیا دستگاه و سیم‌کارت آن از تأیید شماره تلفن مبتنی بر API پشتیبانی می‌کنند یا خیر. این یک پیش‌بررسی است که نیازی به رضایت کاربر ندارد. می‌توانید از نتیجه این آزمایش برای تصمیم‌گیری در مورد شروع جریان Firebase PNV یا استفاده از یک روش جایگزین برای تأیید شماره تلفن، مانند پیامک، استفاده کنید.

برای بررسی سازگاری دستگاه، متد getVerificationSupportInfo() را فراخوانی کنید:

Kotlin 

import com.google.firebase.pnv.FirebasePhoneNumberVerification

// Get an instance of the SDK.
val fpnv = FirebasePhoneNumberVerification.getInstance()

// Check all SIMs for support.
fpnv.getVerificationSupportInfo()
  .addOnSuccessListener { results ->
    if (results.any { it.isSupported() }) {
      // At least one SIM is supported; proceed with FPNV flow
    } else {
      // No SIMs are supported, so fall back to SMS verification.
    }
  }
  .addOnFailureListener { e ->
    // Handle error.
  }

تابع getVerificationSupportInfo() لیستی از اشیاء VerificationSupportResult را برمی‌گرداند، که برای هر اسلات سیم‌کارت یکی است. اگر حداقل از یک سیم‌کارت پشتیبانی شود، می‌توانید جریان Firebase PNV را ادامه دهید.

۴. جریان تأیید را آغاز کنید

برای شروع جریان Firebase PNV ، یک نمونه جدید از FirebasePhoneNumberVerification ایجاد کنید و یک Activity context به آن اضافه کنید. برای اینکه SDK بتواند صفحه رضایت را به کاربر نمایش دهد، Activity context لازم است. سپس، متد getVerifiedPhoneNumber() شیء را فراخوانی کنید:

Kotlin 

// Get an instance of the SDK _with an Activity context_:
val fpnv = FirebasePhoneNumberVerification.getInstance(this@MainActivity)

// Call getVerifiedPhoneNumber
fpnv.getVerifiedPhoneNumber("https://example.com/privacy-policy")
  .addOnSuccessListener { result ->
    val phoneNumber = result.getPhoneNumber()
    val token = result.getToken()
    // Verification successful. Send token to your backend.
  }
  .addOnFailureListener { e ->
    // Handle failures, such as the user declining consent or a network error.
  }

متد getVerifiedPhoneNumber() کل جریان تأیید شماره تلفن را انجام می‌دهد، از جمله:

  • استفاده از Android Credential Manager برای کسب رضایت کاربر جهت اشتراک‌گذاری شماره تلفن او.
  • ارسال درخواست به بک‌اند Firebase PNV .
  • بازگرداندن شماره تلفن تأیید شده برای دستگاه.

۵. استفاده از توکن Firebase PNV

اگر این روند با موفقیت انجام شود، متد getVerifiedPhoneNumber() شماره تلفن تأیید شده و یک توکن امضا شده حاوی آن را برمی‌گرداند. می‌توانید از این داده‌ها در برنامه خود، طبق سیاست حفظ حریم خصوصی خود، استفاده کنید.

اگر از شماره تلفن تأیید شده خارج از کلاینت برنامه استفاده می‌کنید، باید به جای خود شماره تلفن، توکن را ارسال کنید تا بتوانید هنگام استفاده از آن، صحت آن را تأیید کنید. برای تأیید توکن، می‌توانید از هر کتابخانه تأیید JWT استفاده کنید. از این کتابخانه برای تأیید همه موارد زیر استفاده کنید:

  • این توکن با استفاده از یکی از کلیدهای منتشر شده در نقطه پایانی Firebase PNV JWKS امضا شده است:

    https://fpnv.googleapis.com/v1beta/jwks

  • ادعاهای مخاطب و صادرکننده شامل شماره پروژه Firebase شما هستند و به شکل زیر می‌باشند:

    https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBER

    می‌توانید شماره پروژه فایربیس خود را در صفحه تنظیمات پروژه کنسول فایربیس پیدا کنید.

  • توکن منقضی نشده است.

مثال

به عنوان یک مثال کوتاه، برنامه Express.js زیر یک توکن Firebase PNV از یک درخواست HTTP POST دریافت می‌کند و از یک کتابخانه تأیید JWT برای بررسی امضا و ادعاهای توکن استفاده می‌کند:

نود جی اس 

import express from "express";
import { JwtVerifier } from "aws-jwt-verify";

// Find your Firebase project number in the Firebase console.
const FIREBASE_PROJECT_NUMBER = "123456789";

// The issuer and audience claims of the FPNV token are specific to your
// project.
const issuer = `https://fpnv.googleapis.com/projects/${FIREBASE_PROJECT_NUMBER}`;
const audience = `https://fpnv.googleapis.com/projects/${FIREBASE_PROJECT_NUMBER}`;

// The JWKS URL contains the current public signing keys for FPNV tokens.
const jwksUri = "https://fpnv.googleapis.com/v1beta/jwks";

// Configure a JWT verifier to check the following:
// - The token is signed by Google
// - The issuer and audience claims match your project
// - The token has not yet expired (default behavior)
const fpnvVerifier = JwtVerifier.create({ issuer, audience, jwksUri });

const app = express();

app.post('/verifiedPhoneNumber', async (req, res) => {
    if (!req.body) return res.sendStatus(400);
    // Get the token from the body of the request.
    const fpnvToken = req.body;
    try {
        // Attempt to verify the token using the verifier configured above.
        const verifiedPayload = await fpnvVerifier.verify(fpnvToken);

        // If verification succeeds, the subject claim of the token contains the
        // verified phone number. You can use this value however it's needed by
        // your app.
        const verifiedPhoneNumber = verifiedPayload.sub;
        // (Do something with it...)

        return res.sendStatus(200);
    } catch {
        // If verification fails, reject the token.
        return res.sendStatus(400);
    }
});

app.listen(3000);

وارد یک برنامه Firebase شوید

برای مثالی از استفاده از توکن Firebase PNV در جریان ورود به سیستم Firebase Authentication ، به صفحه احراز هویت با فایربیس با استفاده از Firebase Phone Number Verification مراجعه کنید.