DocumentationAdobe PassAuthentification Adobe Pass

Métadonnées utilisateur (héritées) user-metadata

Last update: Wed Jan 29 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence Adobe. Aucune utilisation non autorisée n’est autorisée.
IMPORTANT
Veillez à rester informé des dernières annonces de produits Authentification Adobe Pass et des délais de désactivation agrégés dans la page Annonces de produits.
NOTE
L’implémentation de l’API REST est limitée par mécanisme de limitation

Points d’entrée de l’API REST clientless-endpoints

<REGGIE_FQDN> :

<SP_FQDN> :

Description description

Récupérez les métadonnées que MVPD a partagées à propos de l’utilisateur authentifié.

Point d’entrée
Appelé
Par
Entrée
Params
HTTP
Méthode
Réponse
HTTP
Réponse
<SP_FQDN>/api/v1/tokens/usermetadata
Service de programmation

ou

d’application en flux continu
1. demandeur
2. deviceId (obligatoire)
3. device_info/X-Device-Info (obligatoire)
4. deviceType
5. deviceUser (obsolète)
6. appId (obsolète)
GET
XML ou JSON contenant des métadonnées utilisateur ou des détails d’erreur en cas d’échec.

200 - Succès

404 - Aucune métadonnée trouvée

412 - Jeton AuthN non valide (par exemple, jeton expiré)

Paramètre d’entrée
Description
demandeur
ID de demandeur du programmeur pour lequel cette opération est valide.
deviceId
Octets d’ID de l’appareil.

device_info/

X-Device-Info

Informations sur l’appareil de diffusion en continu.

Remarque : Ceci PEUT être transmis à device_info en tant que paramètre d’URL, mais en raison de la taille potentielle de ce paramètre et des limitations sur la longueur d’une URL de GET, il DOIT être transmis en tant que X-Device-Info dans l’en-tête http.

Voir les détails complets dans Transmettre les informations sur l’appareil et la connexion.
deviceType
Type d’appareil (par exemple Roku, PC).

Si ce paramètre est défini correctement, ESM propose des mesures ventilées par type d’appareil lors de l’utilisation de Clientless, de sorte que différents types d’analyse puissent être effectués pour Roku, AppleTV, Xbox, etc.

Voir Avantages de l’utilisation du paramètre de type d’appareil sans client dans les mesures Pass

Remarque : l’device_info remplace ce paramètre.
deviceUser
Identifiant utilisateur de l’appareil.

Remarque : s’il est utilisé, deviceUser doit avoir les mêmes valeurs que dans la requête Créer un code d’enregistrement.
appId
Nom/ID de l’application.

Remarque : l’device_info remplace ce paramètre. S’il est utilisé, appId doit avoir les mêmes valeurs que dans la requête Créer un code d’enregistrement.
NOTE
Les informations de métadonnées utilisateur doivent être disponibles une fois le flux d’authentification terminé. Toutefois, elles peuvent être mises à jour dans le flux d’autorisation, selon le MVPD et le type de métadonnées.

Exemple de réponse sample-response

Après un appel réussi, le serveur répond avec un objet XML (par défaut) ou JSON avec une structure similaire à celle présentée ci-dessous :

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

À la racine de l’objet se trouvent trois nœuds :

  • updated : spécifie un horodatage UNIX qui représente la dernière fois que les métadonnées ont été mises à jour. Cette propriété est définie initialement par le serveur lors de la génération des métadonnées pendant la phase d’authentification. Les appels suivants (après la mise à jour des métadonnées) entraînent une incrémentation de l’horodatage.
  • data : contient les valeurs réelles des métadonnées.
  • encrypted : tableau répertoriant les propriétés chiffrées. Pour déchiffrer une valeur de métadonnées spécifique, le programmeur doit effectuer un décodage Base64 sur les métadonnées, puis effectuer un déchiffrement RSA sur la valeur obtenue, à l’aide de sa propre clé privée (l’Adobe chiffre les métadonnées sur le serveur à l’aide du certificat public du programmeur).

En cas d’erreur, le serveur renvoie un objet XML ou JSON spécifiant un message d’erreur détaillé.

Pour plus d’informations, voir Métadonnées utilisateur.

Retour à la référence de l’API REST

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