Dokumentation Adobe Pass Adobe Pass-autentisering

Registreringssida registration-page

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Autentisering

REST API-slutpunkter clientless-endpoints

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

<REGGIE_FQDN>:

Produktion - api.auth.adobe.com
Mellanlagring - api.auth-staging.adobe.com

<SP_FQDN>:

Produktion - api.auth.adobe.com
Mellanlagring - api.auth-staging.adobe.com

Beskrivning create-reg-code-svc

Returnerar slumpmässigt genererad registreringskod och inloggningssidans URI.

Slutpunkt

Anropat
av

Indata
Parameter

HTTP
Metod

Svar

HTTP
Response

<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
Till exempel:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode

Direktuppspelande app
eller
Programmeringtjänst

1. beställare
(Bankomponent)
2. deviceId (Hashed)
(Obligatoriskt)
3. device_info/X-Device-Info (obligatoriskt)
4. mvpd (valfritt)
5. ttl (valfritt)
6. deviceType
7. deviceUser (utgått)
8. appId (inaktuellt)

POST

XML eller JSON som innehåller en registreringskod och information eller felinformation om felet misslyckas. Se scheman och exempel nedan.

201

Indataparameter

Beskrivning

begärande

Programmerarens requestId som den här åtgärden är giltig för.

deviceId

Byte för enhets-ID.

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.

mvpd

Det MVPD-ID som den här åtgärden gäller för.

ttl

Hur länge den här regkoden ska vara i sekunder.
Obs!: Det högsta tillåtna värdet för ttl är 36000 sekunder (10 timmar). Högre värden resulterar i ett 400 HTTP-svar (felaktig begäran). Om ttl lämnas tomt anges standardvärdet 30 minuter av Adobe Pass Authentication.

deviceType

Enhetstypen (t.ex. Roku, PC).
Om den här parametern är korrekt har ESM värden som är nedbrutna per enhetstyp när klientlösa används, så att olika typer av analyser kan utföras, till exempel Roku, AppleTV och Xbox.
Se, Fördelar med att använda parametern för klientlös enhetstyp i pass-må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.

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 till Programmer-tjänsten och inte till 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</br>X-Forwarded-For:203.45.101.20`

XML-schema för svar xml-schema

Registreringskod 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>

Elementnamn

Beskrivning

UUID genererat av registreringskodstjänsten

kod

Registreringskod som genererats av registreringskodstjänsten

begärande

Begärande-ID

mvpd

Mvpd-ID

genererad

Tidsstämpel för att skapa registreringskod (i millisekunder sedan 1 januari 1970 GMT)

förfaller

Tidsstämpel när registreringskoden upphör (i millisekunder sedan 1 januari 1970 GMT)

deviceId

Unikt enhets-ID (eller XSTS-token)

deviceType

Enhetstyp

deviceUser

Användaren är inloggad på enheten

appId

Program-ID

appVersion

Programversion

registrationURL

URL till inloggningswebbappen som ska visas för slutanvändaren

Felmeddelande-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>

Exempelsvar 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