DocumentaciónAdobe PassAdobe Pass Authentication

Referencia de la API del cliente nativo de Amazon FireOS amazon-fireos-native-client-api-reference

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
El contenido de esta página se proporciona únicamente con fines informativos. El uso de esta API requiere una licencia actual de Adobe. No se permite el uso no autorizado.

Introducción intro

Este documento detalla los métodos y las llamadas de retorno expuestos por el SDK de Amazon FireOS para la autenticación de Adobe Pass, compatible con la autenticación de Adobe Pass. Los métodos y las funciones de devolución de llamada que se describen aquí se definen en los archivos de encabezado AccessEnabler.h y EntitlementDelegate.h.

Consulte https://tve.zendesk.com/hc/en-us/articles/115005561623-fire-TV-Native-AccessEnabler-Library para conocer el SDK de Amazon FireOS AccessEnabler más reciente.

NOTE
El equipo de autenticación de Adobe Pass le recomienda usar solamente las API de autenticación de Adobe Pass public:
  • Las API públicas están disponibles y totalmente probadas en todos los tipos de clientes admitidos. Para cualquier función pública, nos aseguramos de que cada tipo de cliente tenga una versión correspondiente de los métodos asociados.
  • Las API públicas deben ser lo más estables posible, admitir la compatibilidad con versiones anteriores y garantizar que las integraciones de socios no se rompan. Sin embargo, para las API que no sean públicas de non, nos reservamos el derecho de cambiar su firma en cualquier momento futuro. Si se encuentra con un flujo particular que no se puede admitir a través de una combinación de las llamadas públicas actuales a la API de autenticación de Adobe Pass, el mejor enfoque es hacérnoslo saber. Teniendo en cuenta sus necesidades, podemos modificar las API públicas y proporcionar una solución estable en el futuro.

API de SDK de Amazon FireOS api

Factory.getInstance getInstance

Descripción: crea una instancia del objeto de habilitación de acceso. Debe haber una sola instancia de Access Enabler por cada instancia de aplicación.

Llamada de API: constructor
public static AccessEnabler getInstance(Context appContext, String softwareStatement, String redirectUrl)<br> throws AccessEnablerException
public static AccessEnabler getInstance(Context appContext, String env_url, String softwareStatement, String redirectUrl) throws AccessEnablerException

Disponibilidad: v3.0+

Parámetros:

  • appContext: contexto de aplicación de Amazon Fire OS.
  • softwareStatement
  • redirectUrl : en caso de FireOS, el valor del parámetro se ignora y se establece en default : adobepass://android.app
  • env_url: para realizar pruebas con el entorno de ensayo de Adobe, env_url se puede establecer en "sp.auth-staging.adobe.com"

Obsoleto:

    public static AccessEnabler getInstance(Context appContext)
        throws AccessEnablerException

setRequestor setRequestor

Descripción: establece la identidad del programador. A cada programador se le asigna un ID único al registrarse con el Adobe en el sistema de autenticación de Adobe Pass. Esta configuración solo debe realizarse una vez durante el ciclo de vida de la aplicación.

La respuesta del servidor contiene una lista de MVPD junto con información de configuración adjunta a la identidad del programador. El código Access Enabler utiliza internamente la respuesta del servidor. Solo el estado de la operación (es decir, SUCCESS/FAIL) se presenta a la aplicación a través de la llamada de retorno setRequestorComplete().

Si no se usa el parámetro urls, la llamada de red resultante se dirigirá a la dirección URL del proveedor de servicios predeterminado: el entorno de producción/versión de Adobe.

Si se proporciona un valor para el parámetro urls, la llamada de red resultante se dirigirá a todas las direcciones URL proporcionadas en el parámetro urls. Todas las solicitudes de configuración se activan simultáneamente en subprocesos independientes. El primer respondedor tiene prioridad al compilar la lista de MVPD. Para cada MVPD de la lista, el Habilitador de acceso recuerda la URL del proveedor de servicios asociado. Todas las solicitudes de derechos subsiguientes se dirigen a la URL asociada al proveedor de servicios emparejado con la MVPD de destino durante la fase de configuración.

