Authentifizierungssitzung mit Code abrufen retrieve-authentication-session-using-code

IMPORTANT
Der Inhalt dieser Seite dient nur zu Informationszwecken. Die Verwendung dieser API erfordert eine aktuelle Lizenz von Adobe. Eine unbefugte Nutzung ist nicht zulässig.
IMPORTANT
Die REST-API-V2-Implementierung ist an die Dokumentation Drosselungsmechanismus gebunden.

Anfrage request

HTTP
Pfad
/api/v2/{serviceProvider}/sessions/{code}
Methode
GET
Pfadparameter
serviceProvider
Die interne eindeutige Kennung, die dem Dienstleister während des Onboarding-Prozesses zugeordnet ist.
required
Code
Der Authentifizierungscode, der nach der Erstellung der Authentifizierungssitzung auf dem Streaming-Gerät abgerufen wurde.
required
Kopfzeilen
Autorisierung
Die Generierung der Bearer-Token-Payload wird in der Dokumentation zur -Kopfzeile.
required
X-Forwarded-For
Die IP-Adresse des Streaming-Geräts.

Es wird dringend empfohlen, sie immer für Server-zu-Server-Implementierungen zu verwenden, insbesondere wenn der Aufruf vom Programmierdienst und nicht vom Streaming-Gerät erfolgt.

Bei Client-zu-Server-Implementierungen wird die IP-Adresse des Streaming-Geräts implizit gesendet.
fakultativ
AP-Visitor-Identifier
Die Erstellung der Payload der Besucherkennung wird in der Kopfzeilendokumentation AP-Visitor-Identifier beschrieben.
fakultativ
Akzeptieren
Der von der Client-Anwendung akzeptierte Medientyp.

Wenn angegeben, muss es application/json sein.
fakultativ
user-agent
Der Benutzeragent der Client-Anwendung.
fakultativ

Antwort response

Code
Text
Beschreibung
200
OK
Der Antworttext enthält Informationen zur Authentifizierungssitzung.
400
Fehlerhafte Anfrage
Die Anfrage ist ungültig. Der Client muss die Anfrage korrigieren und es erneut versuchen. Der Antworttext kann Fehlerinformationen enthalten, die der Dokumentation Erweiterte Fehlercodes entsprechen.
401
Nicht autorisiert
Das Zugriffstoken ist ungültig. Der Client muss ein neues Zugriffstoken abrufen und es erneut versuchen. Weitere Informationen finden Sie in der Dokumentation Übersicht über die Dynamic Client-Registrierung .
405
Methode nicht zulässig
Die HTTP-Methode ist ungültig. Der Client muss eine HTTP-Methode verwenden, die für die angeforderte Ressource zulässig ist, und erneut versuchen. Weitere Informationen finden Sie im Abschnitt Anfrage.
500
Interner Server-Fehler
Auf der Serverseite ist ein Problem aufgetreten. Der Antworttext kann Fehlerinformationen enthalten, die der Dokumentation Erweiterte Fehlercodes entsprechen.

Erfolg success

Kopfzeilen
Status
200
required
Textkörper
Parameter

JSON-Objekt mit den folgenden Attributen:

  • existing
    Die vorhandenen Parameter, die bereits bereitgestellt wurden.
  • missing
    Die fehlenden Parameter, die angegeben werden müssen, um den Authentifizierungsfluss abzuschließen.
required

Fehler error

Kopfzeilen
Status
400, 401, 405, 500
required
content-type
application/json
required
Textkörper

Der Antworttext kann zusätzliche Fehlerinformationen bereitstellen, die der Dokumentation Erweiterte Fehlercodes entsprechen.

Die Client-Anwendung muss einen Mechanismus zur Fehlerbehandlung implementieren, der die Fehlercodes, die am häufigsten von dieser API zurückgegeben werden, ordnungsgemäß verarbeitet:

  • invalid_authentication_session
  • invalid_parameter_code
  • usw.

Die obige Liste erhebt keinen Anspruch auf Vollständigkeit. Die Client-Anwendung muss in der Lage sein, alle in der öffentlichen Dokumentation“ definierten erweiterten Fehler-Codes zu.

required

Beispiele samples

​1. Authentifizierungssitzung ohne fehlende Parameter abrufen

Anfrage
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)
Antwort
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. Authentifizierungssitzung mit fehlenden Parametern abrufen

Anfrage
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)
Antwort
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