在次要應用程式內執行的基本驗證流程 basic-authentication-flow-performed-within-secondary-application

IMPORTANT
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
IMPORTANT
REST API V2實作受到節流機制檔案的限制。

Adobe Pass驗證許可權內的​ 驗證流程 ​可讓串流應用程式驗證使用者是否擁有有效的MVPD帳戶。 此程式要求使用者擁有作用中的MVPD帳戶,並在MVPD登入頁面上輸入有效的登入認證。

在下列情況下需要驗證流程:

  • 使用者首次開啟應用程式時。
  • 當使用者的先前驗證過期時。
  • 當使用者從MVPD帳戶登出時。
  • 當使用者想要使用不同的MVPD進行驗證時。

在所有這些情況下,呼叫任何設定檔端點的應用程式會收到空白回應或一或多個設定檔,但針對不同的MVPD。

驗證流程 ​需要使用者代理程式(瀏覽器)來完成從應用程式到Adobe Pass後端,然後到MVPD登入頁面,最後返回應用程式的一系列呼叫。 此流程可能包括數個重新導向至MVPD系統並管理針對每個網域儲存的Cookie或工作階段,若沒有使用者代理程式,這對於實現和安全都極具挑戰。

根據主要應用程式(串流應用程式)支援使用者互動以選取MVPD以及在使用者代理程式中使用選取的MVPD進行驗證的功能,驗證情況如下:

使用預先選取的mvpd在次要應用程式內執行驗證 perform-authentication-within-secondary-application-with-preselected-mvpd

先決條件 prerequisites-perform-authentication-within-secondary-application-with-preselected-mvpd

在啟動主要應用程式內的驗證流程,並透過次要應用程式內的使用者互動完成驗證流程之前,請確定符合下列先決條件:

  • 串流應用程式必須選取MVPD。
  • 串流應用程式必須起始驗證工作階段,才能使用選取的MVPD登入。
  • 次要應用程式必須在使用者代理程式中使用選取的MVPD進行驗證。
IMPORTANT
假設
  • 串流應用程式支援使用者互動以選取MVPD。
  • 次要應用程式(通常在次要裝置上)支援使用者互動,以在使用者代理程式中使用選取的MVPD進行驗證。

工作流程 workflow-perform-authentication-within-secondary-application-with-preselected-mvpd

請依照指定的步驟,使用預先選取的MVPD來實作在次要應用程式內執行的基本驗證流程,如下圖所示。

使用預先選取的mvpd在次要應用程式內執行驗證

