Guía del SDK para iOS/tvOS iostvos-sdk-cookbook

Cree sus funciones de devolución de llamada:

• setRequestorComplete()

• Activado por setRequestor(), devuelve un resultado correcto o erróneo.

• El éxito indica que se puede continuar con las llamadas de asignación de derechos.

• displayProviderDialog(mvpds)

  • Activado por getAuthentication() solo si el usuario no ha seleccionado ningún proveedor (MVPD) y aún no se ha autenticado.
  • El parámetro mvpds es una matriz de proveedores disponibles para el usuario.

• setAuthenticationStatus(status, errorcode)

  • Activado por checkAuthentication() cada vez.
  • Activado por getAuthentication() solo si el usuario ya se ha autenticado y ha seleccionado un proveedor.
  • El estado devuelto es éxito o error, el código de error describe el tipo de error.

• navigateToUrl(url)

  • Activado por getAuthentication() después de que el usuario seleccione una MVPD. El parámetro url proporciona la ubicación de la página de inicio de sesión de la MVPD.

• sendTrackingData(event, data)

  • Activado por checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider().
  • El parámetro event indica qué evento de asignación de derechos se produjo; el parámetro data es una lista de valores relacionados con el evento.

• setToken(token, resource)

  • Activado por checkAuthorization() y getAuthorization() tras una autorización correcta para ver un recurso.
  • El parámetro token es el token de medios de corta duración; el parámetro resource es el contenido que el usuario tiene autorización para ver.

• tokenRequestFailed(resource, code, description)

  • Activado por checkAuthorization() y getAuthorization() tras una autorización incorrecta.
  • El parámetro resource es el contenido que el usuario intentaba ver; el parámetro code es el código de error que indica qué tipo de error se produjo; el parámetro description describe el error asociado con el código de error.

• selectedProvider(mvpd)

  • Activado por getSelectedProvider().
  • El parámetro mvpd proporciona información sobre el proveedor seleccionado por el usuario.

• setMetadataStatus(metadata, key, arguments)

  • Activado por getMetadata().
  • El parámetro metadata proporciona los datos específicos solicitados; el parámetro key es la clave utilizada en la solicitud getMetadata(); y el parámetro arguments es el mismo diccionario que se pasó a getMetadata().

• preauthorizedResources(authorizedResources)

  • Activado por checkPreauthorizedResources().

  • El parámetro authorizedResources presenta los recursos que el usuario
    tiene autorización para ver.

• presentTvProviderDialog(viewController)

  • Se activa por getAuthentication() cuando el solicitante actual admite al menos en MVPD compatibles con SSO.
  • El parámetro viewController es el cuadro de diálogo de SSO de Apple y debe presentarse en el controlador de vista principal.

• dismissTvProviderDialog(viewController)

  • Se activa mediante una acción del usuario (seleccionando "Cancelar" u "Otros proveedores de TV" en el cuadro de diálogo de SSO de Apple).
  • El parámetro viewController es el cuadro de diálogo de SSO de Apple y debe descartarse del controlador de vista principal.

Iniciar la aplicación de nivel superior.

Iniciar autenticación de Adobe Pass

a. Llame a init para crear una sola instancia del activador de acceso de autenticación de Adobe Pass.

• Dependencia: Biblioteca iOS/tvOS nativa de autenticación de Adobe Pass (AccessEnabler)

b. Llame a setRequestor() para establecer la identidad del programador; pase requestorID del programador y (opcionalmente) una matriz de extremos de autenticación de Adobe Pass. Para tvOS también deberá proporcionar la clave pública y el secreto. Consulte Documentación sin cliente para obtener más información.

• Dependencia: ID de solicitante de autenticación de Adobe Pass válido (trabaje con su cuenta de autenticación de Adobe Pass)
  Responsable para organizar esto).

• Déclencheur:

  setRequestorComplete() llamada de retorno.

Tiene dos opciones de implementación: una vez que la información de identificación del solicitante se envía al servidor back-end, la capa de aplicación de la interfaz de usuario puede elegir uno de los dos enfoques siguientes:

1. Espere a que se active la llamada de retorno setRequestorComplete() (parte del delegado AccessEnabler). Esta opción proporciona la mayor certeza de que setRequestor() se completó, por lo que se recomienda para la mayoría de las implementaciones.

2. Continúe sin esperar a que se active la llamada de retorno setRequestorComplete() y comience a emitir solicitudes de asignación de derechos. Estas llamadas (checkAuthentication, checkAuthorization, getAuthentication, getAuthorization, checkPreauthorizedResource, getMetadata, logout) están en cola por la biblioteca AccessEnabler, que realizará las llamadas de red reales después de setRequestor(). Esta opción se puede interrumpir ocasionalmente si, por ejemplo, la conexión de red es inestable.

