Proxy MVPD webbtjänst proxy-mvpd-wbservice

IMPORTANT
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.
IMPORTANT
Innan du använder webbtjänsten Proxy MVPD måste du kontrollera att följande krav är uppfyllda:
Mer information om hur du skapar ett registrerat program och hämtar programsatsen finns i Översikt över registrering av dynamiska klienter .

Ökning overview-proxy-mvpd-webserv

En"Proxy MVPD" är en MVPD som förutom att hantera sin egen integrering med Adobe Pass Authentication även hanterar tillståndsprocessen för en grupp av associerade"Proxied MVPDs". Detta är öppet för programmerare.

För att implementera ProxyMVPD-funktionen tillhandahåller Adobe Pass Authentication RESTful-webbtjänster som ProxyMVPD kan använda för att skicka och hämta listor över ProxiedMVPD. Protokollet som används för detta offentliga API är REST HTTP, med följande antaganden:

​- Proxy MVPD använder HTTP GET-metoden för att hämta listan över de aktuella integrerade programmeringsgränssnitten.
​- Proxy MVPD använder HTTP POST-metoden för att uppdatera listan över de MVPD som stöds.

Proxy MVPD services proxy-mvpd-services

​- Hämta proxibla MVPD:er
​- Skicka proxygenererade MVPD:er

Hämta proxibla MVPD-filer retriev-proxied-mvpds

Hämtar den aktuella listan över Proxied MVPD:er som är integrerade med Proxy MVPD-identifierad.

Slutpunkt
Anropat av
Begärandeparametrar
Begäranrubriker
HTTP-metod
HTTP-svar
<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
ProxyMVPD
proxy-mvpd-identifier
Behörighet (obligatoriskt)
GET
  • 200 (ok) - Begäran har bearbetats och svaret innehåller en lista med ProxiedMVPD i XML-format

  • 401 (obehörig) - Anger något av följande:

    • Klienten MÅSTE begära en ny access_token
    • Begäran kommer från en IP-adress som inte finns i tillåtelselista
    • Ogiltig token
  • 403 (ej tillåtet) - Anger antingen att åtgärden inte stöds för de angivna parametrarna, eller att proxyn MVPD inte har angetts som proxy eller saknas

  • 405 (metod tillåts inte) - En annan HTTP-metod än GET eller POST användes. Antingen stöds inte HTTP-metoden generellt eller så stöds den inte för den här specifika slutpunkten.

  • 500 (internt serverfel) - Ett fel uppstod på serversidan under förfrågningsprocessen.

Exempel på vändning:

curl -X GET -H "Authorization: Bearer <access_token_here>" "https://mgmt-prequal.auth-staging.adobe.com/control/v3/mvpd-proxies/ProxyMVPD_Adobe/mvpds"

Exempel på XML-svar:

<?xml version="1.0" encoding="UTF-8"?>
<proxiedMvpds>
    <proxiedMvpd>
        <id>oneMvpdId</id>
        <displayName>MVPD Name</displayName>
        <logoURL></logoURL>
    </proxiedMvpd>
    <proxiedMvpd>
        <id ProviderID="ProviderID_Value_Sent_On_IdPEntry">mvpdPickerId</id>
        <displayName>MVPD Name Two</displayName>
        <logoURL></logoURL>
        <requestorIds>
            <requestorId>TheRequestorId_IntegratedWith</requestorId>
        </requestorIds>
    </proxiedMvpd>
    <proxiedMvpd>
        <id>anotherMvpdId</id>
        <displayName>Another MVPD</displayName>
        <logoURL></logoURL>
        <iframeSize>
            <iframeHeight>400</iframeHeight>
            <iframeWidth>340</iframeWidth>
        </iframeSize>
        <requestorIds>
            <requestorId>FirstIntegratedRequestorId</requestorId>
            <requestorId>SecondIntegratedRequestorId</requestorId>
        </requestorIds>
    </proxiedMvpd>
</proxiedMvpds>

Skicka proxygenererade MVPD-filer submit-proxied-mvpds

Flyttar en array med MVPD-filer som är integrerade med Proxy MVPD-identifierad.

