DokumentationAdobe PassAdobe Pass-autentisering

Initiera auktorisering initiate-authorization

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.
NOTE
REST API-implementeringen begränsas av Begränsningsmekanismen

REST API-slutpunkter clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Beskrivning description

Hämtar auktoriseringssvar.

Slutpunkt
Anropat
av
Indata
Parametrar
HTTP
Metod
Svar
HTTP
Response
<SP_FQDN>/api/v1/authorized
Direktuppspelande app

eller

Programmeringtjänst
1. beställare (obligatoriskt)
2. deviceId (obligatoriskt)
3. resurs (obligatoriskt)
4. device_info/X-Device-Info (obligatoriskt)
5. deviceType
6. deviceUser (utgått)
7. appId (utgått)
8. extra parametrar (valfritt)
GET
XML eller JSON som innehåller auktoriseringsinformation eller felinformation om det misslyckas. Se exemplen nedan.
200 - lyckades
403 - misslyckades
Indataparameter
Beskrivning
begärande
Programmerarens requestId som den här åtgärden är giltig för.
deviceId
Byte för enhets-ID.
resurs
En sträng som innehåller ett resourceId (eller MRSS-fragment), identifierar innehållet som begärts av en användare och känns igen av MVPD-auktoriseringsslutpunkter.
device_info/

X-Device-Info
Information om direktuppspelningsenhet.

Obs!: Detta kan skickas som device_info som URL-parameter, men på grund av parameterns potentiella storlek och begränsningar i längden på en GET-URL, bör det skickas som X-Device-Info i http-huvudet.

Mer information finns i Skicka information om enheter och anslutningar.
deviceType
Enhetstypen (t.ex. Roku, PC).

Om den här parametern är korrekt har ESM värden som är nedbrutna per enhetstyp när Clientless används, så att olika typer av analyser kan utföras för t.ex. Roku, AppleTV, Xbox osv.

Se Fördelar med parameter för klientlös enhetstyp i passningsmått

Obs! Parametern device_info kommer att ersättas.
deviceUser
Enhetens användaridentifierare.
appId
Program-ID/namn.

Obs!: device_info ersätter den här parametern.
extra parametrar
Anropet kan även innehålla valfria parametrar som aktiverar andra funktioner som:

* generic_data - aktiverar användningen av Promotional TempPass

Exempel: generic_data=("email":"email@domain.com")
CAUTION
IP-adress för direktuppspelningsenhet

För klient-till-server-implementeringar skickas IP-adressen för direktuppspelningsenheten implicit med det här anropet. För Server-till-Server-implementeringar, där anropet regcode görs av programmeringstjänsten och inte av direktuppspelningsenheten, krävs följande rubrik för att skicka IP-adressen för direktuppspelningsenheten:
code language-none 
X-Forwarded-For : <streaming\_device\_ip>
där <streaming\_device\_ip> är den offentliga IP-adressen för direktuppspelningsenheten.


Exempel:
code language-none 
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

Exempelsvar sample-response

  • Fall 1: Lyckades

    • XML:

    "XML
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <auktorisering>
    <expirres>1348148289000</expirres>
    <mvpd>sampleMvpdId</mmbd</mres> vpd>
    <beställare>sampleRequestorId</beställare>
    <resource>sampleResourceId</resource>
    </authentication>
    "

  • JSON:

    code language-json 
    {
  "mvpd": "sampleMvpdId",
  "resource": "sampleResourceId",
  "requestor": "sampleRequestorId",
  "expires": "1348148289000"
}
IMPORTANT
När svaret kommer från ett MVPD-dokument för proxy kan det innehålla ytterligare ett element med namnet proxyMvpd.

  • Fall 2: Autentisering nekas

    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