Documentación Adobe Pass Adobe Pass Authentication

Preautorizar js-preauthorize

Last update: Mon Oct 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Autenticación

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.

Información general preauth-overview

Las aplicaciones deben utilizar el método de API de preautorización para obtener decisiones de preautorización para uno o más recursos. La solicitud de API de preautorización debe utilizarse para sugerencias de interfaz de usuario o filtrado de contenido. Se debe realizar una solicitud de API de autorización real antes de permitir que el usuario tenga acceso a los recursos especificados.

En caso de que se produzca un error inesperado (por ejemplo, un problema de red y un punto final de autorización de MVPD no disponible) cuando los servicios de autenticación de Adobe Pass procesen una solicitud de API preautorizada, se incluirá una o varias informaciones de error independientes para los recursos afectados como parte del resultado de la respuesta de API preautorizada.

public preauthorize(solicitud: PreauthorizeRequest, devolución de llamada: AccessEnablerCallback<any>): void preauth-method

Descripción: este método lo deben usar las aplicaciones para obtener las decisiones de autorización previa (informativas) del usuario autenticado del servicio de autenticación de Adobe Pass para ver recursos protegidos específicos, con el propósito principal de decorar la interfaz de usuario de la aplicación (por ejemplo, indicar el estado de acceso con iconos de bloqueo y desbloqueo).

Disponibilidad: v4.4.0+

Parámetros:

PreauthorizeRequest: objeto de generador utilizado para definir la solicitud
AccessEnablerCallback: la llamada de retorno se utilizó para devolver la respuesta de API
PreauthorizeResponse: objeto utilizado para devolver el contenido de respuesta de API

class PreauthorizeRequestBuilder preath-req-builder-class

setResources(resources: string[]): PreauthorizeRequestBuilder set-res-preath-req-buildr

Establece la lista de recursos para los que desea obtener decisiones de preautorización.
Es obligatorio establecerlo para el uso de la API preautorizada.
Cada elemento de la lista debe ser una cadena que represente el valor del ID de recurso o el fragmento RSS de medios que debe acordarse con MVPD.
Este método establece la información solamente en el contexto de la instancia de objeto PreauthorizeRequestBuilder actual, que es el receptor de esta llamada al método.
Para generar un(a) PreauthorizeRequest real(a), puede echar un vistazo al método de PreauthorizeRequestBuilder:

  build(): PreauthorizeRequest

@param {string[]} recursos. La lista de recursos para los que desea obtener decisiones de preautorización.
@returns {PreauthorizeRequestBuilder} La referencia a la misma instancia de objeto PreauthorizeRequestBuilder, que es el receptor de la llamada al método.
Esto se hace para permitir la creación del encadenamiento de métodos.

disableFeatures(…features: string[]): PreauthorizeRequestBuilder disabl-featres-preauth-req-buildr

Establece las funciones que desea que se deshabiliten al obtener decisiones de preautorización.
Esta función establece la información solamente en el contexto de la instancia de objeto PreauthorizeRequestBuilder actual, que es el receptor de esta llamada de función.
Para generar un(a) PreauthorizeRequest real(a), puede echar un vistazo a la función de PreauthorizeRequestBuilder:

public func build() -> PreauthorizeRequest

@param {string[]} características. El conjunto de funciones que desea que se deshabiliten.
@returns La referencia a la misma instancia de objeto PreauthorizeRequestBuilder, que es el receptor de la llamada de función.
Lo hace para permitir la creación de cadenas de funciones.

build(): PreauthorizeRequest preauth-req

Crea y recupera la referencia de una nueva instancia de objeto PreauthorizeRequest.
Este método crea una instancia de un nuevo objeto PreauthorizeRequest cada vez que se realiza la llamada.
Este método utiliza los valores establecidos de antemano en el contexto de la instancia de objeto PreauthorizeRequestBuilder actual, que es el receptor de esta llamada al método.
Tenga en cuenta que este método no produce ningún efecto secundario,
por lo tanto, no altera el estado del SDK ni el estado de la instancia del objeto PreauthorizeRequestBuilder, que es el receptor de esta llamada de método.
Significa que las llamadas sucesivas de este método para el mismo receptor crearán diferentes instancias de objeto PreauthorizeRequest nuevas, pero con la misma información, en caso de que los valores establecidos en PreauthorizeRequestBuilder no se hayan modificado entre las llamadas.
Si no necesita actualizar ninguna de la información proporcionada (recursos y almacenamiento en caché), puede reutilizar la instancia PreauthorizeRequest para varios usos de la API preautorizada.
@returns {PreauthorizeRequest}

