soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Características: Player Management API

    Player La gestión se refiere a la creación, edición y gestión de player como recurso para los editores. Player La gestión se logra mediante una API REST del lado del servidor que permite a sus consumidores crear, configurar, obtener una vista previa y publicar player instancias.
     

    Introducción

    Creando y actualizando player se realiza en un enfoque de dos fases. En lugar de tener todos los cambios aplicados automáticamente a la producción player, los cambios se separan en vista previa y se publican. Ahora puede hacer todas las actualizaciones que desee para su vista previa player sin afectar lo que ven sus usuarios finales. Puede elegir publicar los cambios cuando lo desee.

    El Player Management API permite a un usuario:

    1. Crea un player
    2. Ver la configuración de un jugador
    3. Cambiar la configuración de un jugador
    4. Listar todos los players asociado con el editor
    5. Publique un reproductor para que esté disponible para el consumidor

    Ver también el Referencia de la API.

    URL base

    La URL base para la API es:

        https://players.api.brightcove.com/v2

    Introducción

    El player El sistema de gestión se compone de tres objetos clave. Son la plantilla predeterminada, playersy niño players.

    Plantilla predeterminada de Brightcove - La plantilla es un conjunto de archivos y configuraciones utilizados como base para crear las experiencias de visualización presentadas a los usuarios, y la base para todos players creado. Estos archivos finalmente se compilan con personalizados player configuración y dar como resultado el código real que se carga en el navegador (el player) Actualmente solo hay una plantilla única que se utiliza en todo el sistema. Como tal, no hay visibilidad en la plantilla a través de la API.

    JUGADORES - Players son configuraciones específicas del cliente que capturan información general y personalizaciones que se aplicarán a la plantilla. Estas configuraciones se envían a la API y a player Resultados de objeto. Las personalizaciones pueden incluir configuraciones, estilos y complementos. Para obtener una lista completa de posibilidades de personalización, consulte el Guía de configuración del reproductor.

    Niño Players - Niño players, creado con las API de incrustación, son el resultado de crear varias instancias de un player. El player tiene la mayor parte de las propiedades que desea que su player tener, y luego puedes usar un niño player para personalizar subconjuntos de propiedades en diferentes player instancias. Un niño player solo puede definir medios para agregar a un determinado player, o podría definir cualquier configuración o anulación de estilo que altere lo común player a la que pertenece Cambios a los padres player la configuración se aplicará a todos los niños players generado del padre player. Echa un vistazo a la Guía de API incorporadas para más detalles.

    Este diagrama muestra las relaciones entre la plantilla predeterminada, playersy niño players.

    Player Jerarquía de entidad
    Player Jerarquía de entidad

    Cuando se utiliza el Player Management API por primera vez, un valor predeterminado de Brightcove Player se genera en su cuenta. Ese player el objeto es para que usted lo haga como usted elija. Puede usarlo como está, cambiar su configuración, rediseñarlo o agregar complementos. Puede elegir usar solo el valor predeterminado de Brightcove Player con sus personalizaciones, o puede optar por crear otro players para capturar diferentes looks y configuraciones para diferentes ubicaciones en su sitio web.

    Visión general de publicación

    Una de las características de la Player El sistema de administración es la capacidad de separar los cambios que desea probar de la versión de su player que se publica públicamente Tanto en la interfaz de usuario como en la API, cuando realiza cambios en un playerEn la configuración, los cambios están disponibles de inmediato a través de las versiones preliminares de player. Estas versiones preliminares son totalmente utilizables y comprobables. Puede compartir la URL de vista previa para su aprobación o trabajar en el player vista previa hasta que esté satisfecho con los cambios, todo antes de publicar el player para ponerlo a disposición del público.

    Actualizar cascadas

    Publicando un player tiene consecuencias que pueden afectar al niño players. Aquí hay detalles sobre la publicación:

    • A player publicar desencadena una nueva publicación de todos los elementos secundarios player instancias creadas a partir de eso player.
    • Un niño player publicar afecta solo a ese niño player.
    • Una actualización de plantilla predeterminada de Brightcove (controlada por Brightcove) activará una nueva publicación de todos players, y el player volver a publicar activará una nueva publicación de todos los elementos secundarios players creado a partir de cada player.

    La configuración se aplica de manera ganadora. Esto significa que la configuración en el nivel secundario tendrá prioridad sobre los cambios realizados en el nivel principal. Considera lo siguiente:

    • La plantilla predeterminada define un valor CSS para ser rojo.
    • A player define el mismo valor CSS para que sea blanco.
    • Un niño player define el mismo valor CSS para que sea azul.

    Como el niño gana, los resultados serían:

    • El playerEl valor de CSS es blanco.
    • El niño playerEl valor de CSS es azul.

    Este comportamiento de herencia se puede cambiar si el tipo de datos de la propiedad es una matriz. los Campos de matriz La sección de la Guía de API de inserción describe los detalles.

    Opciones de configuración

    Para crear un player más avanzado que solo el predeterminado player, Debe proporcionar un Configuración del jugador. La configuración se define usando JSON.

    Límite de velocidad

    El Player Management API tiene límite de velocidad por cada IP única habilitada. Los siguientes son los límites de la tarifa:

    tipo de solicitud <div style="margin-top:15px">Límite</div>
    Publicar y crear (players e incrustaciones) Solicitudes 60 / minuto
    Leer (GET) Solicitudes 600 / minuto
    Escribir (POST, PUT, PATCH y DELETE) Solicitudes 300 / minuto
    Vista previa del jugador Solicitudes 100 / minuto

    Códigos de estado de respuesta

    Los mensajes / códigos de respuesta y error se basan en aquellos definido por W3. Algunos de los códigos más comunes son:

    • 200 Solicitar éxito
    • 201 Creo un player, una configuración)
    • 400 Petición incorrecta: la sintaxis de la llamada API es probablemente incorrecta
    • 401 Autenticación inválida: verifique si la contraseña se ingresó correctamente o si siguió el Instrucciones de OAuth correctamente
    • 404 No encontrado: compruebe si el recurso existe y la URL utilizada en la llamada API es correcta
    • 429Excede el límite de velocidad
    • 500 Error interno del servidor: hubo un error al intentar completar la solicitud

    Página actualizada por última vez el 13 Oct 2020