文档Adobe PassAdobe Pass Authentication

（旧版）Amazon FireOS SDK，带有动态客户端注册功能

最近更新： 2025年5月5日
  • 主题：
  • Authentication
注意
此页面上的内容仅供参考。 使用此API需要来自Adobe的当前许可证。 不允许未经授权使用。
重要
确保随时了解汇总在产品公告页中的最新Adobe Pass身份验证产品公告和停用时间表。

简介

修改了适用于FireTV的FireOS AccessEnabler SDK，以便在不使用会话Cookie的情况下启用身份验证。 随着越来越多的浏览器限制对Cookie的访问，需要另一种方法来允许身份验证。

FireOS SDK 3.0.4 ​将基于已签名请求者ID和会话Cookie身份验证的当前应用程序注册机制替换为动态客户端注册概述。

API更改

Factory.getInstance

描述： ​实例化访问启用程序对象。 每个应用程序实例应有一个访问启用程序实例。

API调用：构造函数
公共静态AccessEnabler getInstance(Context appContext， String softwareStatement， String redirectUrl)
引发AccessEnablerException

可用性： v3.0+

参数：

  • appContext： Android应用程序上下文
  • softwareStatement：从TVE仪表板获取的值，或者如果字符串中设置了“software_statement”，则为​ null
  • redirectUrl ：对于FireTV实施，此参数应为null。 此属性上的任何设置都将被忽略。

备注

  • softwareStatement无效将导致应用程序无法初始化AccessEnabler或注册Adobe Pass身份验证和授权的应用程序
  • SDK将FireTV的redirectUrl参数设置为adobepass://android.app ，因为身份验证由唯一的AccessEnabler实例处理。

setRequestor

描述： ​建立通道的标识。 在为Adobe Pass身份验证系统注册Adobe后，每个渠道都会分配一个唯一的ID。 在处理SSO和远程令牌时，当应用程序处于后台时，身份验证状态可能会更改，当应用程序进入前台时，可以再次调用setRequestor以便与系统状态同步（如果启用了SSO，则获取远程令牌，如果同时发生注销，则删除本地令牌）。

服务器响应包含MVPD列表以及附加到通道标识的一些配置信息。 服务器响应由访问启用码在内部使用。 通过setRequestorComplete()回调只向应用程序显示操作的状态（即SUCCESS/FAIL）。

如果未使用​ url ​参数，则生成的网络调用将目标设置为默认服务提供程序URL：Adobe发布生产环境。

如果为​ url ​参数提供了值，则生成的网络调用将针对​ url ​参数中提供的所有URL。 所有配置请求都在单独的线程中同时触发。 在编译MVPD列表时，优先使用第一个响应程序。 对于列表中的每个MVPD， Access Enabler会记住关联服务提供商的URL。 所有后续权利请求都定向到与服务提供商关联的URL，该URL在配置阶段与目标MVPD配对。

API调用：请求者配置
公共void setRequestor(String requestorId)

可用性： v3.0+

API调用：请求者配置
public void setRequestor(String requestorId, ArrayList<String> urls)

可用性： v3.0+

参数：

  • requestorID：与渠道关联的唯一ID。 首次注册Adobe Pass身份验证服务时，请将Adobe分配的唯一ID传递到您的网站。
  • url：可选参数；默认情况下，使用Adobe服务提供程序(http://sp.auth.adobe.com/)。 此阵列允许您为Adobe提供的身份验证和授权服务指定端点（其他实例可能用于调试目的）。 您可以使用此选项指定多个Adobe Pass身份验证服务提供程序实例。 在执行此操作时，MVPD列表由来自所有服务提供商的端点组成。 每个MVPD都与最快的服务提供商相关联；即首先响应并支持该MVPD的提供商。

已弃用：

  • signedRequestorID：用您的私钥进行数字签名的请求者ID的副本。 。

已触发​ 回调： setRequestorComplete()

注销

描述： ​使用此方法启动注销流程。 注销是一系列HTTP重定向操作的结果，这是因为用户既需要从Adobe Pass身份验证服务器注销，也需要从MVPD服务器注销。 因此，此流程将打开一个ChromeCustomTab窗口以执行注销。

API调用：启动注销流程
public void logout()

可用性： v3.0+

参数： ​无

已触发​ 回调： setAuthenticationStatus()

程序员实施流程

1. 注册应用程序

  1. 从Adobe Pass获取software_statement （ TVE功能板）

  2. 可使用以下两个选项将这些值传递到Adobe Pass SDK：

    • 在strings.xml中，添加：

      <string name>"software\_statement">[softwarestatement value]</string>

    • 调用AccessEnabler.getInstance(appContext，softwareStatement， null)

2。 配置应用程序

  • a. setRequestor(requestor_id)

    SDK将执行以下操作：

    • 注册应用程序：使用​ software_statement，SDK将获得​ client_id， client_secret， client_id_issued_at， redirect_uris， grant_types。 此信息将存储在应用程序的内部存储中。
    • 使用client_id、client_secret和grant_type="client_credentials"获取​ access_token。 此access_token将用于SDK对Adobe Pass服务器进行的每次调用。
令牌错误响应：
HTTP 400（错误请求）
{"error"： "invalid_request"}
请求缺少必需的参数，包括不受支持的参数值（授予类型除外），重复参数，包括多个凭据，利用多个机制来验证客户端，或者格式不正确。
HTTP 400（错误请求）
{"error"： "invalid_client"}
客户端身份验证失败，因为客户端未知。 SDK 必须 ​再次向授权服务器注册。
HTTP 400（错误请求）
{"error"： "unauthorized_client"}
经过身份验证的客户端无权使用此授权授予类型。

  • 如果MVPD需要被动身份验证，则WebView将打开以使用该MVPD被动执行，并在完成后关闭

  • b. checkAuthentication()

    • true ：转至授权
    • false ：转到选择MVPD

  • c. getAuthentication ：SDK将在调用参数中包含​ access_token

    • 记住mvpd ：转到setSelectedProvider(mvpd_id)
    • 未选择mvpd ：displayProviderDialog
    • 已选择mvpd ：转到setSelectedProvider(mvpd_id)

  • d. setSelectProvider

    • mvpd_id身份验证URL加载到ChromeCustomTables中
    • 登录成功：delegate.setAuthenticationStatus ( SUCCESS )
    • 已取消登录：重置MVPD选择
    • URL方案将建立为“adobepass://android.app”，以便在身份验证完成时捕获

  • e. get/checkAuthorization ： SDK将在标头中包含​ access_token ​作为授权：持有者​ access_token

  • 如果授权成功，将调用以获取媒体令牌

  • f.注销：

    • SDK将删除当前请求者的有效令牌（由其他应用程序而非通过SSO获得的身份验证将保持有效）
    • SDK将打开Chrome自定义选项卡以访问mvpd_id注销端点。 完成后，Chrome自定义选项卡将关闭
    • URL方案将建立为“adobepass://logout”，以捕获注销完成时的时间
    • 注销将触发sendTrackingData(new Event(EVENT_LOGOUT，USER_NOT_AUTHENTICATED_ERROR)和回调：setAuthenticationStatus(0，"Logout")

注意： ​由于每个调用都需要一个​ access_token，因此SDK中会处理以下可能的错误代码。

错误响应
invalid_request
400
请求的格式不正确。 SDK应停止执行对服务器的调用。
invalid_client
403
不再允许客户端id执行请求。 sdk必须再次执行客户端注册。
access_denied
401
access_token无效。 sdk必须请求新的access_token。
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b