Llame a checkAuthentication() para comprobar si hay una autenticación existente sin iniciar el flujo de autenticación completo. Si esta llamada se realiza correctamente, puede continuar directamente al flujo de autorización. Si no es así, continúe con el flujo de autenticación.

• Dependencia: Una llamada correcta a setRequestor() (esta dependencia también se aplica a todas las llamadas subsiguientes).

• Déclencheur: setAuthenticationStatus() devolución de llamada.

Llame a getAuthentication() para iniciar el flujo de autenticación o para obtener confirmación de que el usuario ya está
autenticado.

Déclencheur:

• La llamada de retorno setAuthenticationStatus(), si el usuario ya está autenticado. En este caso, continúe directamente al Flujo de autorización.

• La llamada de retorno displayProviderDialog(), si el usuario aún no está autenticado.

Presentar al usuario la lista de proveedores enviados a
displayProviderDialog().

Una vez que el usuario seleccione un proveedor, obtenga la URL de la MVPD del usuario de la llamada de retorno navigateToUrl: o navigateToUrl:useSVC:, abra un controlador UIWebView/WKWebView o SFSafariViewController y dirija ese controlador a la URL.

A través de UIWebView/WKWebView o SFSafariViewController creados en el paso anterior, el usuario aterriza en la página de inicio de sesión de la MVPD e introduce credenciales de inicio de sesión. Se realizan varias operaciones de redirección en el controlador.

Una vez que el usuario ha iniciado sesión correctamente, la capa de aplicación detecta la carga de una dirección URL personalizada específica. Tenga en cuenta que esta dirección URL personalizada específica no es válida y no está pensada para que el controlador la cargue. Solo su aplicación debe interpretarlo como una señal de que el flujo de autenticación se ha completado y de que es seguro cerrar el controlador UIWebView/WKWebView o SFSafariViewController. En caso de que se requiera el uso de un controlador SFSafariViewController, la dirección URL personalizada específica está definida por application's custom scheme (p. ej.adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); de lo contrario, esta dirección URL personalizada específica está definida por la constante ADOBEPASS_REDIRECT_URL (es decir, adobepass://ios.app).

Cierre el controlador UIWebView/WKWebView o SFSafariViewController y llame al método de API handleExternalURL:url de AccessEnabler, que indica a AccessEnabler que recupere el token de autenticación del servidor back-end.

(Opcional) Llame a checkPreauthorizedResources(resources) para comprobar qué recursos puede ver el usuario. El parámetro resources es una matriz de recursos protegidos asociados al token de autenticación del usuario. Un uso de la información de autorización obtenida del MVPD del usuario es decorar su interfaz de usuario (por ejemplo, símbolos bloqueados/desbloqueados junto al contenido protegido).

• Déclencheur: preauthorizedResources() devolución de llamada
• Punto de ejecución: después del flujo de autenticación completado

Si la autenticación se ha realizado correctamente, continúe con el Flujo de autorización.

Llame a getAuthentication() para iniciar el flujo de autenticación o para obtener confirmación de que el usuario ya se ha autenticado.
Déclencheur:

• La llamada de retorno presentTvProviderDialog(), si el usuario no está autenticado y el solicitante actual tiene al menos en MVPD que admite SSO. Si ninguna MVPD admite SSO, se utilizará el flujo de autenticación clásico.

Una vez que el usuario selecciona un proveedor, la biblioteca AccessEnabler obtiene un token de autenticación con la información proporcionada por el marco de VSA de Apple.

Se desencadenará la devolución de llamada setAuthenticationsStatus(). En este punto, el usuario debe autenticarse con Apple SSO.

[Opcional] Llame a checkPreauthorizedResources(resources) para comprobar qué recursos puede ver el usuario. El parámetro resources es una matriz de recursos protegidos asociados al token de autenticación del usuario. Un uso de la información de autorización obtenida del MVPD del usuario es decorar su interfaz de usuario (por ejemplo, símbolos bloqueados / desbloqueados junto al contenido protegido).

• Déclencheur: preauthorizedResources() devolución de llamada
• Punto de ejecución: después del flujo de autenticación completado

Si la autenticación se ha realizado correctamente, continúe con el Flujo de autorización.

Llamar a getAuthentication() para iniciar
flujo de autenticación o para obtener confirmación de que el usuario ya está
autenticado.
Déclencheur:

• La llamada de retorno presentTvProviderDialog(), si el usuario no está autenticado y el solicitante actual tiene al menos una MVPD que admita SSO. Si ninguna MVPD admite SSO, se utilizará el flujo de autenticación clásico.

Una vez que el usuario seleccione un proveedor, se llamará a la devolución de llamada status(). Se proporcionará un código de registro y la biblioteca AccessEnabler comenzará a sondear el servidor para obtener una autenticación de segunda pantalla correcta.