Llamada de API: configuración del solicitante
public void setRequestor(String requestorId)

Disponibilidad: v3.0+

Llamada de API: configuración del solicitante
public void setRequestor(String requestorId, ArrayList<String> urls)

Disponibilidad: v3.0+

Parámetros:

  • requestorID: ID único asociado con el programador. Pase el ID único asignado por el Adobe a su sitio cuando se registró por primera vez en el servicio de autenticación de Adobe Pass.
  • urls: Parámetro opcional; de forma predeterminada, se utiliza el proveedor de servicios de Adobe (http://sp.auth.adobe.com/). Esta matriz permite especificar extremos para los servicios de autenticación y autorización proporcionados por el Adobe (se pueden utilizar diferentes instancias para la depuración). Puede utilizar esto para especificar varias instancias del proveedor de servicios de autenticación de Adobe Pass. Al hacerlo, la lista de MVPD se compone de los extremos de todos los proveedores de servicios. Cada MVPD está asociado con el proveedor de servicios más rápido; es decir, el proveedor que respondió primero y que admite ese MVPD.

Llamadas de retorno activadas: setRequestorComplete()

Obsoleto:

    public void setRequestor(String requestorId, String signedRequestorId)

    public void setRequestor(String requestorId, String signedRequestorId, ArrayList<String> urls)

setRequestorComplete setRequestorComplete

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso que informa a la aplicación de que la fase de configuración ha finalizado. Esto indica que la aplicación puede empezar a emitir solicitudes de derechos. La aplicación no puede emitir solicitudes de asignación de derechos hasta que se complete la fase de configuración.

Llamada de retorno: configuración del solicitante completa
public void setRequestorComplete(int status)

Disponibilidad: v1.0+

Parámetros:

  • status: puede tomar uno de los siguientes valores:

    • AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS - configuración
      la fase se completó correctamente
    • AccessEnabler.ACCESS_ENABLER_STATUS_ERROR - configuración
      fase fallida

Activado por: setRequestor()

setOptions fire_setOption

Descripción: configura las opciones globales del SDK. Acepta Map&lt;String, String> como argumento. Los valores del mapa se pasan al servidor junto con cada llamada de red que realice el SDK.

Los valores se pasan al servidor independientemente del flujo actual (autenticación/autorización). Si desea cambiar los valores, puede llamar a este método en cualquier momento.

Llamada de API: setOptions
public void setOptions(HashMap<String,String> options)

Disponibilidad: v3.0+

Parámetros:

  • options: un mapa&lt;String, String> que contiene las opciones globales del SDK. Actualmente están disponibles las siguientes opciones:

    • applicationProfile: se puede usar para realizar configuraciones de servidor basadas en este valor.
    • ap_vi - Servicio de ID de Experience Cloud. Este valor puede utilizarse posteriormente en informes de análisis avanzados.
    • device_info - Información del dispositivo como se describe en Pasar la información del dispositivo en la guía

checkAuthentication checkAuthN

Descripción: Comprueba el estado de autenticación. Para ello, busca un token de autenticación válido en el espacio de almacenamiento del token local. Llamar a este método no realiza llamadas de red. La aplicación la utiliza para consultar el estado de autenticación del usuario y actualizar la interfaz de usuario en consecuencia (es decir, actualizar la interfaz de usuario de inicio de sesión/cierre de sesión). El estado de autenticación se comunica a la aplicación mediante la llamada de retorno setAuthenticationStatus().

Si una MVPD admite la función "Autenticación por solicitante", se pueden almacenar varios tokens de autenticación en un dispositivo.

Llamada de API: comprobar el estado de autenticación
public void checkAuthentication()

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: setAuthenticationStatus()

getAuthentication getAuthN

Descripción: inicia el flujo de trabajo de autenticación completo. Se inicia comprobando el estado de autenticación. Si no se ha autenticado ya, se inicia el flujo de autenticación estado-máquina:

  • Si el último intento de autenticación se realizó correctamente, se omite la fase de selección de MVPD y un control WebView presenta al usuario la página de inicio de sesión de MVPD.
  • Si el último intento de autenticación no se realizó correctamente o si el usuario cerró la sesión explícitamente, se desencadenará la llamada de retorno displayProviderDialog(). La aplicación utiliza esta llamada de retorno para mostrar la interfaz de usuario de selección de MVPD. Además, la aplicación debe reanudar el flujo de autenticación informando a la biblioteca del Habilitador de acceso sobre la selección de MVPD del usuario mediante el método setSelectedProvider().

Si una MVPD admite la función "Autenticación por solicitante", se pueden almacenar varios tokens de autenticación en un dispositivo (uno por programador).

Por último, el estado de autenticación se comunica a la aplicación a través de la llamada de retorno setAuthenticationStatus().

Llamada de API: inicia el flujo de autenticación
public void getAuthentication()

Disponibilidad: v1.0+

Llamada de API: inicia el flujo de autenticación
public void getAuthentication(boolean forceAuthN, Map<String, Object> genericData)

Disponibilidad: v1.0+

Parámetros:

  • forceAuthn: Un indicador que especifica si el flujo de autenticación debe iniciarse, independientemente de si el usuario ya se ha autenticado o no.
  • datos: Mapa que contiene pares de clave-valor que se enviarán al servicio de pase de TV de pago. El Adobe de puede utilizar estos datos para habilitar futuras funciones sin cambiar el SDK.

Llamadas de retorno activadas: setAuthenticationStatus(), displayProviderDialog(), sendTrackingData()

displayProviderDialog displayProviderDialog

Descripción La llamada de retorno desencadenada por el Habilitador de acceso para informar a la aplicación de que es necesario crear una instancia de los elementos de la interfaz de usuario apropiados para permitir que el usuario seleccione la MVPD deseada. La llamada de retorno proporciona una lista de objetos MVPD con información adicional que puede ayudar a crear correctamente el panel de la interfaz de usuario de selección (como la URL que señala al logotipo de MVPD, un nombre para mostrar descriptivo, etc.)

Una vez que el usuario ha seleccionado la MVPD deseada, la aplicación de capa superior debe reanudar el flujo de autenticación llamando a setSelectedProvider() y pasándole el ID de la MVPD correspondiente a la selección del usuario.

Llamada de retorno: mostrar la IU de selección de MVPD
public void displayProviderDialog(ArrayList<Mvpd> mvpds)

Disponibilidad: v1.0+

Parámetros:

  • mvpds: lista de objetos MVPD que contienen información relacionada con MVPD que la aplicación puede utilizar para crear los elementos de la interfaz de usuario de selección de MVPD.

Activado por: getAuthentication(), getAuthorization()

setSelectedProvider setSelectedProvider

Descripción: Su aplicación llama a este método para informar al Habilitador de acceso de la selección de MVPD del usuario. Al pasar null como parámetro, el Habilitador de acceso restableció la MVPD actual a un valor nulo.

Llamada de API: establece el proveedor seleccionado actualmente
public void setSelectedProvider(String mvpdId)

Disponibilidad: ​v 1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: setAuthenticationStatus(), sendTrackingData()

Descripción: devolución de llamada desencadenada por el Habilitador de acceso en el SDK de Android. Debe ignorarse en el SDK de Amazon FireOS.

Llamada de retorno: mostrar la página de inicio de sesión de MVPD
public void navigateToUrl(String url)

Disponibilidad: v1.0+

Parámetros:

  • url: Dirección URL que señala a la página de inicio de sesión de la MVPD

Activado por: getAuthentication(), setSelectedProvider()

getAuthenticationToken getAuthNToken

Descripción: completa el flujo de autenticación al solicitar el token de autenticación del servidor back-end.

llamada API: recuperar el token de autenticación
public void getAuthenticationToken(String cookies)

Disponibilidad: v1.0+

Parámetros:

  • cookies: cookies configuradas en el dominio de destino (consulte la aplicación de demostración en el SDK para obtener una implementación de referencia).

Llamadas de retorno activadas: setAuthenticationStatus(), sendTrackingData()

setAuthenticationStatus setAuthNStatus

Descripción: La devolución de llamada desencadenada por el Habilitador de acceso, que informa a la aplicación del estado de la autenticación. Existen muchos lugares en los que el flujo de autenticación puede fallar, ya sea como resultado de la interacción del usuario o debido a otros escenarios imprevistos (es decir, problemas de conectividad de red, etc.). Esta llamada de retorno informa a la aplicación del estado de éxito/error de la autenticación, a la vez que proporciona información adicional sobre el motivo del error, cuando es necesario.

Esta llamada de retorno también indica cuándo se ha completado el flujo de cierre de sesión.

Llamada de retorno: informar del estado del flujo de autenticación
public void setAuthenticationStatus(int status, String errorCode)

Disponibilidad: v1.0+

Parámetros:

  • status: puede tomar uno de los siguientes valores:

    • AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS: el flujo de autenticación se completó correctamente
    • AccessEnabler.ACCESS_ENABLER_STATUS_ERROR - error en el flujo de autenticación
    • AccessEnabler.ACCESS_ENABLER_STATUS_LOGOUT - cierre de sesión

  • código: motivo del estado presentado. Si status es AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS, entonces code es una cadena vacía (es decir, definida por la constante AccessEnabler.USER_AUTHENTICATED). Si no se autentica, este parámetro puede tomar uno de los siguientes valores:

    • AccessEnabler.USER_NOT_AUTHENTICATED_ERROR - El usuario no está autenticado. En respuesta a la llamada al método checkAuthentication() cuando no hay un token de autenticación válido en la caché de token local.
    • AccessEnabler.PROVIDER_NOT_SELECTED_ERROR - AccessEnabler ha restablecido el estado-máquina de autenticación después de que la aplicación de capa superior pasara null a setSelectedProvider() para anular el flujo de autenticación. Es de suponer que el usuario ha cancelado el flujo de autenticación (es decir, ha presionado el botón "Atrás").
    • AccessEnabler.GENERIC_AUTHENTICATION_ERROR: error en el flujo de autenticación debido a motivos como la no disponibilidad de la red o que el usuario canceló explícitamente el flujo de autenticación.
    • AccessEnabler.LOGOUT - El usuario no está autenticado debido a una acción de cierre de sesión.

Activado por: checkAuthentication(), getAuthentication(), checkAuthorization()

checkPreauthorizedResources checkPreauth

Descripción: La aplicación utiliza este método para determinar si el usuario ya tiene autorización para ver recursos protegidos específicos. El propósito principal de este método es recuperar información para utilizarla en la decoración de la interfaz de usuario (por ejemplo, para indicar el estado de acceso con los iconos de bloqueo y desbloqueo).

Llamada de API: establece el proveedor seleccionado actualmente
public void checkPreauthorizedResources(ArrayList<String> resources)

Disponibilidad: v1.0+

<Parámetros: El parámetro resources es una matriz de recursos cuya autorización debe comprobarse. Cada elemento de la lista debe ser una cadena que represente el ID de recurso. El id. de recurso está sujeto a las mismas limitaciones que el id. de recurso de la llamada getAuthorization(); es decir, debe ser un valor acordado establecido entre el programador y la MVPD o un fragmento de RSS multimedia.

Devolución de llamada desencadenada: preauthorizedResources()

preauthorizedResources preauthResources

Descripción: devolución de llamada desencadenada por checkPreauthorizedResources(). Proporciona una lista de recursos que el usuario ya tiene autorización para ver.

Llamada de API: establece el proveedor seleccionado actualmente
public void checkPreauthorizedResources(ArrayList<String> resources)

Disponibilidad: ​v 1.0+

Parámetros: El parámetro resources es una matriz de recursos que el usuario ya tiene autorización para ver.

Activado por: checkPreauthorizedResources()

checkAuthorization checkAuthZ

Descripción: La aplicación utiliza este método para comprobar el estado de autorización. Se inicia comprobando primero el estado de autenticación. Si no se autentica, se activa la devolución de llamada setTokenRequestFailed() y se cierra el método. Si el usuario está autenticado, también almacena en déclencheur el flujo de autorización. Vea los detalles del método getAuthorization().

Llamada de API: compruebe el estado de autorización
public void checkAuthorization(String resourceId)

Disponibilidad: v1.0+

Llamada de API: compruebe el estado de autorización
public void checkAuthorization(String resourceId, Map<String, Object> genericData)

Disponibilidad: v1.0+

Parámetros:

  • resourceId: El identificador del recurso para el que el usuario solicita autorización.
  • datos: Mapa que contiene pares de clave-valor que se enviarán al servicio de pase de TV de pago. El Adobe de puede utilizar estos datos para habilitar futuras funciones sin cambiar el SDK.

Llamadas de retorno activadas: tokenRequestFailed(), setToken(), sendTrackingData(), setAuthenticationStatus()

getAuthorization getAuthZ

Descripción: La aplicación utiliza este método para iniciar el flujo de autorización. Si el usuario aún no se ha autenticado, también inicia el flujo de autenticación. Si el usuario se autentica, el Habilitador de acceso procede a emitir solicitudes para el token de autorización (si no hay ningún token de autorización válido en la caché de tokens local) y para el token de medios de corta duración. Una vez obtenido el token de medios corto, el flujo de autorización se considera completo. La llamada de retorno setToken() se activa y el token de medios corto se entrega como parámetro a la aplicación. Si, por cualquier motivo, la autorización falla, la llamada de retorno tokenRequestFailed() se activa y se proporcionan el código de error y los detalles.

Llamada de API: inicia el flujo de autorización
public void getAuthorization(String resourceId)

Disponibilidad: v1.0+

Llamada de API: inicia el flujo de autorización
public void getAuthorization(String resourceId, Map<String, Object> genericData)

Disponibilidad: v1.0+

Parámetros:

  • resourceId: El identificador del recurso para el que el usuario solicita autorización.
  • datos: Mapa que contiene pares de clave-valor que se enviarán al servicio de pase de TV de pago. El Adobe de puede utilizar estos datos para habilitar futuras funciones sin cambiar el SDK.

Llamadas de retorno activadas: tokenRequestFailed(), setToken(), sendTrackingData()

Se activaron devoluciones de llamadas adicionales
Este método también puede almacenar en déclencheur las siguientes devoluciones de llamadas (si también se inició el flujo de autenticación): setAuthenticationStatus(), displayProviderDialog()

NOTA: utilice checkAuthorization() en lugar de getAuthorization() siempre que sea posible. El método getAuthorization() iniciará un flujo de autenticación completo (si el usuario no está autenticado) y esto podría llevar a una implementación complicada por parte del programador.

setToken setToken

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso que informa a la aplicación de que el flujo de autorización se completó correctamente. El token de medios de corta duración también se entrega como parámetro.

Llamada de retorno: flujo de autorización completado correctamente
public void setToken(String token, String resourceId)

Disponibilidad: ​v 1.0+

Parámetros:

  • token: El token de medios de corta duración
  • resourceId: El recurso para el que se obtuvo la autorización

Activado por: checkAuthorization(), getAuthorization()

tokenRequestFailed tokenRequestFailed

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso que informa a la aplicación de capa superior de que el flujo de autorización ha fallado.

Llamada de retorno: error en el flujo de autorización
public void tokenRequestFailed(String resourceId, <br> String errorCode, String errorDescription)

Disponibilidad: v1.0+

Parámetros:

  • resourceId: El recurso para el que se obtuvo la autorización
  • errorCode: código de error asociado al escenario de error. Valores posibles:
    • AccessEnabler.USER_NOT_AUTHORIZED_ERROR - El usuario no pudo autorizar el recurso dado
  • errorDescription: detalles adicionales acerca del escenario de error. Si esta cadena descriptiva no está disponible por algún motivo, la autenticación de Adobe Pass enviará una cadena vacía >(""). Una MVPD puede utilizar esta cadena para pasar mensajes de error personalizados o mensajes relacionados con las ventas. Por ejemplo, si se deniega a un suscriptor la autorización para un recurso, la MVPD podría enviar un mensaje como: "Actualmente no tiene acceso a este canal en su paquete. Si desea actualizar el paquete, haga clic aquí." El mensaje lo pasa la autenticación de Adobe Pass a través de esta llamada de retorno al programador, que tiene la opción de mostrarlo o ignorarlo. La autenticación de Adobe Pass también puede utilizar este parámetro para notificar la condición que podría haber provocado un error. Por ejemplo, "Se produjo un error de red al comunicarse con el servicio de autorización del proveedor".

Activado por: checkAuthorization(), getAuthorization()

cierre de sesión logout

Descripción: Utilice este método para iniciar el flujo de cierre de sesión. El cierre de sesión es el resultado de una serie de operaciones de redirección HTTP debido al hecho de que el usuario debe cerrar la sesión tanto desde los servidores de autenticación de Adobe Pass como desde los servidores de MVPD.

Llamada de API: inicia el flujo de cierre de sesión
public void logout()

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: Ninguna

getSelectedProvider getSelectedProvider

Descripción: Utilice este método para determinar el proveedor seleccionado actualmente.

Llamada de API: determina la MVPD seleccionada actualmente
public void getSelectedProvider()

Disponibilidad: v1.0+

Parámetros: Ninguno

Llamadas de retorno activadas: selectedProvider()

selectedProvider selectedProvider

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso que entrega información sobre la MVPD seleccionada actualmente a la aplicación.

Llamada de retorno: información sobre la MVPD seleccionada actualmente
public void selectedProvider(Mvpd mvpd)

Disponibilidad: v1.0+

Parámetros:

  • mvpd: objeto que contiene información sobre la MVPD seleccionada actualmente

Activado por: getSelectedProvider()

getMetadata getMetadata

Descripción: Utilice este método para recuperar información expuesta como metadatos por la biblioteca del Habilitador de acceso. La aplicación puede tener acceso a esta información proporcionando un objeto MetadataKey compuesto.

Llamada de API: consulta al AccessEnabler para obtener metadatos
public void getMetadata(MetadataKey metadataKey)

Disponibilidad: v1.0+

Hay dos tipos de metadatos disponibles para los programadores:

  • Metadatos estáticos (TTL del token de autenticación, TTL del token de autorización e ID de dispositivo)
  • Metadatos del usuario (información específica del usuario, como el ID de usuario y el código postal; pasados de una MVPD al dispositivo de un usuario durante los flujos de autenticación o autorización)

Parámetros:

  • metadataKey: Una estructura de datos que encapsula una clave y una variable args, con el significado siguiente:

    • Si la clave es METADATA_KEY_TTL_AUTHN, se realiza la consulta para obtener el tiempo de caducidad del token de autenticación.

    • Si la clave es METADATA_KEY_TTL_AUTHZ y args contiene un objeto SerializableNameValuePair con el nombre = METADATA_ARG_RESOURCE_ID y el valor = [resource_id], se realiza la consulta para obtener la hora de caducidad del token de autorización asociado al recurso especificado.

    • Si la clave es METADATA_KEY_DEVICE_ID, se realiza la consulta para obtener el ID del dispositivo actual. Tenga en cuenta que esta función está desactivada de forma predeterminada y los programadores deben ponerse en contacto con el Adobe para obtener información sobre la habilitación y las tarifas.

    • Si la clave es METADATA_KEY_USER_META y args contiene un objeto SerializableNameValuePair con el nombre = METADATA_KEY_USER_META y el valor = [metadata_name], se realiza la consulta de los metadatos del usuario. La lista actual de tipos de metadatos de usuario disponibles:

      • zip - Código postal
      • householdID - Identificador del hogar. Si una MVPD no admite subcuentas, será idéntica a userID.
      • maxRating - Clasificación parental máxima para el usuario
      • userID: el identificador de usuario. Si una MVPD admite subcuentas y el usuario no es la cuenta principal,
      • channelID: lista de canales que el usuario puede ver

Los metadatos de usuario reales disponibles para un programador dependen de lo que una MVPD ponga a disposición. Esta lista se ampliará a medida que haya nuevos metadatos disponibles y añadidos al sistema de autenticación de Adobe Pass.

Llamadas de retorno activadas: setMetadataStatus()

Más información: Metadatos de usuario

setMetadataStatus setMetadaStatus

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso que entrega los metadatos solicitados mediante una llamada a getMetadata().

Llamada de retorno: resultado de la solicitud de recuperación de metadatos
public void setMetadataStatus(MetadataKey key, MetadataStatus result)

Disponibilidad: v1.0+

Parámetros:

  • key: El objeto MetadataKey que contiene la clave para la cual se solicita el valor de los metadatos y los parámetros asociados (vea la aplicación de demostración para una implementación de referencia).

  • result: Un objeto compuesto que contiene los metadatos solicitados. El objeto tiene los campos siguientes:

    • simpleResult: una cadena que representa el valor de los metadatos cuando se realizó la solicitud para el TTL de autenticación, el TTL de autorización o el ID de dispositivo. Este valor es nulo si se realizó la solicitud de metadatos del usuario.

    • userMetadataResult: un objeto que contiene la representación Java de una carga útil de metadatos de usuario JSON. Por ejemplo:

      code language-json 
      {
"street": "Main Avenue",
"buildings": ["150", "320"]
}

      se traduce a Java como:

      code language-java 
      Map("street" -> "Main Avenue", "buildings" -> List("150", "320")))

      La estructura real de los objetos de metadatos de usuario es similar a la siguiente:

      code language-json 
      {
    updated: 1334243471,
    encrypted: ["encryptedProp"],
    data: {
        zip: ["12345", "34567"],
        maxRating: {
            "MPAA": "PG-13",
            "VCHIP": "TV-Y",
            "URL": "http://exam.pl/e/manage/ratings"
        },
        householdID: "3456",
        userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
        channelID: ["channel-1", "channel-2"]
    }
}