Slutpunkt
Anropat av
Begärandeparametrar
Begäranrubriker
HTTP-metod
HTTP-svar
<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
ProxyMVPD
proxy-mvpd-identifier
Tillstånd (obligatoriskt) proxied-mvpds (obligatoriskt)
POST
  • 201 (skapad) - push-åtgärden bearbetades

  • 400 (felaktig begäran) - Servern kan inte behandla begäran:

    • Inkommande XML följer inte schemat som publicerats i den här specifikationen
    • De proxibla mvpds har inga unika ID:n
    • BegärandeID:n som skickas finns inte för någon annan serverbehållarorsak för 400 svarskod
  • 401 (obehörig) - Anger något av följande:

    • Klienten MÅSTE begära en ny access_token
    • Begäran kommer från en IP-adress som inte finns i tillåtelselista
    • Ogiltig token
  • 403 (ej tillåtet) - Anger antingen att åtgärden inte stöds för de angivna parametrarna, eller att proxyn MVPD inte har angetts som proxy eller saknas

  • 405 (metod tillåts inte) - En annan HTTP-metod än GET eller POST användes. Antingen stöds inte HTTP-metoden generellt eller så stöds den inte för den här specifika slutpunkten.

  • 500 (internt serverfel) - Ett fel uppstod på serversidan under förfrågningsprocessen.

Exempel på vändning:

curl -X POST -H "Authorization: Bearer <access_token_here>" "https://mgmt-prequal.auth.adobe.com/control/v3/mvpd-proxies/ProxyMVPD_Adobe/mvpds" -d "proxied-mvpds=%3CproxiedMvpds%3E%3CproxiedMvpd%3E%3CdisplayName%3EFirst%20MVPD%20Name%3C%2FdisplayName%3E%3Cid%3EfirstMVPDId%3C%2Fid%3E%3ClogoURL%3E%3C%2FlogoURL%3E%3C%2FproxiedMvpd%3E%3CproxiedMvpd%3E%3Cid%20ProviderID%3D%22ProviderID_Value_Sent_On_IdPEntry%22%3EmvpdPickerId%3C%2Fid%3E%3CdisplayName%3EMVPD%20Name%20Two%3C%2FdisplayName%3E%3ClogoURL%3E%3C%2FlogoURL%3E%3CrequestorIds%3E%3CrequestorId%3ETHE_REQUESTOR_ID%3C%2FrequestorId%3E%3C%2FrequestorIds%3E%3C%2FproxiedMvpd%3E%3C%2FproxiedMvpds%3E"

XML:

<?xml version="1.0" encoding="UTF-8"?>
<proxiedMvpds>
    <proxiedMvpd>
        <id>oneMvpdId</id>
        <displayName>MVPD Name</displayName>
        <logoURL></logoURL>
    </proxiedMvpd>
    <proxiedMvpd>
        <id ProviderID="ProviderID_Value_Sent_On_IdPEntry">mvpdPickerId</id>
        <displayName>MVPD Name Two</displayName>
        <logoURL></logoURL>
        <requestorIds>
            <requestorId>TheRequestorId_IntegratedWith</requestorId>
        </requestorIds>
    </proxiedMvpd>
    <proxiedMvpd>
        <id>anotherMvpdId</id>
        <displayName>Another MVPD</displayName>
        <logoURL></logoURL>
        <iframeSize>
            <iframeHeight>400</iframeHeight>
            <iframeWidth>340</iframeWidth>
        </iframeSize>
        <requestorIds>
            <requestorId>FirstIntegratedRequestorId</requestorId>
            <requestorId>SecondIntegratedRequestorId</requestorId>
        </requestorIds>
    </proxiedMvpd>
</proxiedMvpds>

Bokföringsfrekvens posting-frequency

Adobe Pass Authentication rekommenderar att ProxyMVPD bara skickar sin lista över ProxiedMVPD när det finns en ändring från föregående push-åtgärd.

Tar bort proxiderade MVPD-filer delete-proxied-freqency

Om ProxyMVPD överför en XML-post med en tom ProxiedMVPD-lista kommer den tomma listan att lagras i vårt system precis som alla andra listor, vilket innebär att den föregående listan tas bort.

XSD format xsd-format

