DocumentaciónAdobe PassAdobe Pass Authentication

Recuperar decisiones de preautorización utilizando mvpd específico retrieve-preauthorization-decisions-using-specific-mvpd

Last update: Tue Oct 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
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.
IMPORTANT
La implementación de la API REST V2 está limitada por la documentación de Mecanismo de limitación.

Solicitud request

HTTP
ruta
/api/v2/{serviceProvider}/decisions/preauthorize/{mvpd}
método
POST
Parámetros de ruta
serviceProvider
El identificador único interno asociado con el proveedor de servicios durante el proceso de incorporación.
obligatorio
mvpd
El identificador único interno asociado con el proveedor de identidad durante el proceso de incorporación.
obligatorio
Parámetros de cuerpo
recursos
La lista de recursos que requieren una decisión de MVPD para poder mostrarse.
obligatorio
Encabezados
Autorización
La generación de la carga útil del token de portador se describe en la documentación del encabezado Autorización.
obligatorio
Content-Type
El tipo de medio aceptado para los recursos que se envían.

Debe ser application/json.
obligatorio
AP-Device-Identifier
La generación de la carga del identificador de dispositivo se describe en la documentación del encabezado AP-Device-Identifier.
obligatorio
X-Device-Info
La generación de la carga de información del dispositivo se describe en la documentación del encabezado X-Device-Info.

Se recomienda utilizarlo siempre que la plataforma de dispositivos de la aplicación permita la provisión explícita de valores válidos.

Cuando se proporciona, el backend de autenticación de Adobe Pass combina explícitamente los valores establecidos con los valores extraídos implícitamente (de forma predeterminada).

Cuando no se proporciona, el backend de autenticación de Adobe Pass utilizará valores extraídos implícitamente (de forma predeterminada).
obligatorio
X-Forwarded-For
La dirección IP del dispositivo de flujo continuo.

Se recomienda utilizarlo siempre para implementaciones de servidor a servidor, especialmente cuando la llamada la realice el servicio del programador en lugar del dispositivo de flujo continuo.

Para implementaciones de cliente a servidor, la dirección IP del dispositivo de flujo continuo se envía implícitamente.
opcional
Adobe-Subject-Token
La generación de la carga de inicio de sesión único para el método de identidad de Platform se describe en la documentación del encabezado Adobe-Subject-Token.

Para obtener más información sobre los flujos habilitados para el inicio de sesión único que utilizan una identidad de plataforma, consulte la documentación de Inicio de sesión único mediante flujos de identidad de plataforma.
opcional
AD-Service-Token
La generación de la carga de inicio de sesión único para el método del token de servicio se describe en la documentación del encabezado AD-Service-Token.

Para obtener más información sobre los flujos habilitados para el inicio de sesión único que utilizan un token de servicio, consulte la documentación de Inicio de sesión único mediante flujos de token de servicio.
opcional
AP-Partner-Framework-Status
La generación de la carga de inicio de sesión único para el método Partner se describe en la documentación del encabezado AP-Partner-Framework-Status.

Para obtener más información sobre los flujos habilitados para el inicio de sesión único que usan un socio, consulte la documentación de Inicio de sesión único con flujos de socios.
opcional
Aceptar
El tipo de medio aceptado por la aplicación cliente.

Si se especifica, debe ser application/json.
opcional
User-Agent
El agente de usuario de la aplicación cliente.
opcional

Respuesta response

Código
Texto
Descripción
200
OK
El cuerpo de respuesta contiene una lista de decisiones con información adicional.
400
Solicitud incorrecta
La solicitud no es válida, el cliente debe corregirla e intentarlo de nuevo. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.
401
No autorizado
El token de acceso no es válido, el cliente debe obtener un nuevo token de acceso e intentarlo de nuevo. Para obtener más información, consulte la Información general sobre el registro de clientes dinámicos.
405
Método no permitido
El método HTTP no es válido, el cliente debe utilizar un método HTTP permitido para el recurso solicitado e intentarlo de nuevo. Para obtener más información, consulte la sección Solicitud.
500
Error interno del servidor
El lado del servidor ha encontrado un problema. El cuerpo de respuesta puede contener información de error que se adhiera a la documentación de Códigos de error mejorados.

Correcto success

Encabezados
Estado
200
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
decisiones

JSON que contiene una lista de elementos, cada uno con los siguientes atributos:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff 25-bgcolor-deebff layout-auto html-authored
Atributo
resource El identificador de recurso para el que se devuelve la decisión de preautorización. obligatorio
serviceProvider El identificador único interno asociado con el proveedor de servicios durante el proceso de incorporación. obligatorio
mvpd El identificador único interno asociado con el proveedor de identidad durante el proceso de incorporación. obligatorio
authorized El estado de decisión del recurso, que puede ser "true" o "false". obligatorio
origen

Información sobre la fuente de decisión:

Los valores posibles son:

  • mvpd
    La decisión la emite el extremo de preautorización de MVPD.
  • degradación
    La decisión se emite como resultado del acceso degradado.
  • La decisión temppass
    se ha emitido como resultado del acceso temporal.
  • Dummy
    La decisión se emite como resultado de la función de preautorización de Dummy.
 obligatorio
error El error proporciona información adicional sobre la decisión "Denegar" que se adhiere a la documentación de Códigos de error mejorados. opcional
obligatorio

Error error

Encabezados
Estado
400, 401, 405, 500
obligatorio
Content-Type
application/json
obligatorio
Cuerpo
El cuerpo de respuesta puede proporcionar información de error adicional que se adhiera a la documentación de Códigos de error mejorados.
obligatorio

Muestras samples

1. Recupere las decisiones de preautorización utilizando mvpd específico

Solicitud
code language-https 
POST /api/v2/REF30/decisions/preauthorize/Cablevision HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["resource1", "resource2", "resource3"]
}
Respuesta
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
   "decisions": [
      {
         "resource": "resource1 ",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource2",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource3",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": false,
         "error": {
            "status": 403,
            "code": "preauthorization_denied_by_mvpd",
            "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
            "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=es",
            "action": "none"
         }
      }
   ]
}

2. Recuperar decisiones de preautorización utilizando mvpd específico mientras se aplica la degradación

Solicitud
code language-https 
POST /api/v2/REF30/decisions/preauthorize/${degradedMvpd} HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["REF30", "apasstest1"]
}
Respuesta - Degradación de AuthNAll
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Respuesta: degradación de AuthZAll
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Respuesta: degradación de AuthZNone
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=es",
                "action": "none"
            }
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=es",
                "action": "none"
            }
        }
    ]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b