Este valor es nulo cuando se realizó la solicitud de metadatos simples (TTL de autenticación, TTL de autorización o ID de dispositivo).

  • cifrado: valor booleano que especifica si los metadatos recuperados están cifrados o no. Este parámetro solo es significativo para solicitudes de metadatos del usuario, no tiene significado para metadatos estáticos (por ejemplo, TTL de autenticación) que siempre se reciben sin cifrar. Si este parámetro se establece en True, depende del programador obtener el valor de metadatos de usuario sin cifrar realizando un descifrado RSA con la clave privada de la lista blanca (la misma clave privada que se utiliza para la firma del id. del solicitante en la llamada setRequestor).

Activado por: getMetadata()

Más información: Metadatos de usuario

getVersion getVersion

Descripción: Utilice este método para recuperar la versión actual de AccessEnabler

Llamada de API: obtener la versión de AccessEnabler
public static String getVersion()

Seguimiento de eventos tracking

El activador de acceso déclencheur una llamada de retorno adicional que no está necesariamente relacionada con los flujos de derechos. La implementación de la función de devolución de llamada de seguimiento de eventos denominada sendTrackingData() es opcional, pero permite a la aplicación realizar un seguimiento de eventos específicos y compilar estadísticas como el número de intentos de autenticación/autorización correctos/fallidos. A continuación se muestra la especificación para la llamada de retorno sendTrackingData():

