Nueva API RESTful de retransmisión en directo para emisoras y desarrolladores

New RESTful Live Streaming API for Broadcasters and Developers

En Dacast, estamos orgullosos de anunciar oficialmente que la versión 2 de nuestra API Live Streaming está disponible. Esta API RESTful JSON se ha diseñado específicamente para integrar de forma rápida y sencilla todas las funciones de la plataforma de servicios de streaming Dacast en una amplia variedad de aplicaciones de vídeo en la nube, servicios y flujos de trabajo de medios digitales.

En este blog, pretendemos introducirle en el concepto de API, explicarle lo que ahora puede construir utilizando nuestra API de retransmisión en directo y presentarle algunos de los comandos básicos que puede utilizar para manipular sus datos con esta herramienta. Al final de esta entrada también te ofrecemos un enlace a nuestra documentación y más recursos para aprender.

¿Qué es una API?

API significa Interfaz de Programación de Aplicaciones. Una interfaz de programación de aplicaciones es un medio simplificado para enviar y recuperar datos de un sistema informático complejo,en este caso, la red de alojamiento de vídeo y la plataforma de gestión de Dacast.

Una API funciona mediante un sistema de operaciones, entradas, salidas y tipos de datos subyacentes que están estandarizados en toda la plataforma. Así se crea un “lenguaje” común (nuestra API utiliza el formato JSON) con comandos y URL predecibles que los programadores pueden utilizar para crear sus propios métodos de interacción con sus datos almacenados en otra red dentro de una plataforma propietaria.

Los datos de la plataforma cambiarán, y Dacast podrá seguir añadiendo nuevas funciones e iterando sobre nuestras tecnologías, pero el lenguaje de la API seguirá siendo el mismo, con una o dos nuevas llamadas añadidas para permitir a los usuarios aprovechar las nuevas capacidades sin interrumpir las aplicaciones y servicios creados sobre la API existente.

En la práctica, una API permite a los usuarios de Dacast personalizar casi todos los aspectos de la experiencia de visualización y configurar manualmente sus propios métodos para cargar, renombrar, mover, etiquetar, acceder y gestionar de cualquier otro modo los contenidos en la plataforma Dacast.

La nueva API Dacast Live Streaming: Versión 2

La versión 2 de la API de transmisión en directo de Dacast amplía las funciones de la versión 1, de modo que nuestros usuarios avanzados y clientes empresariales pueden ahora utilizar todas las funciones de Dacast sin tener que iniciar sesión en sus cuentas de Dacast. Este lanzamiento proporciona a nuestros usuarios aún más poder sobre sus contenidos y, creemos, es una razón de peso para considerar el uso de nuestra Live Streaming API”.

Las empresas y organizaciones que busquen un control y una personalización totales pueden llegar a crear su propia plataforma de transmisión de vídeo basada en el backend de Dacast. A menor escala, cualquiera puede utilizar nuestra Live Streaming API para acceder fácilmente a los datos, extraer información de su cuenta, cargar y editar información a través de un dispositivo remoto, codificar una aplicación, etc.

Funciones de la API de transmisión en directo de Dacast

Las funciones incluidas en la API de retransmisión en directo de Dacast son demasiado numerosas para enumerarlas en su totalidad, pero he aquí algunas de las más destacadas.

Escribir archivos y canales

Nuestra Live Streaming API le permite publicar vídeos en su canal de streaming directamente dentro de sus propias aplicaciones o plataformas. Esto le permite crear un flujo de trabajo racionalizado que puede coexistir con las plataformas de software actuales. También puede crear y cargar vídeos para su visualización a la carta dentro de la API de transmisión en directo sin necesidad de utilizar el sitio web de Dacast.

Leer archivos y canales

Del mismo modo, la Live Streaming API permite controlar también la visualización de sus contenidos. Esto le permite programar interfaces personalizadas para mostrar su vídeo en dispositivos únicos y en situaciones inaccesibles de otro modo. Puede, por ejemplo, incluso codificar su propia aplicación móvil que se puede distribuir a los usuarios como un eje central para ver su contenido de streaming a la carta y en directo dentro de un entorno controlado por la marca.

