Nova API RESTful de transmissão em direto para organismos de radiodifusão e programadores

Aqui na Dacast, temos o orgulho de anunciar oficialmente que a versão 2 da nossa API de transmissão em direto está disponível. Esta API RESTful JSON foi concebida especificamente para uma integração rápida e fácil de todas as funcionalidades da plataforma de serviço de transmissão em fluxo contínuo Dacast numa grande variedade de aplicações de vídeo em nuvem, serviços e fluxos de trabalho de meios digitais.

Neste blogue, pretendemos apresentar-lhe o conceito de API, explicar o que pode agora construir utilizando a nossa API Live Streaming e apresentar alguns dos comandos básicos que pode utilizar para manipular os seus dados com esta ferramenta. No final desta publicação, fornecemos também uma hiperligação para a nossa documentação e mais recursos para aprendizagem.

O que é uma API?

API significa Interface de Programação de Aplicações. Uma interface de programação de aplicações é um meio simplificado de enviar e recuperar dados de um sistema informático complexo –neste caso, a rede de alojamento de vídeo e a plataforma de gestão Dacast.

Uma API funciona através de um sistema de operações, entradas, saídas e tipos de dados subjacentes que são normalizados em toda a plataforma. Isto cria uma “linguagem” comum (a nossa API utiliza o formato JSON) utilizando comandos e URL previsíveis que os programadores podem utilizar para criar os seus próprios métodos de interação com os dados armazenados noutra rede dentro de uma plataforma proprietária.

Os dados da plataforma mudarão e a Dacast pode continuar a acrescentar novas funcionalidades e a inovar nas nossas tecnologias, mas a linguagem da API permanecerá a mesma, com uma ou duas novas chamadas adicionadas para permitir que os utilizadores aproveitem as novas capacidades sem perturbar as aplicações e os serviços criados com base na API existente.

Na prática, uma API permite que os utilizadores do Dacast personalizem quase todos os aspectos da experiência de visualização e configurem manualmente os seus próprios métodos de carregamento, renomeação, movimentação, marcação, acesso e gestão de conteúdos na plataforma Dacast.

A nova API de transmissão em direto do Dacast: Versão 2

A versão 2 da API de transmissão em direto da Dacast expande as funcionalidades fornecidas pela versão 1, pelo que os nossos utilizadores avançados e clientes empresariais podem agora utilizar todas as funcionalidades da Dacast sem terem de iniciar sessão nas suas contas Dacast. Esta versão oferece aos nossos utilizadores ainda mais poder sobre o seu conteúdo e, acreditamos, é uma razão convincente para considerar a utilização da nossa API de transmissão em direto.

As empresas e organizações que procuram controlo e personalização totais podem ir até ao ponto de criar a sua própria plataforma de transmissão de vídeo com base no backend Dacast. Numa escala mais pequena, qualquer pessoa pode utilizar a nossa API de transmissão em direto para aceder facilmente aos dados, obter informações da sua conta, carregar e editar informações através de um dispositivo remoto, codificar uma aplicação, etc.

Características da API de transmissão em direto do Dacast

As funcionalidades incluídas na API de transmissão em direto do Dacast são demasiado numerosas para serem enumeradas na íntegra, mas eis alguns dos destaques.

Escrever ficheiros e canais

A nossa API de transmissão em direto permite-lhe publicar vídeos no seu canal de transmissão diretamente nas suas próprias aplicações ou plataformas. Isto permite-lhe criar um fluxo de trabalho simplificado que pode coexistir com as actuais plataformas de software. Também pode criar e carregar vídeos para visualização a pedido através da API de transmissão em direto, sem necessidade de utilizar o sítio Web do Dacast.

Ler ficheiros e canais

Do mesmo modo, a API Live Streaming permite também o controlo da visualização dos seus conteúdos. Isto permite-lhe programar interfaces personalizadas para apresentar o seu vídeo em dispositivos únicos e em situações de outra forma inacessíveis. Pode, por exemplo, até codificar a sua própria aplicação móvel, que pode ser distribuída aos utilizadores como um hub central para visualizar os seus conteúdos a pedido e em direto num ambiente controlado pela marca.