使用預先選取的mvpd在次要應用程式內執行驗證

  1. 建立驗證工作階段: ​串流應用程式會呼叫工作階段端點,收集所有必要的資料以啟動驗證工作階段。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱建立驗證工作階段 API檔案:
    • 所有​_必要的_​引數,例如serviceProvidermvpddomainNameredirectUrl
    • 所有​_必要的_​標頭,例如AuthorizationAP-Device-Identifier
    • 所有​_選用的_​引數和標頭
    串流應用程式在建立驗證工作階段時,必須在單一呼叫中提供所有必要的引數。
  2. 指示下一個動作: ​工作階段端點回應包含必要的資料,可引導串流應用程式瞭解下一個動作。

    note important
    IMPORTANT
    如需工作階段回應中所提供資訊的詳細資訊,請參閱建立驗證工作階段 API檔案。
    「工作階段」端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    • 提供的serviceProvidermvpd之間的整合必須是作用中。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。
  3. 繼續決策流程: ​工作階段端點回應包含下列資料:

    • actionName屬性已設定為「授權」。
    • actionType屬性設定為「直接」。

    如果Adobe Pass後端識別有效的設定檔,串流應用程式就不需要使用選取的MVPD重新驗證,因為已經有設定檔可用於後續的決策流程。

  4. 顯示驗證代碼: ​工作階段端點回應包含下列資料:

    • code可用於在次要應用程式中繼續驗證工作階段。
    • actionName屬性已設定為「驗證」。
    • actionType屬性設定為「互動式」。

    如果Adobe Pass後端未識別有效的設定檔,串流應用程式會顯示可用於在次要應用程式中繼續驗證工作階段的code

  5. 驗證驗證碼: ​次要應用程式會驗證所提供的使用者code,以確保它可以在使用者代理程式中繼續進行MVPD驗證。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱擷取驗證工作階段資訊 API檔案:
    • 所有​_必要的_​引數,例如serviceProvidercode
    • 所有​_必要的_​標頭,例如Authorization
    • 所有​_選用的_​引數和標頭
  6. 傳回有關驗證工作階段的資訊: ​工作階段端點回應包含以下資料:

    • existing屬性包含已經提供的現有引數。
    • missing屬性包含遺漏的引數,需要提供這些引數才能完成驗證流程。
    note important
    IMPORTANT
    請參閱擷取驗證工作階段資訊 API檔案,以取得工作階段驗證回應中所提供資訊的詳細資訊。
    「工作階段」端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。
    note tip
    TIP
    建議:次要應用程式可通知使用者,在錯誤回應指出遺失驗證工作階段的情況下,所使用的code無效,並通知他們使用新的工作階段重試。
  7. 在使用者代理程式中開啟URL: ​次要應用程式會開啟使用者代理程式,以載入自行計算的url,向驗證端點提出要求。 此流程可能包含數個重新導向,最終將使用者帶往MVPD登入頁面並提供有效認證。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱使用者代理程式🔗 API檔案中的執行驗證:
    • 所有​_必要的_​引數,例如serviceProvidercode
    • 所有​_選用的_​引數和標頭
  8. 完成MVPD驗證: ​如果驗證流程成功,使用者代理程式互動會在Adobe Pass後端儲存一般設定檔,並到達提供的redirectUrl

  9. 擷取特定程式碼的設定檔: ​串流應用程式會傳送要求至設定檔端點,以收集擷取設定檔資訊所需的所有資料。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱特定程式碼🔗 API檔案的擷取設定檔:
    • 所有​_必要的_​引數,例如serviceProvidercode
    • 所有​_必要的_​標頭,例如AuthorizationAP-Device-Identifier
    • 所有​_選用的_​引數和標頭
    note tip
    TIP
    建議:串流應用程式可以使用code實作輪詢機制,以檢查一般設定檔是否已成功產生並儲存。
  10. 傳回關於一般設定檔的資訊: ​設定檔端點回應包含關於與所接收引數和標題關聯的一般設定檔的資訊。

    note important
    IMPORTANT
    請參閱特定程式碼🔗 API檔案的擷取設定檔,以取得設定檔回應中提供的詳細資訊。
    設定檔端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。

在次要應用程式內執行驗證,而不預先選取mvpd perform-authentication-within-secondary-application-without-preselected-mvpd

先決條件 prerequisites-perform-authentication-within-secondary-application-without-preselected-mvpd

在啟動主要應用程式內的驗證流程,並透過次要應用程式內的使用者互動完成驗證流程之前,請確定符合下列先決條件:

  • 串流應用程式必須在需要登入時起始驗證工作階段。
  • 次要應用程式必須選取MVPD。
  • 次要應用程式必須在使用者代理程式中使用選取的MVPD進行驗證。
IMPORTANT
假設
  • 次要應用程式(通常在次要裝置上)支援使用者互動以選取MVPD。
  • 次要應用程式(通常在次要裝置上)支援使用者互動,以在使用者代理程式中使用選取的MVPD進行驗證。

工作流程 workflow-perform-authentication-within-secondary-application-without-preselected-mvpd

請依照指定的步驟來實作在次要應用程式中執行的基本驗證流程,而不使用預先選取的MVPD,如下圖所示。

在次要應用程式內執行驗證,而不預先選取mvpd

