Service web de MVPD du proxy proxy-mvpd-wbservice

IMPORTANT
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence Adobe actuelle. Aucune utilisation non autorisée n’est autorisée.
IMPORTANT
Avant d’utiliser le service web Proxy MVPD, assurez-vous que les conditions préalables suivantes sont remplies :
Pour plus d’informations sur la création d’une application enregistrée et le téléchargement de l’instruction logicielle​ reportez-vous à la documentation ​Présentation de l’enregistrement du client dynamique.

Vue d’ensemble overview-proxy-mvpd-webserv

Un « Proxy MVPD » est un MVPD qui, en plus de gérer sa propre intégration avec l’authentification Adobe Pass, gère également le processus de droits au nom d’un groupe de « MVPD en proxy » associés. Cet arrangement est transparent pour les programmeurs.

Pour mettre en œuvre la fonction ProxyMVPD, l’authentification Adobe Pass fournit des services web RESTful avec lesquels les ProxyMVPD peuvent envoyer et récupérer des listes de ProxyMVPD. Le protocole utilisé pour cette API publique est le HTTP REST, avec les hypothèses suivantes :

​- Le MVPD du proxy utilise la méthode HTTP GET pour récupérer la liste des fichiers MVPD actuellement intégrés.
​- Le MVPD du proxy utilise la méthode HTTP POST pour mettre à jour la liste des fichiers MVPD pris en charge.

Services de MVPD proxy proxy-mvpd-services

​- Récupérer les MVPD par proxy
​- ​ Envoyer les MVPD par proxy ​

Récupérer les MVPD par proxy retriev-proxied-mvpds

Récupère la liste actuelle des MVPD proxy intégrées au MVPD proxy identifié.

Point d’entrée
Appelé par
Paramètres de requête
En-têtes de requête
Méthode HTTP
Réponse HTTP
<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
ProxyMVPD
proxy-mvpd-identifier
Autorisation (obligatoire)
GET
  • 200 (ok) - La demande a été traitée avec succès et la réponse contient une liste de ProxiedMVPD au format XML

  • 401 (non autorisé) - Indique l’un des éléments suivants :

    • Le client DOIT demander un nouveau jeton access_token
    • La requête provient d’une adresse IP qui n’est pas présente dans la liste autorisée
    • Le jeton n’est pas valide
  • 403 (interdit) - Indique que l’opération n’est pas prise en charge pour les paramètres fournis ou que le MVPD du proxy n’est pas défini comme proxy ou est manquant

  • 405 (méthode non autorisée) - Une méthode HTTP autre que GET ou POST a été utilisée. Soit la méthode HTTP n’est généralement pas prise en charge, soit elle ne l’est pas pour ce point d’entrée spécifique.

  • 500 (erreur de serveur interne) - Une erreur a été générée côté serveur pendant le processus de demande.

Exemple de curl :

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

Exemple de réponse 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>

Envoyer les MVPD par proxy submit-proxied-mvpds

Envoie un tableau de MVPD intégrés avec le MVPD proxy identifié.

Point d’entrée
Appelé par
Paramètres de requête
En-têtes de requête
Méthode HTTP
Réponse HTTP
<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
ProxyMVPD
proxy-mvpd-identifier
Autorisation (obligatoire) proxy-mvpds (obligatoire)
POSTER
  • 201 (créé) - La notification push a été traitée avec succès

  • 400 (requête incorrecte) - Le serveur ne sait pas comment traiter la requête :

    • Le code XML entrant ne respecte pas le schéma publié dans cette spécification.
    • Les fichiers mvpd proxy n’ont pas d’ID uniques.
    • Les ID de demandeur poussés n’existent pas Autre raison de conteneur de servlet pour le code de réponse 400
  • 401 (non autorisé) - Indique l’un des éléments suivants :

    • Le client DOIT demander un nouveau jeton access_token
    • La requête provient d’une adresse IP qui n’est pas présente dans la liste autorisée
    • Le jeton n’est pas valide
  • 403 (interdit) - Indique que l’opération n’est pas prise en charge pour les paramètres fournis ou que le MVPD du proxy n’est pas défini comme proxy ou est manquant

  • 405 (méthode non autorisée) - Une méthode HTTP autre que GET ou POST a été utilisée. Soit la méthode HTTP n’est généralement pas prise en charge, soit elle ne l’est pas pour ce point d’entrée spécifique.

  • 500 (erreur de serveur interne) - Une erreur a été générée côté serveur pendant le processus de demande.