interface AccessEnablerCallback<T> interface-access-enablr-callback

onResponse(resultado: T); on-response-result

Llamada de retorno de respuesta invocada por el SDK cuando se completó la solicitud de API preautorizada.
El resultado es un resultado correcto o un resultado de error que contiene un estado.
@param {T} result

onFailure(resultado: T); on-failure-result

Llamada de retorno de error invocada por el SDK cuando no se pudo atender la solicitud de API preautorizada.
El resultado es un resultado de error que contiene un estado.
@param {T} result

class PreauthorizeResponse preauth-response-class

estado público: estado; public-status

Devuelve: información adicional de estado (estado) en caso de error.
Puede contener un valor null.

decisiones públicas: Decisión[]; public-decisions

Devuelve: la lista de decisiones de preautorización. Una decisión para cada recurso.
La lista puede estar vacía en caso de error.

Estado de clase class-status

estatus público: número; public-status-numbr

El código de estado de respuesta HTTP tal como se documenta en RFC 7231.
Podría ser 0 si Status procede del SDK en lugar de los servicios de autenticación de Adobe Pass.

código público: número; public-code-numbr

El código de error estándar de los servicios de autenticación de Adobe Pass.
Puede contener una cadena vacía o un valor null.

public message: string; public-msg-string

El mensaje detallado que, en algunos casos, proporcionan los puntos finales de autorización de MVPD o las reglas de degradación del Programador.
Puede contener una cadena vacía o un valor null.

public details: string; public-details-strng

Contiene un mensaje detallado que, en algunos casos, lo proporcionan los puntos finales de autorización de MVPD o las reglas de degradación del programador.
Puede contener una cadena vacía o un valor null.

public helpUrl: string; public-help-url-string

La dirección URL que vincula a más información sobre por qué se produjo este estado/error y posibles soluciones.
Puede contener una cadena vacía o un valor null.

public trace: string; public-trace-string

El identificador único de esta respuesta, que se puede utilizar al ponerse en contacto con el servicio de asistencia para identificar problemas específicos en situaciones más complejas.
Puede contener una cadena vacía o un valor null.

public action: string; public-action-string

La acción recomendada para remediar la situación.
- ninguno: Lamentablemente no hay ninguna acción predefinida para remediar este problema. Esto podría indicar una invocación incorrecta de la API pública
- configuración: se necesita un cambio de configuración a través del panel de TVE o poniéndose en contacto con el soporte técnico.
- application-registration: la aplicación debe registrarse de nuevo.
- autenticación: el usuario debe autenticarse o volver a autenticarse.
- authorization: el usuario debe obtener autorización para el recurso específico.
- degradación: se debe aplicar alguna forma de degradación.
- reintentar: si se reintenta la solicitud, el problema podría resolverse
- reintentar-después: si se reintenta la solicitud después del período de tiempo indicado, el problema podría resolverse.
Puede contener una cadena vacía o un valor null.

decisión colectiva class-decision

id pública: string; public-id-string

El ID de recurso para el que se obtuvo la decisión.

public authorized: boolean; public-auth-boolean

El valor del indicador que indica si la decisión se ha realizado correctamente o no.

error público: Estado; public-error-status

Información adicional de estado (estado) en caso de que se haya producido algún error. Puede contener un valor null.

Ejemplo de implementación de cliente client-imp-example

let accessEnablerApi = new window.AccessEnabler.AccessEnabler("software statement");
let accessEnablerModels = window.AccessEnabler.models;



// Build request
let requestBuilder = new accessEnablerModels.PreauthorizeRequest.getBuilder();
let request = requestBuilder
    .setResources(["RES01", "RES02", "RES03"])
    .disableFeatures("LOCAL_CACHE")
    .build();



// Create callback
let callback = {
    onResponse(response) {
        // Handle onResponse
    },
    onFailure(response) {
        // Handle onFailure
    }
};

// Invoke call
accessEnablerApi.preauthorize(request, callback);

Ejemplos de escenarios scenario-examples

Escenario 1: se autorizaron todos los recursos solicitados all-req-res-auth

Escenario 2: se autorizaron algunos recursos solicitados. sm-req-res-auth

Indicador de código de error mejorado

Respuesta

Desactivado

