Pagina di registrazione registration-page

Endpoint REST API clientless-endpoints

NOTE
Il contenuto di questa pagina viene fornito solo a scopo informativo. L’utilizzo di questa API richiede una licenza corrente di Adobe. Non è consentito alcun uso non autorizzato.
NOTE
L'implementazione REST API è limitata dal meccanismo di limitazione

<FQDN_REGGIE>:

<SP_FQDN>:

Descrizione create-reg-code-svc

Restituisce l'URI del codice di registrazione e della pagina di accesso generati in modo casuale.

Endpoint
Chiamato
da
Input
Parametro
Metodo HTTP
Risposta
HTTP
Risposta
<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
Esempio:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
Servizio programmatore
o
app in streaming
1. richiedente
(componente percorso)
2. deviceId (Hashed)
(obbligatorio)
3. device_info/X-Device-Info (obbligatorio)
4. mvpd (facoltativo)
5. ttl (facoltativo)
POST
XML o JSON contenente un codice di registrazione e informazioni o dettagli sull’errore in caso di esito negativo. Vedi gli esempi di seguito.
201
Parametro di input
Tipo
Descrizione
Autorizzazione
Valore intestazione
: Bearer <access_token>
Token di accesso DCR
Accetta
Valore intestazione
: application/json
indica il tipo di contenuto che il client deve essere in grado di comprendere
richiedente
Parametro query
ID richiedente del programmatore per il quale è valida questa operazione.
deviceId
Parametro query
Byte ID dispositivo.
device_info/
X-Device-Info
device_info: Body
X-Device-Info: Header
Informazioni sul dispositivo di streaming.
Nota: questo parametro POTREBBE essere trasmesso come parametro URL_device, ma a causa delle dimensioni potenziali del parametro e delle limitazioni alla lunghezza di un URL di GET, DOVREBBE essere trasmesso come X-Device-Info nell'intestazione http.
Visualizza tutti i dettagli in Trasmissione delle informazioni sul dispositivo e sulla connessione.
mvpd
Parametro query
ID MVPD per il quale è valida questa operazione.
ttl
Parametro query
Durata di questo codice regcode in secondi.
Nota: il valore massimo consentito per ttl è di 36000 secondi (10 ore). Valori più alti determinano una risposta HTTP 400 (richiesta non valida). Se ttl viene lasciato vuoto, Adobe Pass Authentication imposta il valore predefinito di 30 minuti.
tipoDispositivo
Parametro query
Obsoleto, non deve essere utilizzato.
utenteDispositivo
Parametro query
Obsoleto, non deve essere utilizzato.
appId
Parametro query
Obsoleto, non deve essere utilizzato.
CAUTION
Indirizzo IP dispositivo di streaming


Per le implementazioni client-server, l'indirizzo IP del dispositivo di streaming viene inviato implicitamente con questa chiamata. Per le implementazioni server-to-server in cui la chiamata regcode è impostata sul servizio Programmatore e non sul dispositivo di streaming, per passare l'indirizzo IP del dispositivo di streaming è necessaria la seguente intestazione:
code language-none
X-Forwarded-For : <streaming_device_ip>
dove <streaming\_device\_ip> è l'indirizzo IP pubblico del dispositivo di streaming.



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

JSON di risposta

ESEMPI JSON PER CODICE DI REGISTRAZIONE

{
  "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"
    }
  }
}
Nome elemento
Descrizione
id
UUID generato da Registration Code Service
codice
Codice di registrazione generato da Registration Code Service
richiedente
ID richiedente
mvpd
ID Mvpd
generato
Timestamp di creazione del codice di registrazione (in millisecondi dal 1° gennaio 1970 GMT)
scade
Timestamp di scadenza del codice di registrazione (in millisecondi dal 1° gennaio 1970 GMT)
deviceId
ID dispositivo univoco Base64
info:deviceId
Tipo di dispositivo Base64
info:deviceInfo
Base64 Normalized Device Information si basa sulle informazioni ricevute dall'agente utente, da X-Device-Info o da device_info
info:userAgent
Agente utente inviato dall’applicazione
info:originalUserAgent
Agente utente inviato dall’applicazione
info:authorizationType
OAUTH2 per chiamate con DCR
info:sourceApplicationInformation
Informazioni applicazione configurate in DCR

Messaggio di errore: esempio di risposta JSON (#error-sample-response)

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