También puedes utilizar comandos de lectura para descargar fácilmente información de tu cuenta, como crear una lista de todos los vídeos ordenados por su duración o la fecha en que se subieron.

Crear nuevas cuentas (y administradores)

Con nuestra Live Streaming API, incluso las tareas de gestión más mundanas, como la distribución y el control de acceso a su cuenta, no requieren que utilice directamente la plataforma Dacast. En su lugar, esto puede hacerse mediante aplicaciones personalizadas o a través de terminales de línea de comandos para agilizar sus flujos de trabajo. También incluye la gestión del control de acceso a las cuentas y el suministro de credenciales a los nuevos usuarios.

Funciones para revendedores

Los distribuidores de valor añadido (VAR) de Dacast adquieren planes de acceso a nuestra plataforma de alojamiento de vídeo y luego la revenden en pequeñas porciones a otros clientes. Gracias a nuestra Live Streaming API, los VAR pueden crear ahora su propia plataforma de transmisión de vídeo en directo para que la utilicen sus clientes. Esta plataforma puede llevar la marca que se desee, sin necesidad de utilizar la plataforma, el nombre o el logotipo de Dacast, y contará con todas las funciones de Dacast disponibles para nuestros usuarios.

Acceso de lectura y escritura a la monetización

También puede utilizar nuestra Live Streaming API para controlar los ajustes de monetización. Por ejemplo, configure la monetización de los nuevos vídeos sobre la marcha, a medida que se emiten en directo y se suben los vídeos. También puede acceder a los datos de monetización y cambiar la configuración de los vídeos existentes desde la API de retransmisión en directo.

Acceso analítico

Dacast mantiene un conjunto de análisis detallados para el seguimiento de la información y el rendimiento sobre quién está viendo su contenido, durante cuánto tiempo, desde qué lugares, etc.

La API permite acceder a los datos analíticos en bruto, para que pueda codificar sus propias visualizaciones personalizadas, seleccionar las métricas más relevantes y recopilar la información más importante para sus operaciones. Estos datos pueden ser esenciales para tomar decisiones informadas sobre marketing y ajustar el enfoque de futuros contenidos.

Publicar en un portal

Nuestra API de transmisión en directo le permite crear fácilmente sus propios portales de vídeo o audio para un acceso personalizado a sus contenidos, sin necesidad de utilizar un reproductor de vídeo o una infraestructura de Dacast. En lugar de eso, simplemente extraiga su contenido en su portal personalizado según sea necesario.

Acceso a la transcodificación de archivos

Uno de los elementos más potentes del sistema Dacast es la capacidad de transcodificar archivos en la nube a los formatos necesarios para llegar a la audiencia deseada. La nueva API de retransmisión en directo proporciona acceso directo a la potente arquitectura de servidor que subyace a este proceso, lo que le permite implementar ajustes de contenido personalizados y entregar a sus espectadores los archivos multimedia precisos que elija.

Controles de listas de reproducción y paquetes

La plataforma de Dacast incluye la posibilidad de crear listas de reproducción de contenidos que pueden incrustarse y reproducirse secuencialmente. Los paquetes, que suelen utilizarse para crear una colección de contenidos que pueden monetizarse por una única cuota de suscripción o pago por visión, son otra opción para agrupar contenidos.

Ambas opciones de agrupación pueden crearse, editarse y controlarse a través de la nueva versión 2 de la API Live Streaming.

Mejoras de rendimiento

Nuestras mejoras en la API de retransmisión en directo también han aumentado el rendimiento de la plataforma en general. Ahora, las solicitudes de datos y las operaciones se llevarán a cabo de forma más eficiente y rápida, proporcionando una experiencia de usuario más ágil y una mayor productividad.

Reproductores de vídeo personalizados

La nueva Live Streaming API también permite el acceso completo a la API del reproductor de vídeo de Dacast, por lo que puede personalizar nuestro reproductor de vídeo de marca blanca o incluso desarrollar su propia solución para que coincida con la marca, el estilo o las necesidades de funciones de su organización. Los reproductores personalizados pueden ser compatibles con vídeo HTML5 o Flash, admitir sistemas DRM avanzados y optimizar el SEO con metadatos y etiquetas.