Exemple de curl :

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"

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

Fréquence de publication posting-frequency

Adobe Pass Authentication recommande que les ProxyMVPDs ne transmettent leur liste de ProxiedMVPDs que lorsqu’il y a une modification par rapport à la transmission précédente.

Suppression des fichiers MVPD proxy delete-proxied-freqency

Si ProxyMVPD envoie un enregistrement XML avec une liste ProxiedMVPDs vide, cette liste vide sera stockée dans notre système comme n'importe quelle liste, supprimant ainsi la liste précédente.

Format XSD xsd-format

Adobe a défini le format accepté suivant pour la publication/récupération des MVPD par proxy depuis/vers notre service web public :

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

Remarques sur les éléments :

​- id (obligatoire) - L’ID du MVPD proxy doit être une chaîne liée au nom du MVPD, utilisant l’un des caractères suivants (car il sera exposé aux programmeurs à des fins de suivi) :
​- Tous les caractères alphanumériques, le trait de soulignement (« _ ») et le trait d’union (« - »).
​- L’idID doit être conforme à l’expression régulière suivante :
(a-zA-Z0-9((-)|_)*)

Par conséquent, il doit comporter au moins un caractère, commencer par une lettre et continuer par une lettre, un chiffre, un tiret ou un trait de soulignement.

​- iframeSize (facultatif) - L’élément iframeSize est facultatif et définit la taille de l’iFrame si la page d’authentification de MVPD est censée se trouver dans un iFrame. Sinon, si l’élément iframeSize n’est pas présent, l’authentification se produit dans une page de redirection de navigateur complète.
​- requestorIds (facultatif) - Les valeurs requestorIds seront fournies par Adobe. Un MVPD proxy doit être intégré à au moins un requestorId. Si la balise « requestorIds » n’est pas présente sur l’élément MVPD proxy, ce MVPD proxy est intégré à tous les demandeurs disponibles sous le MVPD proxy.
​- ProviderID (facultatif) - Lorsque l’attribut ProviderID est présent sur l’élément id, la valeur de ProviderID est envoyée sur la requête d’authentification SAML au MVPD du proxy en tant qu’ID MVPD/SubMVPD proxy (au lieu de la valeur id). Dans ce cas, la valeur de id sera utilisée uniquement dans le sélecteur MVPD présenté sur la page du programmeur, et en interne par l’authentification Adobe Pass. La longueur de l’attribut ProviderID doit être comprise entre 1 et 128 caractères.

Sécurité security

Pour qu’une demande soit considérée comme valide, elle doit respecter les règles suivantes :

​- L’en-tête de la requête doit contenir le jeton d’accès Oauth2 de sécurité obtenu, comme décrit dans la documentation de l’API ​ Récupérer le jeton d’accès ​ .
​- La requête doit provenir d’une adresse IP spécifique qui a été autorisée.
​- La requête doit être envoyée via le protocole SSL.

Tous les paramètres présents dans l’en-tête de la requête qui ne sont pas répertoriés ci-dessus seront ignorés.

Exemple de curl :

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

Points d’entrée du service web MVPD du proxy pour les environnements d’authentification Adobe Pass proxy-mvpd-wevserv-endpoints

​- URL de production : https://mgmt.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- URL d’évaluation : https://mgmt.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- URL de pré-production : https://mgmt-prequal.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
​- URL de préévaluation : https://mgmt-prequal.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds

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