(Veraltete) Registrierungsseite registration-page

REST-API-Endpunkte clientless-endpoints

NOTE
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
Achten Sie darauf, über die neuesten Ankündigungen zu Produkten der Adobe Pass-Authentifizierung und Stilllegungszeitpläne auf der Seite Produktankündigungen auf dem Laufenden zu bleiben.
NOTE
Die REST-API-Implementierung wird durch Drosselungsmechanismus)

<REGGIE_FQDN>:

<SP_FQDN>:

Beschreibung create-reg-code-svc

Gibt den zufällig generierten Registrierungs-Code und den Anmeldeseiten-URI zurück.

Endpunkt
Called
by
Eingabe
Parameter
HTTP
Methode
Antwort
HTTP
Antwort
<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
Beispiel:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
Streaming-App
oder
Programmierer-Service
1.
(Pfadkomponente)
2. deviceId (gehasht)
(mandatory)
3. device_info/X-device-info (obligatorisch)
4. mvpd (optional)
5. TTL (optional)
POST
XML oder JSON mit einem Registrierungs-Code und Informationen oder Fehlerdetails, falls nicht erfolgreich. Siehe Beispiele unten.
201
Eingabeparameter
Typ
Beschreibung
Autorisierung
Header-
: Bearer <access_token>
DCR-Zugriffstoken
Akzeptieren
Header-
: application/json
Geben Sie an, welchen Inhaltstyp der Client verstehen soll
Antragsteller
Abfrageparameter
Die RequestorId des Programmierers, für den dieser Vorgang gültig ist.
deviceId
Abfrageparameter
Die Geräte-ID-Bytes.
device_info/
X-device-info
device_info: Hauptteil
X-Device-info: Header
Informationen zu Streaming-Geräten.
Hinweis: Dies kann als URL-Parameter an device_info übergeben werden, sollte jedoch aufgrund der potenziellen Größe dieses Parameters und der Längenbeschränkungen für eine GET-URL als X-Device-Info im HTTP-Header übergeben werden.
Vollständige Details finden Sie unter Übergeben von Geräte- und Verbindungsinformationen.
mvpd
Abfrageparameter
Die MVPD-ID, für die dieser Vorgang gültig ist.
TTL
Abfrageparameter
Wie lange diese Regcode-Zeit in Sekunden dauern soll.
Hinweis: Der maximal zulässige Wert für ttl beträgt 36000 Sekunden (10 Stunden). Höhere Werte führen zu einer 400-HTTP-Antwort (fehlerhafte Anfrage). Wenn ttl leer gelassen wird, legt die Adobe Pass-Authentifizierung den Standardwert von 30 Minuten fest.
deviceType
Abfrageparameter
Veraltet, sollte nicht mehr verwendet werden.
deviceUser
Abfrageparameter
Veraltet, sollte nicht mehr verwendet werden.
appId
Abfrageparameter
Veraltet, sollte nicht mehr verwendet werden.
CAUTION
IP-Adresse des Streaming-Geräts


Bei Client-zu-Server-Implementierungen wird die IP-Adresse des Streaming-Geräts mit diesem Aufruf implizit gesendet. Bei Server-zu-Server-Implementierungen, bei denen der regcode-Aufruf vom Programmierdienst und nicht vom Streaming-Gerät erfolgt, ist der folgende Header erforderlich, um die IP-Adresse des Streaming-Geräts zu übergeben:
code language-none
X-Forwarded-For : <streaming_device_ip>
wobei <streaming\_device\_ip> die öffentliche IP-Adresse des Streaming-Geräts ist.



Beispiel :
code language-none
POST /reggie/v1/{req_id}/regcode HTTP/1.1<br>X-Forwarded-For:203.45.101.20

Antwort-JSON

JSON-BEISPIELE für Registrierungs-Code