Também pode utilizar comandos de leitura para descarregar facilmente informações da sua conta, como criar uma lista de todos os vídeos ordenados pela sua duração ou pela data em que foram carregados.

Criar novas contas (e administradores)

Com a nossa API de transmissão em direto, mesmo as tarefas de gestão mais comuns, como a distribuição e o controlo do acesso à sua conta, não requerem a utilização direta da plataforma Dacast. Em vez disso, isto pode ser feito através de aplicações personalizadas ou através de terminais de linha de comandos para simplificar os seus fluxos de trabalho. Isto também inclui a gestão do controlo de acesso à conta e o fornecimento de credenciais a novos utilizadores.

Funcionalidade de revendedor

Os revendedores de valor acrescentado (VAR) da Dacast adquirem planos de acesso à nossa plataforma de alojamento de vídeo e revendem-na em pequenas quantidades a outros clientes. Graças à nossa API de transmissão em direto, os VARs podem agora criar a sua própria plataforma de transmissão de vídeo em direto para os seus clientes utilizarem. Esta plataforma pode ter a marca que desejar, sem necessidade de utilizar a plataforma, o nome ou o logótipo da Dacast, e incluirá todas as funcionalidades da Dacast que estão disponíveis para os nossos utilizadores.

Acesso de leitura e escrita à monetização

Também pode utilizar a nossa API de transmissão em direto para controlar as definições de monetização. Por exemplo, configurar a monetização para novos vídeos em tempo real, à medida que as transmissões são efectuadas e os vídeos são carregados. Também pode aceder aos dados de monetização e alterar as definições dos vídeos existentes a partir da API de transmissão em direto.

Acesso à análise

O Dacast mantém um conjunto de análises pormenorizadas para acompanhar as informações e o desempenho de quem está a ver o seu conteúdo, durante quanto tempo, a partir de que locais, etc.

A API permite o acesso a dados analíticos em formato bruto, para que possa codificar os seus próprios ecrãs personalizados, selecionar as métricas mais relevantes e recolher as informações mais importantes para as suas operações. Estes dados podem ser essenciais para tomar decisões informadas sobre marketing e ajustar a sua abordagem a conteúdos futuros.

Publicar num portal

A nossa API de transmissão em direto permite-lhe criar facilmente os seus próprios portais de vídeo ou áudio para acesso personalizado ao seu conteúdo, sem necessidade de utilizar um leitor de vídeo ou uma infraestrutura Dacast. Em vez disso, basta puxar o seu conteúdo para o seu portal personalizado, conforme necessário.

Acesso à Transcodificação de Ficheiros

Um dos elementos mais poderosos do sistema Dacast é a capacidade de transcodificar ficheiros na nuvem para os formatos necessários para chegar ao público pretendido. A nova API de transmissão em direto fornece acesso direto à poderosa arquitetura de servidor subjacente a este processo, permitindo-lhe implementar definições de conteúdo personalizadas e fornecer aos seus espectadores os ficheiros multimédia exactos da sua escolha.

Controlos de listas de reprodução e pacotes

A plataforma da Dacast inclui a capacidade de criar listas de reprodução de conteúdos que podem ser incorporados e reproduzidos sequencialmente. Os pacotes, que são normalmente utilizados para criar uma coleção de conteúdos que podem ser rentabilizados por uma única subscrição ou taxa de pagamento por visualização, são outra opção para agrupar conteúdos.

Ambas as opções de agrupamento podem ser criadas, editadas e controladas através da nova API de transmissão em direto da versão 2.

Melhorias de desempenho

As nossas melhorias na API de transmissão em direto também aumentaram o desempenho da plataforma em geral. Agora, os pedidos de dados e as operações serão realizados de forma mais eficiente e rápida, proporcionando uma experiência de utilizador mais ágil e uma maior produtividade.

Reprodutores de vídeo personalizados

A nova API de transmissão em direto também permite o acesso total à API do leitor de vídeo Dacast, para que possa personalizar o nosso leitor de vídeo de marca branca ou mesmo desenvolver a sua própria solução para corresponder à marca, estilo ou necessidades de funcionalidades da sua organização. Os leitores personalizados podem suportar vídeo HTML5 ou Flash, suportar sistemas DRM avançados e otimizar a SEO com metadados e etiquetas.