Adobe har definierat följande godkända format för publicering/hämtning av proxygenererade MVPD från/till vår offentliga webbtjänst:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:pxm="http://tve.adobe.com/data/proxiedmvpd"
           targetNamespace="http://tve.adobe.com/data/proxiedmvpd"
           elementFormDefault="qualified"
           version="1.0">
    <xs:complexType name="iframeSize">
        <xs:all>
            <xs:element name="iframeHeight" type="xs:int" minOccurs="1" maxOccurs="1" nillable="false"/>
            <xs:element name="iframeWidth" type="xs:int" minOccurs="1" maxOccurs="1" nillable="false"/>
        </xs:all>
    </xs:complexType>
    <xs:complexType name="requestorIds">
        <xs:annotation>
            <xs:documentation>List of requestors/programmers integrated with the proxied MVPD</xs:documentation>
        </xs:annotation>
        <xs:sequence>
            <xs:element name="requestorId" type="xs:string" minOccurs="1" maxOccurs="unbounded" nillable="false">
                <xs:annotation>
                    <xs:documentation>The requestor/programmer identifier recognized by Adobe</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="proxiedMvpd">
        <xs:all>
            <xs:element name="id" minOccurs="1" maxOccurs="1" nillable="false">
                <xs:annotation>
                    <xs:documentation>The id must conform to the regular expression: ([a-zA-Z0-9]+((\-)|[_])*)</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:simpleContent>
                        <xs:extension base="xs:string">
                            <xs:attribute name="ProviderID">
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:minLength value="1"/>
                                        <xs:maxLength value="128"/>
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:attribute>
                        </xs:extension>
                    </xs:simpleContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="displayName" type="xs:string" minOccurs="1" maxOccurs="1" nillable="false"/>
            <xs:element name="logoURL" type="xs:anyURI" minOccurs="1" maxOccurs="1" nillable="false"/>
            <xs:element name="iframeSize" type="pxm:iframeSize" minOccurs="0" maxOccurs="1"/>
            <xs:element name="requestorIds" type="pxm:requestorIds" minOccurs="0" maxOccurs="1"/>
        </xs:all>
    </xs:complexType>
    <xs:element name="proxiedMvpds">
        <xs:annotation>
            <xs:documentation>List of Proxied MVPD</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="proxiedMvpd" type="pxm:proxiedMvpd" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Kommentarer om element:

​- id (obligatoriskt) - Proxied MVPD-id:t måste vara en sträng som är relevant för namnet på MVPD och som använder något av följande tecken (eftersom det kommer att visas för programmerare för spårningsändamål):
​- Alfanumeriska tecken, understreck ("_") och bindestreck ("-").
​- ID:t måste överensstämma med följande reguljära uttryck:
(a-zA-Z0-9((-)|_)*)

Det måste alltså ha minst ett tecken, börja med en bokstav och fortsätta med en bokstav, siffra, bindestreck eller understreck.

​- iframeSize (valfritt) - Elementet iframeSize är valfritt och definierar storleken på iFrame om MVPD autentiseringssida ska finnas i en iFrame. Annars, om iframeSize-elementet inte finns, sker autentiseringen på en omdirigeringssida i en fullständig webbläsare.
​- requestorIds (valfritt) - RequestId-värdena kommer att anges av Adobe. Ett krav är att en proxiderad MVPD ska integreras med minst ett requestId. Om taggen "requestIds" inte finns i det proxierade MVPD-elementet kommer den proxierade MVPD att integreras med alla tillgängliga beställare som är integrerade i Proxy MVPD.
​- ProviderID (valfritt) - När attributet ProviderID finns i elementet id skickas värdet för ProviderID på SAML-autentiseringsbegäran till Proxy MVPD som Proxied MVPD/SubMVPD ID (i stället för id-värdet). I det här fallet används värdet för id endast i den MVPD-väljare som presenteras på Programmer-sidan och internt av Adobe Pass Authentication. Längden på ProviderID-attributet måste vara mellan 1 och 128 tecken.

Säkerhet security

För att en begäran ska anses giltig måste den uppfylla följande regler:

​- Begärandehuvudet måste innehålla den Oauth2-åtkomsttoken för säkerhet som hämtas enligt beskrivningen i API-dokumentationen för Hämta åtkomsttoken.
​- Begäran måste komma från en specifik IP-adress som är tillåten.
​- Begäran måste skickas via SSL-protokollet.

Alla parametrar i begärandehuvudet som inte finns med i listan ovan kommer att ignoreras.

Exempel på vändning:

curl -X GET -H "Authorization: Bearer <access_token_here>" "https://mgmt-prequal.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds"

Proxy MVPD Web Service Endpoints for the Adobe Pass Authentication Environment proxy-mvpd-wevserv-endpoints

​- Produktions-URL: https://mgmt.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- Mellanlagrings-URL: https://mgmt.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- PreQual-Production URL: https://mgmt-prequal.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- PreQual-Staging URL: https://mgmt-prequal.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b