在辅助应用程序中执行的基本身份验证流程 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