code language-javascript
`{ "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": true }, { "id": "RES03", "authorized": true } ] }`

Escenario 3: no se autorizó ninguno de los recursos solicitados. none-req-res-auth

Indicador de código de error mejorado

Respuesta

Desactivado

code language-none
`"JavaScript { "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": false }, { "id": "RES03", "authorized": true } ] "`

Habilitado

code language-none

code language-none
"JavaScript { "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": false, "error": { "status": 403, "code": "preauthorization_denied_by_mvpd", "message": "The MVPD has devolvió una decisión \"Denegar\" al solicitar la preautorización para el recurso especificado.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "none" } , { "id": "RES03", "authorized": true }, ] } "

&quot;JavaScript
&lbrace;
&quot;decisions&quot;: &lbrack;
&lbrace;
&quot;id&quot;: &quot;RES01&quot;,
&quot;authorized&quot;: true
&rbrace;,
&lbrace;
&quot;id&quot;: &quot;RES02&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;preauthorization_denied_by_mvpd&quot;,
&quot;message&quot;: &quot;The MVPD has devolvió una decisión \&quot;Denegar\&quot; al solicitar la preautorización para el recurso especificado.&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;none&quot;
&rbrace;
,
&lbrace;
&quot;id&quot;: &quot;RES03&quot;,
&quot;authorized&quot;: true
&rbrace;,
&rbrack;
&rbrace;

&quot;

Escenario 4: solicitud de cliente incorrecta; no se especificaron recursos. bad-cl-req-no-res-sp

Indicador de código de error mejorado

Respuesta

Desactivado

code language-none
`"JavaScript { "decisions": [ { "id": "RES01", "authorized": false }, { "id": "RES02", "authorized": false }, { "id": "RES03", "authorized": false } ] "`

Habilitado

code language-none

code language-none
"JavaScript { "decisions": [ { "id": "RES01", "authorized": false, "error": { "status": 403, "code": "preauthorization_denied_by_mvpd", "message": "La MVPD ha devuelto una decisión \"Deny\" al solicitar la preautorización para el recurso especificado.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html",{11 1}"action": "none" } , { "id": "RES02", "authorized": false, "error": { "status": 403, "code": "preauthorization_denied_by_mvpd", "message": "La MVPD ha devuelto una decisión \"Deny\" al solicitar la preautorización del recurso especificado." "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "none" } , { "id": "RES03", "authorized": false, "error": { "status": 403, "code": "maximum_execution_time_expanded", "message": "La solicitud no se completó en el tiempo máximo permitido. Si se reintenta la solicitud, podría resolverse el problema.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "retry" } ] "

&quot;JavaScript

&lbrace;
&quot;decisions&quot;: &lbrack;
&lbrace;
&quot;id&quot;: &quot;RES01&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;preauthorization_denied_by_mvpd&quot;,
&quot;message&quot;: &quot;La MVPD ha devuelto una decisión \&quot;Deny\&quot; al solicitar la preautorización para el recurso especificado.&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,{11 1}&quot;action&quot;: &quot;none&quot;
&rbrace;
,
&lbrace;
&quot;id&quot;: &quot;RES02&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;preauthorization_denied_by_mvpd&quot;,
&quot;message&quot;: &quot;La MVPD ha devuelto una decisión \&quot;Deny\&quot; al solicitar la preautorización del recurso especificado.&quot;
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;none&quot;
&rbrace;
,
&lbrace;
&quot;id&quot;: &quot;RES03&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;maximum_execution_time_expanded&quot;,
&quot;message&quot;: &quot;La solicitud no se completó en el tiempo máximo permitido.
 Si se reintenta la solicitud, podría resolverse el problema.&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;retry&quot;
&rbrace;

&rbrack;


&quot;

Indicador de código de error mejorado

Respuesta

Desactivado/Habilitado

code language-none

code language-none
"JavaScript { "status": { "status": 400, "code": "internal_error", "message": "La solicitud falló debido a un error interno.", "details": "El parámetro de cadena obligatorio[] 'resource' no está presente", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "none" , "decisions": [] } "

&quot;JavaScript
&lbrace;
&quot;status&quot;: &lbrace;
&quot;status&quot;: 400,
&quot;code&quot;: &quot;internal_error&quot;,
&quot;message&quot;: &quot;La solicitud falló debido a un error interno.&quot;,
&quot;details&quot;: &quot;El parámetro de cadena obligatorio[] &#39;resource&#39; no está presente&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;none&quot;
,
&quot;decisions&quot;: []
&rbrace;
&quot;

