Bu sayfada, Android uygulamasında Firebase Phone Number Verification nasıl kullanılacağı açıklanmaktadır. Bu özellik hakkında genel bir açıklama için genel bakış bölümüne bakın.
Bu sayfada, birleştirilmiş tek çağrılı API'yi kullanarak Firebase PNV ile nasıl entegrasyon yapılacağı ayrıntılı olarak açıklanmaktadır. Tek bir yöntemi çağırmak, kullanıcı iznini almaktan Firebase PNV arka ucuna gerekli ağ çağrılarını yapmaya kadar tüm Firebase PNV kullanıcı akışını yönetir. Bu yöntemi kullanarak entegrasyon adımlarını tek bir yöntem çağrısına indirirsiniz.
Bu API çoğu geliştirici için önerilir. Ancak kitaplığın karşılamadığı belirli gereksinimleriniz varsa özel akış uygulama hakkında bilgi edinmek için Firebase Phone Number Verification akışını özelleştirme sayfasına bakın.
Başlamadan önce
Uygulamanızın gizlilik politikasını herkese açık bir web sitesinde yayınlamanız gerekir. Bu sayfada, Firebase Phone Number Verification kullanılarak alınan telefon numaralarını nasıl kullandığınızı kullanıcılarınıza açıklamanız gerekir. Firebase PNV kitaplığı, kullanıcıların telefon numaralarını uygulamanızla paylaşmak için izin isterken bu sayfaya bağlantı verir.
1. Firebase projenizi oluşturma
Henüz yapmadıysanız Firebase'i Android projenize ekleyin.
Firebase PNV için Blaze planı gerekir. Projenizi henüz kullandıkça öde Blaze fiyatlandırma planına yükseltmediyseniz yükseltin.
Uygulamanızın SHA-256 parmak izini henüz Firebase konsolunda belirtmediyseniz Proje ayarları bölümünden yapın. Uygulamanızın SHA-256 parmak izini alma hakkında ayrıntılı bilgi için İstemcinizin Kimliğini Doğrulama başlıklı makaleyi inceleyin.
Google Cloud Console'da Firebase projenizi açın ve Firebase Phone Number Verification API'yi etkinleştirin.
Konsolun Kimlik bilgileri sayfasında Android API anahtarınızı açın ve Firebase Phone Number Verification API'yi seçilen API'ler listesine ekleyin.
2. Firebase PNV kitaplığını uygulamanıza ekleyin
Modülünüzün (uygulama düzeyinde) Gradle dosyasına (genellikle
<project>/<app-module>/build.gradle.kts
veya
<project>/<app-module>/build.gradle
) Android için
Firebase Phone Number Verification kitaplığının bağımlılığını ekleyin.
dependencies {
// Add the dependency for the Firebase Phone Number Verification library
implementation("com.google.firebase:firebase-pnv:16.0.0-beta01")
}
3. İsteğe bağlı: Firebase PNV desteği olup olmadığını kontrol edin
Doğrulama akışını başlatmadan önce cihazın ve SIM kartının API tabanlı telefon numarası doğrulamasını destekleyip desteklemediğini kontrol edebilirsiniz. Bu, kullanıcı izni gerektirmeyen bir ön kontroldür. Bu testin sonucunu, Firebase PNV akışını başlatıp başlatmayacağınıza veya telefon numarası doğrulaması için SMS gibi alternatif bir yöntem kullanıp kullanmayacağınıza karar vermek için kullanabilirsiniz.
Cihazın uyumluluğunu kontrol etmek için getVerificationSupportInfo()
yöntemini çağırın:
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()
, her SIM yuvası için bir tane olmak üzere VerificationSupportResult
nesnelerinin listesini döndürür. En az bir SIM kart destekleniyorsa Firebase PNV akışına devam edebilirsiniz.
4. Doğrulama akışını başlatma
Firebase PNV akışını başlatmak için FirebasePhoneNumberVerification
öğesinin yeni bir örneğini oluşturun ve Activity
bağlamını iletin. SDK'nın kullanıcıya izin ekranı göstermesi için Activity
bağlamı gerekir. Ardından, nesnenin getVerifiedPhoneNumber()
yöntemini çağırın:
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()
yöntemi, aşağıdakiler dahil olmak üzere telefon numarası doğrulama akışının tamamını gerçekleştirir:
- Android Credential Manager'ı kullanarak kullanıcılardan telefon numaralarını paylaşma izni alma.
- İsteği Firebase PNV arka ucuna gönderme
- Cihaz için doğrulanmış bir telefon numarası döndürülür.
5. Firebase PNV jetonunu kullanma
Akış başarılı olursa getVerifiedPhoneNumber()
yöntemi, doğrulanmış telefon numarasını ve bu numarayı içeren imzalı bir jetonu döndürür. Bu verileri, gizlilik politikanızda belirtildiği şekilde uygulamanızda kullanabilirsiniz.
Doğrulanmış telefon numarasını uygulama istemcisinin dışında kullanıyorsanız telefon numarasının kendisi yerine jetonu iletmeniz gerekir. Böylece, kullandığınızda bütünlüğünü doğrulayabilirsiniz. Jetonu doğrulamak için herhangi bir JWT doğrulama kitaplığını kullanabilirsiniz. Aşağıdakilerin tümünü doğrulamak için kitaplığı kullanın:
Jeton, Firebase PNV JWKS uç noktasında yayınlanan anahtarlardan biri kullanılarak imzalanır:
https://fpnv.googleapis.com/v1beta/jwks
Kitle ve veren talepleri, Firebase proje numaranızı içerir ve aşağıdaki biçimdedir:
https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBER
Firebase proje numaranızı Firebase konsolunun Proje ayarları sayfasında bulabilirsiniz.
Jetonun süresi dolmamış olmalıdır.
Örnek
Kısa bir örnek olarak, aşağıdaki Express.js uygulaması bir HTTP POST
isteğinden Firebase PNV jetonu alır ve jetonun imzasını ve taleplerini kontrol etmek için bir JWT doğrulama kitaplığı kullanır:
Node.js
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 uygulamasında oturum açma
Firebase PNV jetonunun Firebase Authentication oturum açma akışında kullanımına ilişkin bir örnek için Firebase Phone Number Verification kullanarak Firebase ile kimlik doğrulama sayfasına bakın.