Los reproductores de vídeo personalizados también permiten la integración con plataformas de terceros para la captura de correo electrónico, avisos de toma de acción, publicidad y otras formas de monetización, y plataformas de análisis como Google Analytics, ComScore y otras.

Arquitectura de la API de transmisión en directo de Dacast

Las API modernas que se dedican a editar y controlar el contenido que se encuentra en otra red suelen utilizar un estándar puede REST -o Representational State Transfer- para garantizar que los datos se comunican de forma sólida entre el cliente y la plataforma.

La nueva API de Dacast Live Streaming es RESTful, lo que significa que se puede acceder a ella desde cualquier servidor o aplicación cliente de su elección. Esto también significa que puede utilizar cualquier lenguaje de programación de su elección para interactuar con la API. Todo lo que importa es la capacidad de hacer peticiones HTTP GET y POST y manejar respuestas en formato JSON.

Conceptos básicos de la API

Los comandos de la API de Dacast Live Streaming se dividen en nueve categorías que cubren todas las funciones de Dacast. Estas categorías son:

  1. Vídeo a la carta
  2. Canal en directo
  3. Lista de reproducción
  4. Paquete
  5. Preferencias
  6. Analítica
  7. Información sobre la cuenta
  8. Información al público
  9. Lista de errores

Cada una de estas categorías contiene una lista completa de comandos para manipular e interactuar con la plataforma Dacast. Dentro de cada categoría, las subcategorías ayudan a delinear qué comandos afectan a qué parte de su operación. Para cada comando, los parámetros le permiten personalizar sus peticiones.

Comandos de canal en directo

Por ejemplo, la categoría “Canal en directo” incluye cuatro subcategorías. Estos son:

  • 2.1 – Operaciones básicas
  • 2.2 – Operaciones tarifarias
  • 2.3 – Operaciones con cupones
  • 2.4 – Operaciones analíticas (que contiene operaciones amortizadas que ya no se utilizan en la versión 2 de nuestra Live Streaming API)

Cada una de estas categorías incluye una lista de operaciones diseñadas para editar e interactuar con sus datos. Por ejemplo, esta es una lista de los comandos que se encuentran en la sección 2.1 – Operaciones básicas.

  • GET /v2/channel (Lista de canales de su cuenta)
  • POST /v2/channel (Crear un nuevo canal)
  • DELETE /v2/channel/{channel_id} (Borrar un canal)
  • GET /v2/channel/{channel_id} (Obtener detalles del canal)
  • PUT /v2/channel/{channel_id} (Actualizar detalles del canal)
  • GET /v2/channel/{channel_id}/embed/{embed_type} (Obtener el código de inserción del canal)
  • DELETE /v2/channel/{channel_id}/splash (Borrar pantalla de bienvenida personalizada)
  • POST /v2/channel/{channel_id}/splash (Cargar pantalla Splash personalizada)
  • GET /v2/channel/{channel_id}/startstream (Obtener detalles del canal)
  • DELETE /v2/channel/{channel_id}/thumbnail (Eliminar miniaturas personalizadas)
  • POST /v2/channel/{channel_id}/thumbnail (Cargar miniatura personalizada)
  • POST /v2/channel/{channel_id}/xml (Obtener XML del canal)

Parámetros de mando

La mayoría de estos comandos también tienen una serie de parámetros diferentes que se pueden utilizar para devolver los datos en un orden diferente o personalizar la información de otras maneras.

Comando de canal GET

Por ejemplo, el primer comando devuelve una lista de todos los canales en directo de su cuenta. Para enviar este operador a Dacast, basta con introducir una URL en el navegador (o en un terminal o una aplicación conectada a la web). La URL completa de este comando básico sería: http://api.dacast.com/v2/channel?apikey={your_apikey}.

Este comando puede personalizarse utilizando tres parámetros. La primera, “ordenar”, le permite elegir un orden ascendente o descendente para organizar los resultados. El segundo parámetro, “ordenar por”, elige la métrica por la que se ordenarán los resultados. Por ejemplo, puede ordenar por título de la A a la Z con los siguientes parámetros: http://api.dacast.com/v2/channel?apikey={your_apikey}&order_by=title&sort=DSC.

