在 Android 上透過 Apple 登入使用者
本文說明如何使用 Identity Platform,在 Android 應用程式中加入「使用 Apple 登入」功能。
事前準備
建立使用 Identity Platform 的 Android 應用程式。
透過 Apple 設定應用程式
在 Apple Developer 網站上:
請按照「設定網頁版 Apple 登入功能」中的步驟操作。包括:
註冊返回網址,如下所示:
https://project-id.firebaseapp.com/__/auth/handler
在下列網址暫時代管檔案,以便驗證網域:
https://project-id.firebaseapp.com/.well-known/apple-developer-domain-association.txt
此外,請記下您的 服務 ID 和 Apple 團隊 ID,因為您會在下一節中使用這兩個 ID。
使用 Apple 私密金鑰建立登入功能。您將在下一節中使用鍵及其 ID。
如果您使用 Identity Platform 傳送電子郵件給使用者,請使用以下電子郵件透過 Apple 的私人電子郵件轉送服務設定專案:
noreply@project-id.firebaseapp.com
如果您的應用程式有自訂電子郵件範本,您也可以使用該範本。
遵守 Apple 的去識別化資料規定
Apple 提供使用者選擇是否要匿名處理資料的選項,包括電子郵件地址。Apple 會為選擇這個選項的使用者指派使用網域 privaterelay.appleid.com
的模糊處理電子郵件地址。
您的應用程式必須遵守 Apple 針對匿名 Apple ID 所發布的任何適用開發人員政策或條款。這包括在將任何個人識別資訊 (PII) 與匿名 Apple ID 建立關聯前,先徵得使用者同意。涉及個人識別資訊的動作包括但不限於:
- 將電子郵件地址連結至匿名 Apple ID,或反之。
- 將電話號碼連結至匿名 Apple ID,或將匿名 Apple ID 連結至電話號碼
- 將非匿名社群媒體憑證 (例如 Facebook 或 Google) 連結至匿名 Apple ID,或反之。
如需更多資訊,請參閱 Apple 開發人員帳戶的《Apple Developer Program License Agreement》。
將 Apple 設為供應商
如要將 Apple 設為識別資訊提供者,請按照下列步驟操作:
前往 Google Cloud 控制台的「Identity Providers」頁面。
按一下「新增供應商」。
從清單中選取「Apple」。
在「Platform」下方,選取「Android」。
輸入 服務 ID、Apple 團隊 ID、金鑰 ID 和私密金鑰。
按一下「Authorized domains」下方的「Add domain」,即可註冊應用程式的網域。為方便開發,
localhost
已預設為啟用。在「Configure your application」下方,按一下「Android」。將程式碼片段複製到應用程式的程式碼中,即可初始化 Identity Platform 用戶端 SDK。
按一下 [儲存]。
使用用戶端 SDK 登入使用者
使用 ID
apple.com
建立OAuthProvider
提供者物件的例項:Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("apple.com");
Kotlin
val provider = OAuthProvider.newBuilder("apple.com")
選用步驟:新增 OAuth 範圍。範圍會指定您向 Apple 要求哪些資料。較機密的資料可能需要特定範圍。根據預設,啟用「每個電子郵件地址只能建立一個帳戶」時,Identity Platform 會要求
email
和name
範圍。Java
List<String> scopes = new ArrayList<String>() { { add("email"); add("name"); } }; provider.setScopes(scopes);
Kotlin
provider.setScopes(arrayOf("email", "name"))
選用:將驗證流程本地化。您可以指定語言,也可以使用裝置的預設語言:
Java
// Localize the Apple authentication screen in French. provider.addCustomParameter("locale", "fr");
Kotlin
// Localize the Apple authentication screen in French. provider.addCustomParameter("locale", "fr");
使用 Identity Platform 登入使用者帳戶。
呼叫
startActivityForSignInWithProvider()
來檢查是否已收到回應:Java
mAuth = FirebaseAuth.getInstance(); Task<AuthResult> pending = mAuth.getPendingAuthResult(); if (pending != null) { pending.addOnSuccessListener(new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { Log.d(TAG, "checkPending:onSuccess:" + authResult); // Get the user profile with authResult.getUser() and // authResult.getAdditionalUserInfo(), and the ID // token from Apple with authResult.getCredential(). } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "checkPending:onFailure", e); } }); } else { Log.d(TAG, "pending: null"); }
Kotlin
val pending = auth.pendingAuthResult if (pending != null) { pending.addOnSuccessListener { authResult -> Log.d(TAG, "checkPending:onSuccess:$authResult") // Get the user profile with authResult.getUser() and // authResult.getAdditionalUserInfo(), and the ID // token from Apple with authResult.getCredential(). }.addOnFailureListener { e -> Log.w(TAG, "checkPending:onFailure", e) } } else { Log.d(TAG, "pending: null") }
登入後,系統會將活動置於背景,這表示系統可以在驗證流程中回收活動。檢查是否已存在結果,可避免使用者必須登入兩次。
如果沒有待處理的結果,請呼叫
startActivityForSignInWithProvider()
:Java
mAuth.startActivityForSignInWithProvider(this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // Sign-in successful! Log.d(TAG, "activitySignIn:onSuccess:" + authResult.getUser()); FirebaseUser user = authResult.getUser(); // ... } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "activitySignIn:onFailure", e); } });
Kotlin
auth.startActivityForSignInWithProvider(this, provider.build()) .addOnSuccessListener { authResult -> // Sign-in successful! Log.d(TAG, "activitySignIn:onSuccess:${authResult.user}") val user = authResult.user // ... } .addOnFailureListener { e -> Log.w(TAG, "activitySignIn:onFailure", e) }
與許多其他身分提供者不同,Apple 不會提供相片網址。
如果使用者選擇不與您的應用程式分享真實電子郵件地址,Apple 會為該使用者提供專屬電子郵件地址,供其使用。這封電子郵件的格式為 xyz@privaterelay.appleid.com
。如果您已設定私人電子郵件轉送服務,Apple 會將寄到匿名地址的電子郵件轉寄至使用者的實際電子郵件地址。
Apple 只會在使用者首次登入時,將使用者資訊 (例如顯示名稱) 提供給應用程式。在大多數情況下,Identity Platform 會儲存這類資料,讓您在日後的工作階段中使用 firebase.auth().currentUser.displayName
擷取資料。不過,如果您在整合 Identity Platform 之前,就允許使用者使用 Apple 登入應用程式,就無法取得使用者資訊。
後續步驟
- 進一步瞭解 Identity Platform 使用者。
- 使用其他身分識別提供者登入使用者。