sendTrackingData sendTrackingData

Descripción: La llamada de retorno desencadenada por el Habilitador de acceso indica a la aplicación la ocurrencia de varios eventos, como la finalización o el error de los flujos de autenticación o autorización. sendTrackingData() también informa del tipo de dispositivo, el tipo de cliente del Access Enabler y el sistema operativo.

WARNING
El tipo de dispositivo y el sistema operativo se derivan del uso de una biblioteca Java pública (http://java.net/projects/user-agent-utils) y de la cadena del agente de usuario. Tenga en cuenta que esta información se proporciona solo como una forma grosera de desglosar las métricas operativas en categorías de dispositivos, pero que ese Adobe no puede responsabilizarse de los resultados incorrectos. Utilice la nueva funcionalidad en consecuencia.

  • Valores posibles para el tipo de dispositivo:

    • computer
    • tablet
    • mobile
    • gameconsole
    • unknown

  • Valores posibles para el tipo de cliente del Habilitador de acceso:

    • flash
    • html5
    • ios
    • tvos
    • android
    • firetv
Callback: seguimiento de eventos
public void sendTrackingData(Event event, ArrayList<String> data)

Disponibilidad: v1.0+

Parámetros:

  • event: el evento que se está rastreando. Existen tres tipos de eventos de seguimiento posibles:

    • authorizationDetection: cada vez que se devuelve una solicitud de token de autorización (el tipo de evento es EVENT_AUTHZ_DETECTION)
    • authenticationDetection: cada vez que se produce una comprobación de autenticación (el tipo de evento es EVENT_AUTHN_DETECTION)
    • mvpdSelection: cuando el usuario selecciona una MVPD en el formulario de selección de MVPD (el tipo de evento es EVENT_MVPD_SELECTION)

  • datos: datos adicionales asociados al evento del que se informó. Estos datos se presentan en forma de lista de valores.

A continuación se proporcionan instrucciones para interpretar los valores de la matriz data:

  • Para el tipo de evento EVENT_AUTHN_DETECTION:

    • 0 - Si la solicitud de token se realizó correctamente (verdadero/falso) y si lo anterior es verdadero:
    • 1 - cadena de ID de MVPD
    • 2 - GUID (md5 con hash)
    • 3: el token ya está en la caché (verdadero/falso)
    • 4 - Tipo de dispositivo
    • 5 - Tipo de cliente del Habilitador de acceso
    • 6 - Tipo de sistema operativo

  • Para el tipo de evento EVENT_AUTHZ_DETECTION

    • 0 - Si la solicitud de token se realizó correctamente (verdadero/falso) y si se realizó correctamente:
    • 1 - ID DE MVPD
    • 2 - GUID (md5 con hash)
    • 3: el token ya está en la caché (verdadero/falso)
    • 4 - Error
    • 5 - Detalles
    • 6 - Tipo de dispositivo
    • 7 - Tipo de cliente del Habilitador de acceso
    • 8 - Tipo de sistema operativo

  • Para el tipo de evento EVENT_MVPD_SELECTION

    • 0: ID de la MVPD seleccionada actualmente
    • 1 - Tipo de dispositivo
    • 2 - Tipo de cliente del Habilitador de acceso
    • 3 - Tipo de sistema operativo

Activado por: checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider()

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