在次要應用程式內執行驗證,而不預先選取mvpd

  1. 建立驗證工作階段: ​串流應用程式會收集一些必要的資料,藉由呼叫「工作階段」端點來啟動驗證工作階段。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱建立驗證工作階段 API檔案:
    • 所有​_必要的_​引數,例如serviceProvider
    • 所有​_必要的_​標頭,例如AuthorizationAP-Device-Identifier
    • 所有​_選用的_​引數和標頭
    串流應用程式在建立驗證工作階段時,無法在單一呼叫中提供所有必要的引數。
  2. 指示下一個動作: ​工作階段端點回應包含必要的資料,可引導串流應用程式進行下一個動作:

    • code可用於在次要應用程式中繼續驗證工作階段。
    • actionName屬性設定為「resume」。
    • actionType屬性設定為「直接」。
    note important
    IMPORTANT
    如需工作階段回應中所提供資訊的詳細資訊,請參閱建立驗證工作階段 API檔案。
    「工作階段」端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。
  3. 顯示驗證代碼: ​串流應用程式顯示可用於在次要應用程式中繼續驗證工作階段的code

  4. 提供驗證工作階段遺漏的引數: ​次要應用程式會收集恢複驗證工作階段所需的所有遺漏資料,並呼叫工作階段端點。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱繼續驗證工作階段 API檔案:
    • 所有​_必要的_​引數,例如serviceProvidermvpddomainNameredirectUrl
    • 所有​_必要的_​標頭,例如AuthorizationAP-Device-Identifier
    • 所有​_選用的_​引數和標頭
  5. 指示下一個動作: ​工作階段端點回應包含必要的資料,可引導串流應用程式瞭解下一個動作。

    note important
    IMPORTANT
    如需工作階段回應中所提供資訊的詳細資訊,請參閱繼續驗證工作階段 API檔案。
    「工作階段」端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    • 提供的serviceProvidermvpd之間的整合必須是作用中。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。
    note tip
    TIP
    建議:次要應用程式可通知使用者,在錯誤回應指出遺失驗證工作階段的情況下,所使用的code無效,並通知他們使用新的工作階段重試。
  6. 指示現有的設定檔: ​工作階段端點回應包含下列資料:

    • actionName屬性已設定為「授權」。
    • actionType屬性設定為「直接」。

    如果Adobe Pass後端識別有效的設定檔,串流應用程式就不需要使用選取的MVPD重新驗證,因為已經有設定檔可用於後續的決策流程。

  7. 在使用者代理程式中開啟URL: ​工作階段端點回應包含下列資料:

    • url可用來在MVPD登入頁面中起始互動式驗證。
    • actionName屬性已設定為「驗證」。
    • actionType屬性設定為「互動式」。

    如果Adobe Pass後端未識別有效的設定檔,次要應用程式會開啟使用者代理程式以載入提供的url,並向驗證端點提出要求。 此流程可能包含數個重新導向,最終將使用者帶往MVPD登入頁面並提供有效認證。

  8. 完成MVPD驗證: ​如果驗證流程成功,使用者代理程式互動會在Adobe Pass後端儲存一般設定檔,並到達提供的redirectUrl

  9. 擷取特定程式碼的設定檔: ​串流應用程式會傳送要求至設定檔端點,以收集擷取設定檔資訊所需的所有資料。

    note important
    IMPORTANT
    如需下列詳細資訊,請參閱特定程式碼🔗 API檔案的擷取設定檔:
    • 所有​_必要的_​引數,例如serviceProvidercode
    • 所有​_必要的_​標頭,例如AuthorizationAP-Device-Identifier
    • 所有​_選用的_​引數和標頭
    note tip
    TIP
    建議:串流應用程式可以使用code實作輪詢機制,以檢查一般設定檔是否已成功產生並儲存。
  10. 傳回關於一般設定檔的資訊: ​設定檔端點回應包含關於與所接收引數和標題關聯的一般設定檔的資訊。

    note important
    IMPORTANT
    請參閱特定程式碼🔗 API檔案的擷取設定檔,以取得設定檔回應中提供的詳細資訊。
    設定檔端點會驗證請求資料,以確保符合基本條件:
    • 必要 ​引數和標頭必須有效。
    如果驗證失敗,將會產生錯誤回應,提供可遵守增強錯誤碼檔案的額外資訊。
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b