Autorisierung initiieren initiate-authorization
NOTE
Der Inhalt dieser Seite dient nur Informationszwecken. Für die Verwendung dieser API ist eine aktuelle Lizenz von Adobe erforderlich. Eine unbefugte Anwendung ist nicht zulässig.
NOTE
Die REST-API-Implementierung wird durch Drosselmechanismus
REST-API-Endpunkte clientless-endpoints
<reggie_fqdn>:
- Produktion - api.auth.adobe.com
- Staging - api.auth-staging.adobe.com
<sp_fqdn>:
- Produktion - api.auth.adobe.com
- Staging - api.auth-staging.adobe.com
Beschreibung description
Erhält die Antwort auf die Autorisierung.
Endpunkt
aufgerufen
von
von
Eingabe
Parameter
Parameter
HTTP
Methode
Methode
Reaktion
HTTP
Reaktion
Reaktion
<sp_fqdn>/api/v1/authorize
Streaming-App
oder
Programmiererdienst
oder
Programmiererdienst
1. Antragsteller (erforderlich)
2. deviceId (Obligatorisch)
3. resource (erforderlich)
4. device_info/X-Device-Info (erforderlich)
5. deviceType
6. deviceUser (Veraltet)
7. appId (Veraltet)
8. Zusätzliche Parameter (optional)
2. deviceId (Obligatorisch)
3. resource (erforderlich)
4. device_info/X-Device-Info (erforderlich)
5. deviceType
6. deviceUser (Veraltet)
7. appId (Veraltet)
8. Zusätzliche Parameter (optional)
GET
XML oder JSON mit Autorisierungsdetails oder Fehlerdetails, falls nicht erfolgreich. Siehe Beispiele unten.
200 - Erfolg
403 - Kein Erfolg
403 - Kein Erfolg
Eingabeparameter
Beschreibung
Anfragender
Die Programmer-Anfrage-ID, für die dieser Vorgang gültig ist.
deviceId
Die Geräte-ID-Bytes.
resource
Eine Zeichenfolge, die eine resourceId (oder ein MRSS-Fragment) enthält, den von einem Benutzer angeforderten Inhalt identifiziert und von MVPD-Autorisierungsendpunkten erkannt wird.
device_info/
X-Device-Info
X-Device-Info
Informationen zum Streaming-Gerät.
Hinweis: Dieser Parameter kann als URL-Parameter an device_info übergeben werden. Aufgrund der potenziellen Größe dieses Parameters und der Längenbeschränkungen einer GET-URL sollte er jedoch als X-Device-Info in der HTTP-Kopfzeile übergeben werden.
\ .
Hinweis: Dieser Parameter kann als URL-Parameter an device_info übergeben werden. Aufgrund der potenziellen Größe dieses Parameters und der Längenbeschränkungen einer GET-URL sollte er jedoch als X-Device-Info in der HTTP-Kopfzeile übergeben werden.
\ .
deviceType
Der Gerätetyp (z. B. Roku, PC).
Wenn dieser Parameter korrekt festgelegt ist, bietet ESM Metriken an, die aufgeschlüsselt nach Gerätetyp bei Verwendung von ClientLess, sodass verschiedene Arten der Analyse für z. B. Roku, AppleTV, Xbox usw. durchgeführt werden können.
Siehe Vorteile des Parameters für Client-lose Gerätetypen in Pass-Metriken
Hinweis: Der Parameter device_info ersetzt diesen Parameter.
Wenn dieser Parameter korrekt festgelegt ist, bietet ESM Metriken an, die aufgeschlüsselt nach Gerätetyp bei Verwendung von ClientLess, sodass verschiedene Arten der Analyse für z. B. Roku, AppleTV, Xbox usw. durchgeführt werden können.
Siehe Vorteile des Parameters für Client-lose Gerätetypen in Pass-Metriken
Hinweis: Der Parameter device_info ersetzt diesen Parameter.
deviceUser
Die Benutzer-ID des Geräts.
appId
Die Anwendungs-ID/der Name.
Hinweis: Der Parameter device_info ersetzt diesen.
Hinweis: Der Parameter device_info ersetzt diesen.
zusätzliche Parameter
Der Aufruf kann auch optionale Parameter enthalten, die andere Funktionen wie:
* generic_data - ermöglicht die Verwendung von Promotional TempPass
Beispiel:
* generic_data - ermöglicht die Verwendung von Promotional TempPass
Beispiel:
generic_data=("email":"email@domain.com")
CAUTION
IP-Adresse des Streaming-Geräts
Bei Client-zu-Server-Implementierungen wird die IP-Adresse des Streaming-Geräts implizit mit diesem Aufruf gesendet. Bei Server-zu-Server-Implementierungen, bei denen die Variable regcode wird vom Programmierer-Dienst und nicht vom Streaming-Gerät aufgerufen. Der folgende Header ist erforderlich, um die IP-Adresse des Streaming-Geräts zu übergeben:
Bei Client-zu-Server-Implementierungen wird die IP-Adresse des Streaming-Geräts implizit mit diesem Aufruf gesendet. Bei Server-zu-Server-Implementierungen, bei denen die Variable regcode wird vom Programmierer-Dienst und nicht vom Streaming-Gerät aufgerufen. Der folgende Header ist erforderlich, um die IP-Adresse des Streaming-Geräts zu übergeben:
code language-none |
---|
|
where
Beispiel :
<streaming\_device\_ip>
ist die öffentliche IP-Adresse des Streaming-Geräts.Beispiel :
code language-none |
---|
|
Beispielantwort sample-response
-
1. Fall: Erfolg
- XML:
"XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<authorization>
<expires>1348148289000</expires>
<mvpd>sampleMvpdId</mvpd>
<requestor>sampleRequestorId</requestor>
<resource>sampleResourceId</resource>
</authorization>
" -
JSON:
code language-json { "mvpd": "sampleMvpdId", "resource": "sampleResourceId", "requestor": "sampleRequestorId", "expires": "1348148289000" }
IMPORTANT
Wenn die Antwort von einem Proxy-MVPD stammt, kann sie ein zusätzliches Element namens
proxyMvpd
.-
2. Fall: Genehmigung verweigert
code language-json <error> <status>403</status> <message>User not authorized</message> <details>Your subscription package does not include the "ASFAFD" channel. Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details> </error>
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b