Récupérer une session d’authentification à l’aide du code retrieve-authentication-session-using-code

IMPORTANT
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence Adobe actuelle. Aucune utilisation non autorisée n’est autorisée.
IMPORTANT
L’implémentation de l’API REST V2 est limitée par la documentation Mécanisme de limitation.

Requête request

HTTP
chemin
/api/v2/{serviceProvider}/sessions/{code}
méthode
GET
Paramètres de chemin
serviceProvider
Identifiant unique interne associé au fournisseur de services lors du processus d’intégration.
obligatoire
code
Code d’authentification obtenu après la création de la session d’authentification sur l’appareil de diffusion en continu.
obligatoire
En-têtes
Autorisation
La génération de la payload du jeton porteur est décrite dans la documentation d’en-tête Authorization.
obligatoire
X-Forwarded-For
Adresse IP de l’appareil de diffusion en continu.

Il est vivement recommandé de toujours l’utiliser pour les implémentations serveur à serveur, en particulier lorsque l’appel est effectué par le service de programmation plutôt que par l’appareil de diffusion en continu.

Pour les implémentations client à serveur, l’adresse IP de l’appareil de diffusion en continu est envoyée implicitement.
facultatif
AP-Visitor-Identifier
La génération de la payload de l’identifiant visiteur est décrite dans la documentation d’en-tête AP-Visitor-Identifier.
facultatif
Accepter
Type de média accepté par l’application cliente.

S’il est spécifié, il doit s’agir d’application/json.
facultatif
User-Agent
Agent utilisateur de l’application cliente.
facultatif

Réponse response

Code
Texte
Description
200
OK
Le corps de la réponse contient des informations sur la session d’authentification.
400
Requête incorrecte
La requête n’est pas valide, le client doit la corriger et réessayer. Le corps de la réponse peut contenir des informations d’erreur conformes à la documentation Codes d’erreur améliorés.
401
Non Autorisé
Le jeton d’accès n’est pas valide, le client doit obtenir un nouveau jeton d’accès et réessayer. Pour plus d’informations, consultez la documentation Présentation de l’enregistrement client dynamique.
405
Méthode Non Autorisée
La méthode HTTP n’est pas valide, le client doit utiliser une méthode HTTP autorisée pour la ressource demandée et réessayer. Pour plus d’informations, consultez la section Requête.
500
Erreur de serveur interne
Un problème est survenu côté serveur. Le corps de la réponse peut contenir des informations d’erreur conformes à la documentation Codes d’erreur améliorés.

Succès success

En-têtes
Etat
200
obligatoire
Corps
paramètres

Objet JSON possédant les attributs suivants :

  • existing
    Paramètres existants déjà fournis.
  • missing
    Les paramètres manquants qui doivent être fournis pour terminer le flux d’authentification.
obligatoire

Erreur error

En-têtes
Etat
400, 401, 405, 500
obligatoire
Content-Type
application/json
obligatoire
Corps

Le corps de la réponse peut fournir des informations d’erreur supplémentaires conformes à la documentation Codes d’erreur améliorés.

L’application cliente doit mettre en œuvre un mécanisme de gestion des erreurs capable de traiter correctement les codes d’erreur les plus couramment renvoyés par cette API :

  • invalid_authentication_session
  • invalid_parameter_code
  • etc.

La liste ci-dessus n’est pas exhaustive. L’application cliente doit être capable de gérer tous les codes d’erreur améliorés définis dans la documentation publique.

obligatoire

Exemples samples

​1. Récupérer la session d’authentification sans paramètres manquants

Requête
code language-https
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
Réponse
code language-https
HTTP/1.1 200 OK

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

{
    "parameters": {
        "existing": {
            "mvpd": "Cablevision",
            "domain": "adobe.com"
            "redirectUrl": "https://www.adobe.com"
        }
}

​1. Récupérer la session d’authentification avec les paramètres manquants

Requête
code language-https
GET /api/v2/sessions/REF30/8BLW4RW HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
Réponse
code language-https
HTTP/1.1 200 OK

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

{
    "parameters": {
        "existing": {
            "mvpd": "Cablevision",
            "domain": "adobe.com"
        },
        "missing": ["redirectUrl"]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b