文件Adobe PassAdobe Pass 驗證

（舊版） Android SDK逐步指南

2025年2月14日
  • 主題：
  • 驗證
NOTE
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
IMPORTANT
請務必隨時瞭解彙總在產品公告頁面中的最新Adobe Pass驗證產品公告和淘汰時間表。

簡介

本檔案說明程式設計師的上層應用程式可透過Android AccessEnabler資料庫公開的API實施的權益工作流程。

Android的Adobe Pass驗證許可權解決方案最終將分為兩個網域：

  • UI網域 — 這是上層應用程式層，會實作UI並使用AccessEnabler程式庫所提供的服務來提供對受限制內容的存取權。

  • AccessEnabler網域 — 這是以下列形式實施權益工作流程的地方：

    • 對Adobe後端伺服器發出的網路呼叫
    • 與驗證和授權工作流程相關的商業邏輯規則
    • 管理各種資源及處理工作流程狀態（例如Token快取）

AccessEnabler網域的目標是隱藏軟體權利檔案工作流程的所有複雜性，並（透過AccessEnabler資料庫）提供一組簡單軟體權利檔案基本要素，供您實作軟體權利檔案工作流程：

  1. 設定要求者身分。

  2. 檢查並取得特定身分提供者的驗證。

  3. 檢查並取得特定資源的授權。

  4. 登出。

AccessEnabler的網路活動會發生在不同的執行緒中，因此不會封鎖UI執行緒。 因此，兩個應用程式網域之間的雙向通訊通道必須遵循完全非同步模式：

  • UI應用程式層透過AccessEnabler程式庫公開的API呼叫，將訊息傳送至AccessEnabler網域。
  • AccessEnabler會透過AccessEnabler通訊協定（UI層向AccessEnabler程式庫註冊）中包含的回呼方法來回應UI層。

權益流程

  1. 先決條件
  2. 啟動流程
  3. 驗證流程
  4. 授權流程
  5. 檢視Media流程
  6. 登出流程

A.必要條件

  1. 建立回呼函式：

    • 'setRequestorComplete()'

      由setRequestor()觸發，傳回成功或失敗。
      成功表示您可以繼續權益呼叫。

    • displayProviderDialog(mvpd)

      僅當使用者尚未選取提供者(MVPD)且尚未驗證時，才由getAuthentication()觸發。
      mvpds引數是使用者可用的提供者陣列。

    • 'setAuthenticationStatus(status， errorcode)'

      每次都由checkAuthentication()觸發。
      只有在使用者已經驗證且已選取提供者時，才會由getAuthentication()觸發。

      傳回的狀態是成功或失敗，錯誤碼會說明失敗的型別。

    • navigateToUrl(url)

      在使用者選取MVPD後由getAuthentication()觸發。 url引數提供MVPD登入頁面的位置。

    • 'sendTrackingData(event， data)'

      由checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider()觸發。
      event引數指出已發生的權利事件；data引數是與事件相關的值清單。

    • 'setToken(token， resource)'

      在成功授權檢視資源後由checkAuthorization()和getAuthorization()觸發。
      token引數是短期的媒體權杖；resource引數是使用者有權檢視的內容。

    • 'tokenRequestFailed(resource， code， description)'

      在授權失敗後由checkAuthorization()和getAuthorization()觸發。
      resource引數是使用者嘗試檢視的內容；code引數是錯誤碼，指出發生的失敗型別；description引數描述與錯誤碼相關的錯誤。

    • 'selectedProvider(mvpd)'

      由getSelectedProvider()觸發。
      mvpd引數提供使用者所選取之提供者的相關資訊。

    • 'setMetadataStatus(metadata， key， arguments)'

      由getMetadata().觸發
      metadata引數提供您要求的特定資料；key引數是getMetadata()要求中使用的索引鍵；arguments引數是傳遞給getMetadata()的相同字典。

    • 'preauthorizedResources(resources)'

      由checkPreauthorizedResources()觸發。
      authorizedResources引數會顯示使用者有權檢視的資源。

B.啟動流程

  1. 啟動上層應用程式。

  2. 啟動Adobe Pass驗證

    a.呼叫getInstance以建立Adobe Pass Authentication AccessEnabler的單一執行個體。

    • 相依性： Adobe Pass Authentication Native
      Android資料庫(AccessEnabler)

    b.呼叫 setRequestor()以建立程式設計師的識別碼；傳入程式設計師的requestorID以及（選擇性）Adobe Pass驗證端點的陣列。

    • 相依性： ​有效的Adobe Pass驗證要求者ID
      (請與您的Adobe Pass驗證客戶經理合作安排此作業。)

    • 觸發器： setRequestorComplete()回呼

    注意
    在完全建立請求者身分之前，無法完成任何權益請求。 這實際上表示，當setRequestor()仍在執行時，所有後續的軟體權利檔案要求（例如，checkAuthentication()）都會遭到封鎖。

    您有兩個實作選項：將要求者識別資訊傳送至後端伺服器後，UI應用程式層可以選擇下列其中一種方法：

    1. 等候觸發setRequestorComplete()回呼（AccessEnabler委派的一部分）。 此選項最能確定setRequestor()已完成，因此建議用於大部分實作。
    2。 繼續而不等候setRequestorComplete()回呼的觸發，並開始發出權益要求。 這些呼叫(checkAuthentication、checkAuthorization、getAuthorization、getAuthorization、checkPreauthorizedResource、getMetadata、logout)會由AccessEnabler程式庫排入佇列，這將會在setRequestor(). 之後進行實際的網路呼叫。例如，如果網路連線不穩定，此選項有時會中斷。

  3. 呼叫checkAuthentication()以檢查現有的驗證，而不啟動完整的驗證流程。 如果此呼叫成功，您可以直接繼續進行授權流程。 如果沒有，請繼續驗證流程。

    • 相依性： ​成功呼叫setRequestor() （此相依性也適用於所有後續呼叫）。

    • 觸發器： setAuthenticationStatus()回呼