Os leitores de vídeo personalizados também permitem a integração com plataformas de terceiros para a captura de correio eletrónico, avisos de ação, publicidade e outras formas de monetização, bem como plataformas de análise como o Google Analytics, ComScore e outras.

Arquitetura da API de transmissão em direto do Dacast

As API modernas que se dedicam a editar e controlar o conteúdo localizado noutra rede utilizam frequentemente um padrão REST – ou Representational State Transfer – para garantir que os dados são comunicados de forma robusta entre o cliente e a plataforma.

A nova API de transmissão em direto do Dacast é RESTful, o que significa que pode ser acedida a partir de qualquer servidor adequado ou aplicação do lado do cliente à sua escolha. Isto também significa que pode utilizar qualquer linguagem de programação à sua escolha para interagir com a API. Tudo o que é importante é a capacidade de efetuar pedidos HTTP GET e POST e de tratar as respostas no formato JSON.

Noções básicas de API

Os comandos da API de transmissão em direto do Dacast estão divididos em nove categorias que abrangem todas as funcionalidades do Dacast. Estas categorias são:

1. Vídeo a pedido
2. Canal em direto
3. Lista de reprodução
4. Embalagem
5. Preferências
6. Analítica
7. Informações sobre a conta
8. Informação ao público
9. Lista de erros

Cada uma destas categorias contém uma lista completa de comandos para manipular e interagir com a plataforma Dacast. Dentro de cada categoria, as subcategorias ajudam a delinear quais os comandos que afectam cada parte da sua operação. Para cada comando, os parâmetros permitem-lhe personalizar os seus pedidos.

Comandos de canais em direto

Por exemplo, a categoria “Canal em direto” inclui quatro subcategorias. Estes são:

• 2.1 – Operações básicas
• 2.2 – Operações de taxas
• 2.3 – Operações com cupões
• 2.4 – Operações analíticas (que contém operações depreciadas que já não são utilizadas na versão 2 da nossa API de transmissão em direto)

Cada uma destas categorias inclui uma lista de operações concebidas para editar e interagir com os seus dados. Por exemplo, aqui está uma lista dos comandos encontrados na secção 2.1 – Operações básicas.

• GET /v2/channel (Lista de canais na sua conta)
• POST /v2/channel (Criar um novo canal)
• DELETE /v2/channel/{channel_id} (Eliminar um canal)
• GET /v2/channel/{channel_id} (Obter pormenores do canal)
• PUT /v2/channel/{channel_id} (Atualizar os detalhes do canal)
• OBTER /v2/channel/{channel_id}/embed/{embed_type} (Obter o código de incorporação do canal)
• DELETE /v2/channel/{channel_id}/splash (Eliminar o ecrã inicial personalizado)
• POST /v2/channel/{channel_id}/splash (Carregar ecrã Splash personalizado)
• GET /v2/channel/{channel_id}/startstream (Obter pormenores do canal)
• DELETE /v2/channel/{channel_id}/thumbnail (Eliminar miniatura personalizada)
• POST /v2/channel/{channel_id}/thumbnail (Carregar miniatura personalizada)
• POST /v2/channel/{channel_id}/xml (Obter XML do canal)

Parâmetros de comando

A maioria destes comandos também tem uma série de parâmetros diferentes que podem ser utilizados para devolver dados numa ordem diferente ou personalizar a informação de outras formas.

Comando GET Channel

Por exemplo, o primeiro comando devolve uma lista de todos os canais em direto da sua conta. Para enviar este operador ao Dacast, basta introduzir um URL no seu navegador (ou num terminal ou numa aplicação ligada à Web). O URL completo para este comando básico seria: http://api.dacast.com/v2/channel?apikey={your_apikey}.

Este comando pode ser personalizado através de três parâmetros. A primeira, “ordenar”, permite-lhe escolher uma ordem ascendente ou descendente para organizar os seus resultados. O segundo parâmetro, “order by”, escolhe a métrica pela qual os resultados serão ordenados. Por exemplo, pode ordenar por título de A a Z com os seguintes parâmetros: http://api.dacast.com/v2/channel?apikey={your_apikey}&order_by=title&sort=DSC.

