DocumentaciónAdobe PassAdobe Pass Authentication

Iniciar autorización initiate-authorization

Last update: Thu Jul 18 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.
NOTE
La implementación de la API de REST está limitada por Mecanismo de limitación

Extremos de API de REST clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Descripción description

Obtiene una respuesta de autorización.

Extremo
Llamado
por
Entrada
Parámetros
Método HTTP
Respuesta
Respuesta HTTP
<SP_FQDN>/api/v1/authorize
Servicio de programador

o

de aplicación de streaming
1. solicitante (obligatorio)
2. deviceId (obligatorio)
3. recurso (obligatorio)
4. device_info/X-Device-Info (obligatorio)
5. deviceType
6. deviceUser (obsoleto)
7. appId (obsoleto)
8. parámetros adicionales (opcional)
GET
XML o JSON que contienen detalles de autorización o detalles de error si no se ha realizado correctamente. Consulte los ejemplos siguientes.
200 - Correcto
403 - Sin éxito
Parámetro de entrada
Descripción
solicitante
Identificador de solicitante del programador para el que es válida esta operación.
deviceId
El ID de dispositivo bytes.
resource
Cadena que contiene un resourceId (o fragmento MRSS), identifica el contenido solicitado por un usuario y es reconocida por los extremos de autorización de MVPD.
device_info/

X-Device-Info
Información del dispositivo de streaming.

Nota: Esto PUEDE pasarse a device_info como parámetro de URL, pero debido al tamaño potencial de este parámetro y a las limitaciones en la longitud de una URL de GET, DEBE pasarse como X-Device-Info en el encabezado http.

Ver los detalles completos en Pasar información de conexión y dispositivo.
deviceType
El tipo de dispositivo (por ejemplo, Roku, PC).

Si este parámetro está configurado correctamente, ESM ofrece métricas que están desglosadas por tipo de dispositivo al utilizar sin cliente, de modo que se puedan realizar diferentes tipos de análisis, por ejemplo, para Roku, AppleTV, Xbox, etc.

Vea Ventajas del parámetro de tipo de dispositivo sin cliente en las métricas de pase

Nota: device_info reemplazará este parámetro.
deviceUser
El identificador de usuario del dispositivo.
appId
El nombre o ID de la aplicación.

Nota: device_info reemplaza este parámetro.
parámetros adicionales
La llamada también puede contener parámetros opcionales que habilitan otras funcionalidades como:

* generic_data - habilita el uso de Promotional TempPass

Ejemplo: generic_data=("email":"email@domain.com")
CAUTION
Dirección IP del dispositivo de transmisión

En implementaciones de cliente a servidor, la dirección IP del dispositivo de streaming se envía implícitamente con esta llamada. En implementaciones de servidor a servidor, donde el servicio Programador realiza la llamada regcode y no el dispositivo de transmisión, se requiere el siguiente encabezado para pasar la dirección IP del dispositivo de transmisión:
code language-none 
X-Forwarded-For : <streaming\_device\_ip>
donde <streaming\_device\_ip> es la dirección IP pública del dispositivo de transmisión.


Ejemplo :
code language-none 
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

Respuesta de ejemplo sample-response

  • Caso 1: Correcto

    • XML:

    "XML
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <authorization>
    <expires>1348148289000</expires>
    <mvpd>sampleMvpdId</mvpd>
    <requestor>sampleRequestorId</requestor>
    <resource>sampleResourceId</resource>
    </authorization>
    "

  • JSON:

    code language-json 
    {
  "mvpd": "sampleMvpdId",
  "resource": "sampleResourceId",
  "requestor": "sampleRequestorId",
  "expires": "1348148289000"
}
IMPORTANT
Cuando la respuesta proviene de una MVPD proxy, puede incluir un elemento adicional denominado proxyMvpd.

  • Caso 2: autorización denegada

    code language-json 
    <error>
  <status>403</status>
  <message>User not authorized</message>
  <details>Your subscription package does not include the "ASFAFD" channel.
  Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details>
</error>
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b