Documentación Adobe Pass Adobe Pass Authentication

Servicio web de MVPD proxy

Última actualización: 6 de diciembre de 2024

Temas:
Autenticación

IMPORTANT

El contenido de esta página se proporciona únicamente con fines informativos. El uso de esta API requiere una licencia actual de Adobe. No se permite el uso no autorizado.

IMPORTANT

Antes de utilizar el servicio web de MVPD proxy, asegúrese de que se cumplen los siguientes requisitos previos:

Obtenga las credenciales del cliente como se describe en la Documentación de la API Retrieve client credentials.
Obtenga el token de acceso como se describe en la Documentación de la API Recuperar token de acceso.

Consulte la documentación de Información general sobre el registro dinámico de clientes para obtener más información sobre cómo crear una aplicación registrada y descargar la instrucción de software.

Información general

Una "MVPD proxy" es una MVPD que, además de gestionar su propia integración con la autenticación de Adobe Pass, también gestiona el proceso de asignación de derechos en nombre de un grupo de "MVPD proxy" asociadas. Esta disposición es transparente para los programadores.

Para implementar la función ProxyMVPD, la autenticación de Adobe Pass proporciona servicios web RESTful, con los cuales ProxyMVPD puede enviar y recuperar listas de ProxiedMVPD. El protocolo utilizado para esta API pública es REST HTTP, con las siguientes suposiciones:

- La MVPD proxy utiliza el método de GET HTTP para recuperar la lista de las MVPD integradas actuales.
- La MVPD proxy utiliza el método del POST HTTP para actualizar la lista de las MVPD compatibles.

Servicios de MVPD proxy

- Recuperar MVPD proxy
- Enviar MVPD proxy

Recuperar MVPD proxy

Recupera la lista actual de MVPD proxy integradas con la MVPD proxy identificada.

Extremo

Llamado por

Parámetros de solicitud

Encabezados de solicitud

Método HTTP

Respuesta HTTP

<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds

ProxyMVPD

proxy-mvpd-identifier

Autorización (obligatoria)

GET

200 (ok): la solicitud se procesó correctamente y la respuesta contiene una lista de ProxiedMVPD en formato XML
401 (sin autorización): indica una de las siguientes opciones:
- El cliente DEBE solicitar un nuevo access_token
- La solicitud se origina desde una dirección IP que no está presente en la lista de permitidos
- El token no es válido
403 (prohibido): indica que la operación no es compatible con los parámetros proporcionados o que el MVPD proxy no está configurado como proxy o que falta
405 (método no permitido): se ha utilizado un método HTTP distinto del GET o el POST. El método HTTP no es compatible en general o no es compatible con este extremo específico.
500 (error interno del servidor): se ha producido un error en el lado del servidor durante el proceso de solicitud.

Ejemplo 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"

Ejemplo de respuesta 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>

Envío de MVPD proxy

Inserta una matriz de MVPD integradas con la MVPD proxy identificada.

Extremo

Llamado por

Parámetros de solicitud

Encabezados de solicitud

Método HTTP

Respuesta HTTP

<FQDN>/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds

ProxyMVPD

proxy-mvpd-identifier

Autorización (obligatoria) proxy-mvpds (obligatoria)

POST

201 (creado): la inserción se procesó correctamente
400 (solicitud incorrecta): El servidor no sabe cómo procesar la solicitud:
- El XML entrante no cumple el esquema publicado en esta especificación
- Los mvpd proxy no tienen ID únicos
- Los requestorIds insertados no existen como la razón del contenedor de otro servlet para el código de respuesta 400
401 (sin autorización): indica una de las siguientes opciones:
- El cliente DEBE solicitar un nuevo access_token
- La solicitud se origina desde una dirección IP que no está presente en la lista de permitidos
- El token no es válido
403 (prohibido): indica que la operación no es compatible con los parámetros proporcionados o que el MVPD proxy no está configurado como proxy o que falta
405 (método no permitido): se ha utilizado un método HTTP distinto del GET o el POST. El método HTTP no es compatible en general o no es compatible con este extremo específico.
500 (error interno del servidor): se ha producido un error en el lado del servidor durante el proceso de solicitud.

Ejemplo 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"

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

Frecuencia de contabilización

La autenticación de Adobe Pass recomienda que las MVPD de proxy inserten su lista de MVPD de proxy solo cuando haya un cambio con respecto a la inserción anterior.

Eliminación de MVPD proxy

Si ProxyMVPD inserta un registro XML con una lista de ProxiedMVPD vacía, esa lista vacía se almacenará en el sistema como cualquier lista, con lo que se eliminará de forma efectiva la lista anterior.

Formato XSD

El Adobe ha definido el siguiente formato aceptado para publicar/recuperar MVPD proxy desde/hacia nuestro servicio web público:

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

Notas sobre los elementos:

- id (obligatorio): el ID de MVPD proxy debe ser una cadena relevante para el nombre de la MVPD, utilizando cualquiera de los siguientes caracteres (ya que se expondrá a los programadores para realizar el seguimiento):
- Cualquier carácter alfanumérico, guion bajo ("_") y guion ("-").
- El idID debe ajustarse a la siguiente expresión regular:
(a-zA-Z0-9((-)|_)*)

Por lo tanto, debe tener al menos un carácter, comenzar con una letra y continuar con cualquier letra, dígito, guión o guion bajo.

- iframeSize (opcional): el elemento iframeSize es opcional y define el tamaño del iFrame si la página de autenticación MVPD debe estar en un iFrame. De lo contrario, si el elemento iframeSize no está presente, la autenticación se producirá en una página de redirección de explorador completa.
- requestorIds (opcional): el Adobe proporcionará los valores de requestorIds. Un requisito es que una MVPD proxy debe integrarse con al menos un requestorId. Si la etiqueta "requestorIds" no está presente en el elemento MVPD proxy, entonces ese MVPD proxy se integrará con todos los solicitantes disponibles integrados en el MVPD proxy.
- ProviderID (opcional): cuando el atributo ProviderID está presente en el elemento id, el valor de ProviderID se enviará en la solicitud de autenticación SAML a la MVPD proxy como ID de MVPD / SubMVPD proxy (en lugar del valor id). En este caso, el valor de id solo se utilizará en el selector de MVPD presentado en la página Programador y, de forma interna, mediante la autenticación de Adobe Pass. La longitud del atributo ProviderID debe estar entre 1 y 128 caracteres.

Seguridad

Para que una solicitud se considere válida, debe respetar las siguientes reglas:
- el encabezado de la solicitud debe contener el token de acceso de seguridad Oauth2 obtenido tal como se describe en la documentación de la API Recuperar token de acceso.
- la solicitud debe provenir de una dirección IP específica que se haya permitido.
- la solicitud debe enviarse a través del protocolo SSL.

Se ignorará cualquier parámetro presente en el encabezado de la solicitud que no esté enumerado anteriormente.

Ejemplo 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"

Puntos finales de servicio web de MVPD proxy para los entornos de autenticación de Adobe Pass

- URL de producción: https://mgmt.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
- URL de ensayo: https://mgmt.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
- URL de preproducción de calidad: https://mgmt-prequal.auth.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds
- URL de ensayo previo a la calidad: https://mgmt-prequal.auth-staging.adobe.com/control/v3/mvpd-proxies/<proxy-mvpd-identifier>/mvpds

recommendation-more-help