DocumentaciónAdobe PassAdobe Pass Authentication

Metadatos del usuario user-metadata

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.
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

Recuperar metadatos que MVPD compartió sobre el usuario autenticado.

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

o

de aplicación de streaming
1. solicitante
2. deviceId (obligatorio)
3. device_info/X-Device-Info (obligatorio)
4. deviceType
5. deviceUser (Obsoleto)
6. appId (obsoleto)
GET
XML o JSON que contienen metadatos de usuario o detalles del error si no se ha realizado correctamente.

200 - Éxito

404 - No se han encontrado metadatos

412 - Token de AuthN no válido (por ejemplo, token caducado)

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.

device_info/

X-Device-Info

Información del dispositivo de transmisión.

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.

Ver Ventajas de usar el parámetro de tipo de dispositivo sin cliente en Pasar métricas

Nota: device_info reemplaza este parámetro.
deviceUser
Identificador de usuario del dispositivo.

Nota: Si se usa, deviceUser debería tener los mismos valores que en la solicitud Crear código de registro.
appId
El nombre o ID de la aplicación.

Nota: device_info reemplaza este parámetro. Si se usa, appId debería tener los mismos valores que en la solicitud Crear código de registro.
NOTE
La información de metadatos del usuario debe estar disponible una vez completado el flujo de autenticación, pero puede actualizarse en el flujo de autorización, según la MVPD y el tipo de metadatos.

Respuesta de ejemplo sample-response

Después de una llamada correcta, el servidor responderá con un objeto XML (predeterminado) o JSON con una estructura similar a la presentada a continuación:

    {
        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"]
              }
    }

En la raíz del objeto habrá tres nodos:

  • updated: especifica una marca de tiempo UNIX que representa la última vez que se actualizaron los metadatos. El servidor establecerá esta propiedad inicialmente al generar los metadatos durante la fase de autenticación. Las llamadas posteriores (después de actualizar los metadatos) producirán un incremento en la marca de tiempo.
  • data: contiene los valores de metadatos reales.
  • cifrado: una matriz con las propiedades cifradas. Para descifrar un valor de metadatos específico, el programador debe realizar una descodificación Base64 de los metadatos y, a continuación, aplicar una descodificación RSA en el valor resultante, utilizando su propia clave privada (el Adobe cifra los metadatos en el servidor utilizando el certificado público del programador).

En caso de error, el servidor devolverá un objeto XML o JSON que especifica un mensaje de error detallado.

Para obtener más información, consulte Metadatos de usuario.

Volver a la referencia de la API de REST

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