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 da Meccanismo di limitazione
<reggie_fqdn>:
- Produzione - api.auth.adobe.com
- Staging - api.auth-staging.adobe.com
<sp_fqdn>:
- Produzione - api.auth.adobe.com
- Staging - api.auth-staging.adobe.com
Descrizione create-reg-code-svc
Restituisce l'URI del codice di registrazione e della pagina di accesso generati in modo casuale.
Endpoint
Chiamato
Da
Da
Input
Parametro
Parametro
HTTP
Metodo
Metodo
Risposta
HTTP
Risposta
Risposta
<reggie_fqdn>/reggie/v1/{requestor}/regcode
Ad esempio:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
Ad esempio:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
App di streaming
o
Servizio programmatore
o
Servizio programmatore
1. richiedente
(componente Percorso)
2. deviceId (Hashed)
(Obbligatorio)
3. device_info/X-Device-Info (Obbligatorio)
4. mvpd (facoltativo)
5. ttl (facoltativo)
6. deviceType
7. deviceUser (Obsoleto)
8. appId (Obsoleto)
(componente Percorso)
2. deviceId (Hashed)
(Obbligatorio)
3. device_info/X-Device-Info (Obbligatorio)
4. mvpd (facoltativo)
5. ttl (facoltativo)
6. deviceType
7. deviceUser (Obsoleto)
8. appId (Obsoleto)
POST
XML o JSON contenente un codice di registrazione e informazioni o dettagli sull’errore in caso di esito negativo. Consulta schemi ed esempi di seguito.
201
Parametro di input
Descrizione
richiedente
ID richiedente del programmatore per il quale è valida questa operazione.
deviceId
Byte ID dispositivo.
device_info/
X-Device-Info
X-Device-Info
Informazioni sul dispositivo di streaming.
Nota: questo PUÒ essere trasmesso device_info come parametro URL, ma a causa delle dimensioni potenziali del parametro e delle limitazioni alla lunghezza di un URL GET, DEVE essere trasmesso come X-Device-Info nell’intestazione http.
Vedi tutti i dettagli in Trasmissione delle informazioni sul dispositivo e sulla connessione.
Nota: questo PUÒ essere trasmesso device_info come parametro URL, ma a causa delle dimensioni potenziali del parametro e delle limitazioni alla lunghezza di un URL GET, DEVE essere trasmesso come X-Device-Info nell’intestazione http.
Vedi tutti i dettagli in Trasmissione delle informazioni sul dispositivo e sulla connessione.
mvpd
ID MVPD per il quale è valida questa operazione.
ttl
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
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
Se viene lasciato vuoto, Adobe Pass Authentication imposta un valore predefinito di 30 minuti.deviceType
Il tipo di dispositivo (ad esempio, Roku, PC).
Se questo parametro è impostato correttamente, ESM offre metriche che sono suddiviso per tipo di dispositivo quando utilizzi Clientless, in modo da poter eseguire diversi tipi di analisi, ad esempio Roku, AppleTV e Xbox.
Vedi, Vantaggi dell’utilizzo del parametro del tipo di dispositivo senza client nelle metriche di passaggio
Nota: device_info sostituirà questo parametro.
Se questo parametro è impostato correttamente, ESM offre metriche che sono suddiviso per tipo di dispositivo quando utilizzi Clientless, in modo da poter eseguire diversi tipi di analisi, ad esempio Roku, AppleTV e Xbox.
Vedi, Vantaggi dell’utilizzo del parametro del tipo di dispositivo senza client nelle metriche di passaggio
Nota: device_info sostituirà questo parametro.
deviceUser
L’identificatore utente del dispositivo.
appId
ID/nome dell’applicazione.
Nota: device_info sostituisce questo parametro.
Nota: device_info sostituisce questo parametro.
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 regcode Viene effettuata una chiamata al servizio Programmatore e non al dispositivo di streaming, è necessaria la seguente intestazione per trasmettere l'indirizzo IP del 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 regcode Viene effettuata una chiamata al servizio Programmatore e non al dispositivo di streaming, è necessaria la seguente intestazione per trasmettere l'indirizzo IP del dispositivo di streaming:
code language-none |
---|
|
dove
Esempio:
<streaming\_device\_ip>
è l'indirizzo IP pubblico del dispositivo di streaming.Esempio:
code language-none |
---|
|
Schema XML di risposta xml-schema
Codice di registrazione XSD registration-code-xsd
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="model.mvc.reggie.pass.adobe.com"
targetNamespace="model.mvc.reggie.pass.adobe.com"
attributeFormDefault="unqualified"
elementFormDefault="unqualified">
<xs:element name="regcode">
<xs:complexType>
<xs:all>
<xs:element name="id" type="xs:string" />
<xs:element name="code" type="xs:string" />
<xs:element name="requestor" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="mvpd" type="xs:string" minOccurs="1" maxOccurs="1"/
<xs:element name="generated" type="xs:long" />
<xs:element name="expires" type="xs:long" />
<xs:element name="info" type="infoType" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:complexType name="infoType">
<xs:all>
<xs:element name="deviceId" type="xs:base64Binary" minOccurs="1" maxOccurs="1"/>
<xs:element name="deviceType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceUser" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="appId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="appVersion" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="registrationURL" type="xs:anyURI" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:schema>
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 (o token XSTS)
deviceType
Tipo di dispositivo
deviceUser
Utente connesso al dispositivo
appId
ID applicazione
appVersion
Versione applicazione
registrationURL
URL dell'app Web di accesso da visualizzare all'utente finale
Messaggio di errore XSD error-message
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="rest.pass.adobe.com"
targetNamespace="rest.pass.adobe.com"
attributeFormDefault="unqualified"
elementFormDefault="unqualified">
<xs:element name="error">
<xs:complexType>
<xs:all>
<xs:element name="status" type="xs:int" minOccurs="1" maxOccurs="1"/>
<xs:element name="message" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="details" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
Risposta di esempio sample-response
XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:regcode xmlns:ns2="model.mvc.reggie.pass.adobe.com">
<id>678f9fea-a1cafec8-1ff0-4a26-8564-f6cd020acf13</id>
<code>TJJCFK</code>
<requestor>sampleRequestorId</requestor>
<mvpd>sampleMvpdId</mvpd>
<generated>1348039846647</generated>
<expires>1348043446647</expires>
<info>
<deviceId>dGhpc0lkQUR1bW15RGV2aWNlSWQ=</deviceId>
<deviceType>xbox</deviceType>
<deviceUser>JD</deviceUser>
<appId>2345</appId>
<appVersion>2.0</appVersion>
<registrationURL>http://loginwebapp.com</registrationURL>
</info>
</ns2:regcode>
JSON:
{
"id": "678f9fea-9d364b29-246c-488f-b97e-298566d1b9e0",
"code": "D4BDU2W",
"requestor": "sampleRequestorId",
"mvpd": "sampleMvpdId",
"generated": 1348039555877,
"expires": 1348043155877,
"info": {
"deviceId": "dGhpc0l.kQUR1bW15RGV2.aWNlSWQ=",
"deviceType": "xboxOne",
"deviceUser": "JD",
"appId": "2345",
"appVersion": "2.0",
"registrationURL": "http://loginwebapp.com"
}
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b