在 Android 裝置上透過 Apple 登入使用者

本文說明如何使用 Identity Platform,在 Android 應用程式中新增「使用 Apple 登入」功能。

事前準備

向 Apple 設定應用程式

在 Apple Developer 網站上:

  1. 按照「為網站設定『透過 Apple 登入』功能」中的步驟操作。 包括:

    1. 註冊回傳網址,格式如下:

      https://project-id.firebaseapp.com/__/auth/handler
      
    2. 在下列網址暫時代管檔案,以驗證網域:

      https://project-id.firebaseapp.com/.well-known/apple-developer-domain-association.txt
      

    此外,請記下「服務 ID」和「Apple 團隊 ID」,下一節會用到。

  2. 使用 Apple 私密金鑰建立登入功能。 下一節會用到金鑰 ID

  3. 如果您使用 Identity Platform 傳送電子郵件給使用者,請使用下列電子郵件透過 Apple 的私密電子郵件轉送服務設定專案

    noreply@project-id.firebaseapp.com
    

    如果應用程式有自訂電子郵件範本,也可以使用該範本。

遵守 Apple 的去識別化資料規定

Apple 讓使用者選擇匿名處理資料,包括電子郵件地址。選取這個選項後,Apple 會為使用者指派網域為 privaterelay.appleid.com 的模糊化電子郵件地址。

您的應用程式必須遵守 Apple 針對匿名 Apple ID 制定的所有適用開發人員政策或條款。包括在將任何個人識別資訊 (PII) 與匿名 Apple ID 建立關聯前,先徵求使用者同意。涉及 PII 的動作包括但不限於:

  • 將電子郵件地址連結至匿名 Apple ID,或反向操作。
  • 將電話號碼連結至匿名 Apple ID,或反向操作
  • 將非匿名社群憑證 (例如 Facebook 或 Google) 連結至匿名 Apple ID,反之亦然。

詳情請參閱 Apple 開發人員帳戶的《Apple 開發人員計畫授權協議》。

將 Apple 設為提供者

如要將 Apple 設定為識別資訊提供者,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「Identity Providers」(識別資訊提供者) 頁面。

    前往「Identity Providers」頁面

  2. 按一下「新增供應商」

  3. 從清單中選取「Apple」

  4. 在「平台」下方,選取「Android」

  5. 輸入「服務 ID」、「Apple 團隊 ID」、「金鑰 ID」和「私密金鑰」

  6. 按一下「已授權網域」下方的「新增網域」,註冊應用程式的網域。為方便開發,localhost 預設為啟用狀態。

  7. 在「設定應用程式」下方,按一下「Android」。將程式碼片段複製到應用程式的程式碼中,初始化 Identity Platform 用戶端 SDK。

  8. 按一下 [儲存]

透過用戶端 SDK 登入使用者

  1. 使用 ID apple.com 建立 OAuthProvider 提供者物件的執行個體:

    Java

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("apple.com");
    

    Kotlin

    val provider = OAuthProvider.newBuilder("apple.com")
    
  2. 選填:新增 OAuth 範圍。範圍會指定您向 Apple 要求的資料。如要存取更敏感的資料,可能需要特定範圍。根據預設,啟用「每個電子郵件地址只能建立一個帳戶」後,Identity Platform 會要求 emailname 範圍。

    Java

    List<String> scopes =
        new ArrayList<String>() {
          {
            add("email");
            add("name");
          }
        };
    provider.setScopes(scopes);
    

    Kotlin

    provider.setScopes(arrayOf("email", "name"))
    
  3. 選用:將驗證流程在地化。你可以指定語言,或使用裝置的預設語言:

    Java

    // Localize the Apple authentication screen in French.
    provider.addCustomParameter("locale", "fr");
    

    Kotlin

    // Localize the Apple authentication screen in French.
    provider.addCustomParameter("locale", "fr");
    
  4. 使用 Identity Platform 登入使用者帳戶。

    1. 呼叫 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")
      }
      

      登入時,系統會將活動置於背景,這表示系統可以在驗證流程中回收活動。檢查結果是否已存在,可避免使用者必須登入兩次。

    2. 如果沒有待處理的結果,請呼叫 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 登入應用程式,系統就不會提供使用者資訊。

後續步驟