C.驗證流程

  1. 呼叫getAuthentication()以啟動驗證流程，或取得使用者已驗證的確認。
    觸發器：

    • setAuthenticationStatus()回呼（如果使用者已經驗證）。 在此情況下，請直接進入授權流程。
    • displayProviderDialog()回呼（如果使用者尚未驗證）。

  2. 向使用者呈現傳送至displayProviderDialog()的提供者清單。

  3. 使用者選取提供者後，從navigateToUrl()回呼取得使用者MVPD的URL。 開啟WebView並將該WebView控制項導向至URL。

  4. 透過上一步中具現化的WebView，使用者登入MVPD的登入頁面並輸入登入認證。 在WebView中會執行數個重新導向操作。

    注意： ​此時，使用者有機會取消驗證流程。 如果發生這種狀況，您的UI層會負責呼叫setSelectedProvider() （以null作為引數），將此事件通知AccessEnabler。 這可讓AccessEnabler清理其內部狀態，並重設驗證流程。

  5. 使用者成功登入後，您的應用程式層會偵測「自訂重新導向URL」的載入（亦即： http://adobepass.android.app）。 此自訂URL實際上是不適用於WebView載入的無效URL。 這是驗證流程已完成，且需要關閉WebView的訊號。

  6. 關閉WebView控制項並呼叫getAuthenticationToken()，指示AccessEnabler從後端伺服器擷取驗證權杖。

  7. [選擇性]呼叫checkPreauthorizedResources(resources)以檢查使用者有權檢視哪些資源。 resources引數是與使用者的驗證Token關聯的受保護資源陣列。
    觸發器： preAuthorizedResources()回呼
    執行點： ​在完成驗證流程之後

  8. 如果驗證成功，請繼續前往授權流程。

D.授權流程

  1. 呼叫getAuthorization()以啟動授權
    流量。

    相依性：與MVPD議定的有效ResourceID。

    注意： ResourceID應該與任何其他裝置或平台上使用的相同，而且在MVPD上將會相同。

  2. 驗證驗證和授權。

    • 如果getAuthorization()呼叫成功：使用者擁有有效的AuthN和AuthZ權杖（使用者已驗證並獲授權觀看要求的媒體）。

    • 如果getAuthorization()失敗：檢查擲回的例外狀況，以判斷其型別（AuthN、AuthZ或其他專案）：

      • 如果這是驗證(AuthN)錯誤，請重新啟動驗證流程。
      • 如果是授權(AuthZ)錯誤，則使用者無權觀看請求的媒體，並且應向使用者顯示某種錯誤訊息。
      • 如果有其他型別的錯誤（連線錯誤、網路錯誤等），則向使用者顯示適當的錯誤訊息。

  3. 驗證短媒體權杖。
    使用Adobe Pass驗證媒體權杖驗證器程式庫，驗證從上述getAuthorization()呼叫傳回的短期媒體權杖：

    • 如果驗證成功：為使用者播放要求的媒體。
    • 如果驗證失敗： AuthZ權杖無效，應拒絕媒體請求，並向使用者顯示錯誤訊息。

  4. 返回正常的應用程式流程。

E.檢視Media流程

  1. 使用者選取要檢視的媒體。
  2. 媒體是否受到保護？ 您的應用程式會檢查選取的媒體是否受到保護：
  • 如果選取的媒體受到保護，您的應用程式會啟動上述授權流程。
  • 如果選取的媒體未受到保護，則播放該媒體的使用者。

F.登出流程

  1. 呼叫logout()將使用者登出。
    AccessEnabler會清除目前MVPD的所有快取值和權杖，以供目前的要求者使用，也可供具有單一登入要求的要求者使用。 清除快取之後，AccessEnabler會進行伺服器呼叫以清除伺服器端工作階段。 請注意，由於伺服器呼叫可能會導致SAML重新導向至IdP （這允許IdP端的工作階段清理），此呼叫必須在所有重新導向之後。 因此，必須在WebView控制項中處理這個呼叫。

    a.遵循與驗證工作流程相同的模式，AccessEnabler網域會向UI應用程式層提出要求（透過navigateToUrl()回呼）以建立WebView控制項，並指示該控制項在後端伺服器上載入登出端點的URL。

    b.再次強調，UI必須監視WebView控制項的活動，並偵測控制項在經過數個重新導向時，載入應用程式的自訂URL （亦即： http://adobepass.android.app/）的時刻。 發生此事件後，UI應用程式層會關閉WebView並完成登出程式。

    注意： ​登出流程與驗證流程不同，因為使用者不需要以任何方式與WebView互動。 UI應用程式層會使用WebView來確保遵循所有重新導向。 因此，可以（而且建議）在登出過程中將WebView控制項隱藏（即隱藏）。

使用多個MVPD登入和登出的使用者流程

這裡您有一份檔案，說明使用多個MVPD時的行為，以及使用者從應用程式登出時發生的情況。

使用Android SDK版本>= 2.0.0時，可使用此描述的行為。

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b