Escenario 5: solicitud de cliente incorrecta; recursos vacíos especificados. bad-cl-req-empt-res-sp

Indicador de código de error mejorado

Respuesta

Desactivado/Habilitado

code language-none

code language-none
`"JavaScript { "status": { "status": 412, "code": "missing_resource", "message": "Falta el parámetro del recurso", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "none" }, "decisions": [] "`

&quot;JavaScript
&lbrace;
&quot;status&quot;: &lbrace;
&quot;status&quot;: 412,
&quot;code&quot;: &quot;missing_resource&quot;,
&quot;message&quot;: &quot;Falta el parámetro del recurso&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;none&quot;
&rbrace;,
&quot;decisions&quot;: []

&quot;

Escenario 6: error de red. ntwrk-error

Indicador de código de error mejorado

Respuesta

Habilitado

code language-none

code language-none
"JavaScript { "decisions": [ { "id": "RES01", "authorized": false, "error": { "status": 403, "code": "network_received_error", "message": "Error de lectura al recuperar la respuesta del servicio de socio asociado. Si se vuelve a intentar la solicitud, se podría resolver el problema.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "retry" , { "id": "RES02", "authorized": false, "error": { "status": 403, "code": "network_received_error", "message": "Se produjo un error de lectura al recuperar la respuesta del servicio asociado. Si se reintenta la solicitud, podría resolverse el problema.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "action": "retry" } ] "

&quot;JavaScript
&lbrace;
&quot;decisions&quot;: &lbrack;
&lbrace;
&quot;id&quot;: &quot;RES01&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;network_received_error&quot;,
&quot;message&quot;: &quot;Error de lectura al recuperar la respuesta del servicio de socio asociado. Si se vuelve a intentar la solicitud, se podría resolver el problema.&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;retry&quot;

,
&lbrace;
&quot;id&quot;: &quot;RES02&quot;,
&quot;authorized&quot;: false,
&quot;error&quot;: &lbrace;
&quot;status&quot;: 403,
&quot;code&quot;: &quot;network_received_error&quot;,
&quot;message&quot;: &quot;Se produjo un error de lectura al recuperar la respuesta del servicio asociado. Si se reintenta la solicitud, podría resolverse el problema.&quot;,
&quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&quot;action&quot;: &quot;retry&quot;
&rbrace;

&rbrack;

&quot;

Escenario 7: se invocó un flujo de preautorización sin una sesión de AuthN válida.

Indicador de código de error mejorado

Respuesta

Desactivado/Habilitado

code language-none

code language-none
`"JavaScript { "status": { "status": 0, "code": "authentication_session_missing", "message": "No se pudo recuperar la sesión de autenticación asociada con esta solicitud. El usuario debe volver a autenticarse con una MVPD compatible para continuar.", "acción": "autenticación" , "decisiones": [] } "`

&quot;JavaScript
&lbrace;
&quot;status&quot;: &lbrace;
&quot;status&quot;: 0,
&quot;code&quot;: &quot;authentication_session_missing&quot;,
&quot;message&quot;: &quot;No se pudo recuperar la sesión de autenticación asociada con esta solicitud. El usuario debe volver a autenticarse con una MVPD compatible para continuar.&quot;,
&quot;acción&quot;: &quot;autenticación&quot;
,
&quot;decisiones&quot;: []
&rbrace;

&quot;

Escenario 8: se invocó el flujo de preautorización antes de completar la llamada a setRequestor

Indicador de código de error mejorado

Respuesta

Desactivado/Habilitado

code language-none

code language-none
`"JavaScript { "status": { "status": 0, "code": "requestor_not_configured", "message": "El solicitante aún no está configurado, lo que es un requisito previo para utilizar cualquier API aparte de la API setRequestor.", "action": "retry" , "decisions": [] } "`

&quot;JavaScript
&lbrace;
&quot;status&quot;: &lbrace;
&quot;status&quot;: 0,
&quot;code&quot;: &quot;requestor_not_configured&quot;,
&quot;message&quot;: &quot;El solicitante aún no está configurado, lo que es un requisito previo para utilizar cualquier API aparte de la API setRequestor.&quot;,
&quot;action&quot;: &quot;retry&quot;
,
&quot;decisions&quot;: []
&rbrace;
&quot;

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b