Si el código de registro proporcionado se utilizó para autenticarse correctamente en la segunda pantalla, se activará la devolución de llamada setAuthenticatiosStatus(). En este punto, el usuario debe autenticarse con Apple SSO.

[Opcional] Llame a checkPreauthorizedResources(resources) para comprobar qué recursos puede ver el usuario. El parámetro resources es una matriz de recursos protegidos asociados al token de autenticación del usuario. Un uso de la información de autorización obtenida del MVPD del usuario es decorar su interfaz de usuario (por ejemplo, símbolos bloqueados / desbloqueados junto al contenido protegido).

• Déclencheur: preauthorizedResources() devolución de llamada

• Punto de ejecución: después del flujo de autenticación completado

Si la autenticación se ha realizado correctamente, continúe con el Flujo de autorización.

Llame a getAuthorization() para iniciar el flujo de autorización.

• Dependencia: ResourceID válidos acordados con los MVPD.
• Los ID de recurso deben ser los mismos que se usan en cualquier otro dispositivo o plataforma, y serán los mismos en todas las MVPD. Para obtener información sobre los identificadores de recursos, consulte Identificación de recursos protegidos

Valide la autenticación y la autorización.

• Si la llamada a getAuthorization() se realiza correctamente: El usuario tiene tokens AuthN y AuthZ válidos (el usuario está autenticado y autorizado para ver los medios solicitados).

• Si getAuthorization() falla: Examine la excepción lanzada para determinar su tipo (AuthN, AuthZ o algo más):

  • Si se ha producido un error de autenticación (AuthN), reinicie el flujo de autenticación.
  • Si se trata de un error de autorización (AuthZ), el usuario no tiene autorización para ver los medios solicitados y se le debe mostrar algún tipo de mensaje de error.
  • Si hubo algún otro tipo de error (error de conexión, error de red, etc.) a continuación, mostrar un mensaje de error apropiado al usuario.

Valide el token de medios corto.
Utilice la biblioteca del Comprobador de tokens de medios de autenticación de Adobe Pass para comprobar el token de medios de corta duración devuelto desde la llamada a getAuthorization() anterior:

• Si la validación se realiza correctamente: Reproduzca el medio solicitado para el usuario.
• Si la validación falla: El token de AuthZ no era válido, la solicitud de medios debe rechazarse y se debe mostrar un mensaje de error al usuario.

Vuelva al flujo normal de aplicaciones.

El usuario selecciona los medios que desea ver.

¿Están protegidos los medios? La aplicación comprueba si los medios seleccionados están protegidos:

• Si el medio seleccionado está protegido, su aplicación inicia el Flujo de autorización anterior.

• Si el medio seleccionado no está protegido, reproduzca el medio durante
  el usuario.

Llame a logout() para cerrar la sesión del usuario. AccessEnabler borra todos los valores y tokens almacenados en caché. Después de borrar la caché, AccessEnabler realiza una llamada al servidor para limpiar las sesiones del lado del servidor. Tenga en cuenta que, dado que la llamada al servidor podría provocar un redireccionamiento de SAML al IdP (esto permite la limpieza de la sesión en el lado del IdP), esta llamada debe seguir todas las redirecciones. Por este motivo, esta llamada debe gestionarse dentro de un controlador UIWebView/WKWebView o SFSafariViewController.

a. Siguiendo el mismo patrón que el flujo de trabajo de autenticación, el dominio AccessEnabler realiza una solicitud a la capa de aplicación de la interfaz de usuario, a través de la llamada de retorno navigateToUrl: o navigateToUrl:useSVC:, para crear un controlador UIWebView/WKWebView o SFSafariViewController e indicar a que cargue la dirección URL proporcionada en el parámetro url de la llamada de retorno. Dirección URL del extremo de cierre de sesión en el servidor back-end.

b. La aplicación debe supervisar la actividad del controlador UIWebView/WKWebView or SFSafariViewController y detectar el momento en que carga una dirección URL personalizada específica, a medida que pasa por varias redirecciones. Tenga en cuenta que esta dirección URL personalizada específica no es válida y no está pensada para que el controlador la cargue. Solo su aplicación debe interpretarlo como una señal de que el flujo de cierre de sesión se ha completado y de que es seguro cerrar el controlador UIWebView/WKWebView o SFSafariViewController. Cuando el controlador carga esta dirección URL personalizada específica, la aplicación debe cerrar el controlador UIWebView/WKWebView or SFSafariViewController y llamar al método de API handleExternalURL:urlde AccessEnabler. En caso de que se requiera el uso de un controlador SFSafariViewController, la dirección URL personalizada específica está definida por application's custom scheme (por ejemplo, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); de lo contrario, esta dirección URL personalizada específica está definida por la constante ADOBEPASS_REDIRECT_URL (es decir, adobepass://ios.app).