O terceiro parâmetro é o filtro, que (como o nome indica) permite filtrar por atributos mais específicos. Por exemplo, pode filtrar a sua lista para conter apenas fluxos que tenham um determinado nome, data de criação, definição de pagamento por visualização, duração, etc. Este parâmetro é adicionado utilizando uma variedade de etiquetas listadas na documentação abaixo.

Comando PUT Detalhes do canal

Como outro exemplo, o comando atualizar detalhes do canal contém um número de parâmetros que lhe permitem alterar todas as definições relacionadas com um determinado canal. (Nota: para editar estes parâmetros, é necessário o número de ID do canal, que pode ser encontrado utilizando o primeiro comando GET Channel).

As definições que podem ser personalizadas com este comando incluem:

• Título do canal
• Descrição
• Categoria
• Estado online (ligar ou desligar o canal)
• Contador em direto (permite ativar ou desativar um contador que apresenta o número de pessoas que vêem o seu canal e definir o limite para a apresentação deste contador)
• Google Analytics (ativar ou desativar o acompanhamento do Google Analytics para este canal)
• Reprodução automática (ativar ou desativar)
• Publicar no Dacast (ativar ou desativar a publicação no portal Dacast)
• Página de vídeo externa (o URL da página Web em que irá publicar o seu canal)
• Palavra-passe (permite-lhe proteger o seu canal com uma palavra-passe)
• ID de referenciadores (código de ID da lista de referenciadores a aplicar a este canal)
• ID dos países (código de ID da lista de países que pretende que tenham acesso ao seu canal)
• ID do tema (aplicar um tema personalizado ao leitor de vídeo Dacast)
• ID do tamanho do leitor (permite-lhe definir o tamanho da janela do leitor de vídeo utilizando predefinições comuns)
• Largura e altura do leitor (permite tamanhos personalizados do leitor de vídeo)
• Segurança NoFrame (ativar ou desativar a segurança da moldura)
• ID do ecrã inicial (permite definir ecrãs iniciais personalizados ou escolher as predefinições do Dacast)
• ID da miniatura (permite definir miniaturas personalizadas ou escolher as predefinições do Dacast)
• Dados personalizados (um campo que pode ser utilizado para armazenar e recuperar metadados)

Recursos da API

Para saber mais sobre a nova API Dacast Live Streaming, pode consultar a nossa documentação completa encontrada aqui. Se já tiver iniciado sessão na sua conta Dacast, este recurso também pode ser encontrado no menu Ajuda.

Para gerar uma chave de API, necessária para utilizar a API, pode visitar o painel de preferências Chave de API no back office do Dacast. Depois de gerar uma chave de API, visite a página de documentação e introduza-a no campo na parte superior da página.

Nesta altura, a página de documentação pode ser utilizada como uma caixa de areia para testar vários comandos da API e aprender a plataforma. Para testar um determinado comando utilizando a sua conta, clique numa determinada operação e, em seguida, clique no separador “caixa de areia” na parte superior da documentação do comando. Nesta página, pode testar o comando sem afetar os dados da sua conta.

Introdução à API de transmissão em direto do Dacast

Estamos muito entusiasmados com a nova API de transmissão em direto da Dacast, e sabemos que muitos dos nossos clientes também estão. Acreditamos que proporciona uma nova e poderosa forma de controlar os seus dados e deverá permitir aos nossos utilizadores exportar a nossa tecnologia para a sua própria plataforma. Se tiver um plano interessante para utilizar a API de transmissão em direto, entre em contacto connosco – adoraríamos saber mais e possivelmente apresentar a história no nosso blogue!

Se já é utilizador do Dacast e tem problemas com a nossa API de transmissão em direto, envie uma mensagem de correio eletrónico para support@dacast.com com a sua chave de API, a chamada de API que efectuou, as respostas ou mensagens de erro que recebeu e a hora em que ocorreu o erro. Entraremos em contacto consigo o mais rapidamente possível!

Obrigado pela leitura!