{
  "id": "ef5a79e8-7c8a-41d6-a45a-e378c6c7c8b5",
  "code": "IYQD5JQ",
  "requestor": "sampleRequestorId",
  "mvpd": "sampleMvpdId",
  "generated": 1704963921144,
  "expires": 1704965721144,
  "info": {
    "deviceId": "c28tZGV2aWQtMDAz",
    "deviceInfo": "eyJ0eXBlIjoiU2V0VG9wQm94IiwibW9kZWwiOiJBRlRNTSIsInZlcnNpb24iOnsibWFqb3IiOjAsIm1pbm9yIjowLCJwYXRjaCI6MCwicHJvZmlsZSI6IiJ9LCJoYXJkd2FyZSI6eyJuYW1lIjoiQUZUTU0iLCJ2ZW5kb3IiOiJVbmtub3duIiwidmVyc2lvbiI6eyJtYWpvciI6MCwibWlub3IiOjAsInBhdGNoIjowLCJwcm9maWxlIjoiIn0sIm1hbnVmYWN0dXJlciI6IlJva3UifSwib3BlcmF0aW5nU3lzdGVtIjp7Im5hbWUiOiJBbmRyb2lkIiwiZmFtaWx5IjoiQW5kcm9pZCIsInZlbmRvciI6IkFtYXpvbiIsInZlcnNpb24iOnsibWFqb3IiOjcsIm1pbm9yIjoxLCJwYXRjaCI6MiwicHJvZmlsZSI6IiJ9fSwiYnJvd3NlciI6eyJuYW1lIjoiQ2hyb21lIiwidmVuZG9yIjoiR29vZ2xlIiwidmVyc2lvbiI6eyJtYWpvciI6MTEyLCJtaW5vciI6MCwicGF0Y2giOjU2MTUsInByb2ZpbGUiOiIifSwidXNlckFnZW50IjoiTW96aWxsYS81LjAgKExpbnV4OyBBbmRyb2lkIDcuMS4yOyBBRlRNTSBCdWlsZC9OUzYyOTc7IHd2KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBWZXJzaW9uLzQuMCBDaHJvbWUvMTEyLjAuNTYxNS4xOTcgTW9iaWxlIFNhZmFyaS81MzcuMzYgQWRvYmVQYXNzTmF0aXZlRmlyZVRWLzMuMC44Iiwib3JpZ2luYWxVc2VyQWdlbnQiOiJNb3ppbGxhLzUuMCAoTGludXg7IEFuZHJvaWQgNy4xLjI7IEFGVE1NIEJ1aWxkL05TNjI5Nzsgd3YpIEFwcGxlV2ViS2l0LzUzNy4zNiAoS0hUTUwsIGxpa2UgR2Vja28pIFZlcnNpb24vNC4wIENocm9tZS8xMTIuMC41NjE1LjE5NyBNb2JpbGUgU2FmYXJpLzUzNy4zNiBBZG9iZVBhc3NOYXRpdmVGaXJlVFYvMy4wLjgifSwiZGlzcGxheSI6eyJ3aWR0aCI6MCwiaGVpZ2h0IjowLCJwcGkiOjAsIm5hbWUiOiJESVNQTEFZIiwidmVuZG9yIjpudWxsLCJ2ZXJzaW9uIjpudWxsLCJkaWFnb25hbFNpemUiOm51bGx9LCJhcHBsaWNhdGlvbklkIjpudWxsLCJjb25uZWN0aW9uIjp7ImlwQWRkcmVzcyI6IjE5My4xMDUuMTQwLjEzMSIsInBvcnQiOiI5OTM0Iiwic2VjdXJlIjpmYWxzZSwidHlwZSI6bnVsbH19",
    "userAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
    "originalUserAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
    "authorizationType": "OAUTH2",
    "sourceApplicationInformation": {
      "id": "14138364-application-id",
      "name": "application name",
      "version": "1.0.0"
    }
  }
}
Elementname
Beschreibung
ID
Vom Registrierungs-Code-Service generierte UUID
Code
Vom Registrierungs-Code-Service generierter Registrierungs-Code
Antragsteller
Antragsteller-ID
mvpd
MVPD-ID
Erzeugt
Zeitstempel der Erstellung des Registrierungs-Codes (in Millisekunden seit dem 1. Januar 1970 GMT)
Expires
Zeitstempel, wann der Registrierungscode abläuft (in Millisekunden seit dem 1. Januar 1970 GMT)
deviceId
Eindeutige Base64-Geräte-ID
info:deviceId
Base64-Gerätetyp
info:deviceInfo
Base64 Normalisierte Geräteinformationen basieren auf Informationen, die von Benutzeragenten, X-Device-Info oder device_info empfangen wurden
info:userAgent
Von der Anwendung gesendeter Benutzeragent
info:originalUserAgent
Von der Anwendung gesendeter Benutzeragent
info:authorizationType
OAUTH2 für Aufrufe mit DCR
info:sourceApplicationInformation
Anwendungsinformationen wie im DCR konfiguriert

Beispiel für eine JSON-Fehlermeldung (#error-sample-response)

{
  "status": 400,
  "message": "Required '<>' is not present"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b