El tercer parámetro es el filtro, que (como su nombre indica) permite filtrar por atributos más específicos. Por ejemplo, puede filtrar su lista para que sólo contenga secuencias que tengan un determinado nombre, fecha de creación, configuración de pago por visión, duración, etc. Este parámetro se añade utilizando una serie de etiquetas que se enumeran en su totalidad en la documentación enlazada a continuación.

Comando PUT Channel Details

Por ejemplo, el comando de actualización de los detalles del canal contiene una serie de parámetros que permiten cambiar todos los ajustes relacionados con un canal determinado. (Nota: para editar estos parámetros, necesitará el número de ID del canal, que puede encontrar utilizando el primer comando GET Channel).

Los ajustes que se pueden personalizar utilizando este comando incluyen:

  • Título del canal
  • Descripción
  • Categoría
  • Estado en línea (activar o desactivar el canal)
  • Contador de espectadores en directo (permite activar o desactivar un contador que muestra el número de personas que ven tu canal, y establecer el umbral para mostrar este contador).
  • Google Analytics (activar o desactivar el seguimiento de Google Analytics para este canal)
  • Reproducción automática (activar o desactivar)
  • Publicar en Dacast (activar o desactivar la publicación en el portal Dacast)
  • Página de vídeo externa (la URL de la página web en la que publicará su canal)
  • Contraseña (le permite proteger su canal con una contraseña)
  • Referrers ID (código ID de la lista de remitentes que se aplicará a este canal)
  • Countries ID (código de identificación de la lista de países que desea que tengan acceso a su canal)
  • Theme ID (aplicar un tema personalizado al reproductor de vídeo Dacast)
  • ID de tamaño del reproductor (permite establecer el tamaño de la ventana del reproductor de vídeo mediante preajustes comunes)
  • Anchura y altura del reproductor (permite tamaños de reproductor de vídeo personalizados)
  • NoFrame Security (activar o desactivar la seguridad del marco)
  • Splashscreen ID (permite configurar pantallas de bienvenida personalizadas o elegir las predeterminadas de Dacast)
  • Identificación de miniaturas (permite establecer miniaturas personalizadas o elegir las predeterminadas de Dacast)
  • Datos personalizados (un campo que puede utilizarse para almacenar y recuperar metadatos)

Recursos API

Para obtener más información sobre la nueva API de Dacast Live Streaming, puede consultar nuestra documentación completa aquí. Si ya ha iniciado sesión en su cuenta de Dacast, también podrá encontrar este recurso en el menú Ayuda.

Para generar una clave API, necesaria para utilizar la API, puede visitar el panel de preferencias Clave API en el back office de Dacast. Una vez que haya generado una clave API, visite la página de documentación e introdúzcala en el campo de la parte superior de la página.

En este punto, la página de documentación se puede utilizar como una caja de arena para probar varios comandos de la API y aprender la plataforma. Para probar un comando determinado utilizando su cuenta, haga clic en una operación determinada y, a continuación, en la pestaña “sandbox” situada en la parte superior de la documentación del comando. En esta página, puede probar el comando sin afectar a los datos de su cuenta.

Primeros pasos con la API de transmisión en directo de Dacast

Estamos muy entusiasmados con la nueva API de transmisión en directo de Dacast, y sabemos que muchos de nuestros clientes también. Creemos que proporciona una nueva y potente forma de controlar sus datos y debería permitir a nuestros usuarios exportar nuestra tecnología a su propia plataforma. Si tiene algún plan interesante para utilizar la API de retransmisión en directo, póngase en contacto con nosotros: nos encantaría conocerlo y, posiblemente, publicarlo en nuestro blog.

Si ya son usuarios de Dacast y tienen problemas con nuestra API de retransmisión en directo, envíen un correo electrónico a support@dacast.com con su clave de API, la llamada a la API que realizaron, las respuestas o mensajes de error que recibieron y el momento en que se produjo el error. Nos pondremos en contacto con usted lo antes posible.

Gracias por leerme.

El futuro de la retransmisión de vídeo en directo

Max Wilbert

Max Wilbert is a passionate writer, live streaming practitioner, and has strong expertise in the video streaming industry.