# API REST para plataformas OTT | Vodlix **Source:** https://vodlix.com/pt/features/restful-api **Summary:** Controle sua plataforma de streaming via código. Gerencie vídeos, séries, canais ao vivo, artes e listas de conteúdo com uma API que cobre a área admin. **Publisher:** Vodlix --- ## API RESTful Tenha uma API REST poderosa e segura para integrar rapidamente, automatizar processos e agilizar fluxos de trabalho. - **Feature Plan:** 2 - core-platform - back-end ## API REST para sua plataforma de streaming Controle catálogo, artes, canais ao vivo, merchandising e relatórios por meio de uma API REST que espelha a área administrativa. A chamada «Add New Video» na documentação da API da plataforma em um notebook, com o mesmo título aberto em um app de celular Documentação da API de “Update Content Thumbs”, que define as artes retrato, paisagem e logo de um título a partir de URLs de imagens ### Artes e canais ao vivo via API Pela API da Vodlix, as artes são associadas por URL em vez de enviadas manualmente. Uma chamada define as imagens retrato, paisagem e logo de um título, e outra escolhe qual quadro gerado serve como miniatura. Os canais ao vivo são tratados como vídeos: criados a partir de uma URL de stream, atualizados, publicados ou despublicados, enviados para a lixeira ou restaurados, então o conteúdo linear é automatizado da mesma forma que o sob demanda. Para um catálogo grande ou que muda com frequência, isso mantém as artes consistentes sem que ninguém precise enviar arquivos um a um. #### API REST Familiar e previsível. #### Espelha o admin Se você conhece a interface, conhece a API. #### Ciclo de vida completo Criar, publicar, despublicar, restaurar. Documentação da API de “Upload with URL”, que ingere um vídeo a partir da URL de um arquivo em armazenamento público, S3 ou Wasabi ### Gerencie o catálogo de forma programática A API REST da Vodlix permite controlar o catálogo de forma programática, espelhando a área administrativa. Os vídeos podem ser criados, atualizados, publicados ou despublicados, enviados para a lixeira ou restaurados. Séries e temporadas são criadas, atualizadas e publicadas da mesma forma, e os episódios são vinculados a uma temporada ou desvinculados dela. Novos vídeos são ingeridos informando à plataforma a URL de um arquivo, pública ou no seu próprio armazenamento S3 ou Wasabi: ela busca e processa o arquivo em segundo plano e retorna um ID de vídeo para acompanhamento. Para operadores OTT com sistemas existentes, a gestão do catálogo pode ser automatizada em vez de feita manualmente. Página inicial da loja com as fileiras “Top 10” e “Rent the Latest”, listas de conteúdo que uma chamada de API pode ativar e desativar ### Merchandising e listas de conteúdo sob controle da API A API da Vodlix dá a você controle sobre o merchandising: listas de conteúdo, grupos de listas, seus itens e sua ordem podem ser criados e gerenciados de forma programática. As listas podem ser ativadas e desativadas, então uma fileira sazonal é desligada por uma chamada de API em vez de ser reconstruída. Isso permite que sistemas de programação e ferramentas de planejamento de conteúdo montem a página inicial automaticamente. É o merchandising sob controle da API que permite escalar os fluxos editoriais. - mx-auto Tabela de ferramentas do MCP Access com informações da plataforma, contagens de conteúdo e usuários, navegação pelo catálogo e um resumo de vendas ### Endpoints de referência e relatórios A API da Vodlix oferece chamadas de referência e relatórios: IDs de categoria, contagens de catálogo e de usuários, um resumo de vendas para qualquer intervalo de datas e detalhes da plataforma, como a versão do software. As integrações sempre sabem com o que estão trabalhando e podem se adaptar a mudanças na plataforma. O acesso funciona com chaves de API criadas no admin: uma chave de servidor para tarefas de back-end e uma chave de cliente para código no navegador, que nunca consegue acessar rotas administrativas. As mesmas chamadas são expostas a assistentes de IA pelo conector MCP da plataforma. ### Onde ela costuma se pagar Os casos mais comuns são migração, ingestão e relatórios. Transferir um catálogo de outra plataforma vira um trabalho da API em vez de manual, e essa é a diferença entre um lançamento que não depende de ninguém e outro que leva meses. A ingestão recorrente de um distribuidor ou de um fluxo de produção roda sem supervisão depois de escrita. Os relatórios levam os números para as ferramentas que sua equipe financeira já usa, em vez de pedir que alguém exporte uma tela toda segunda-feira. Ela também conecta sua plataforma ao restante do seu negócio. Envie um novo título para o seu CMS e o seu site de marketing no momento em que ele for publicado, ou passe suas [listas de conteúdo](/pt/features/content-lists) para um serviço de recomendação e grave os resultados de volta. Quando uma integração precisa de mais do que a API oferece sozinha, nosso [serviço de plugins personalizados](/pt/services/custom-plugin) desenvolve a peça que falta na mesma plataforma. Os dados de analytics ficam disponíveis pela API quando há um serviço de estatísticas configurado na sua nuvem, algo que vale a pena confirmar durante a implantação em vez de descobrir depois. A página de [relatórios e analytics](/pt/features/reports-and-analytics) mostra o que é medido. **Q: O que a API REST da Vodlix pode controlar?** A API REST da Vodlix controla o catálogo, incluindo vídeos, séries, temporadas e episódios, além de artes, canais ao vivo, listas de conteúdo e merchandising, e dados de referência e relatórios. **Q: Faço upload de arquivos de vídeo pela API da Vodlix?** Novos vídeos são ingeridos pela API da Vodlix informando uma URL HTTPS pública. A Vodlix busca e transcodifica o arquivo, para que você não precise transmitir uploads binários pela sua própria infraestrutura. **Q: A API da Vodlix corresponde à área administrativa?** Sim. A API REST da Vodlix espelha a área administrativa, com convenções REST conhecidas e respostas previsíveis, então quem conhece a interface sabe mais ou menos o que a API pode fazer. **Q: Posso gerenciar listas de conteúdo pela API da Vodlix?** Sim. As listas de conteúdo, os grupos de listas, seus itens e sua ordem na Vodlix podem ser criados, atualizados, ativados e desativados pela API, para que o merchandising possa ser automatizado. **Q: Quais dados de relatórios a API da Vodlix fornece?** A API da Vodlix fornece contagens de catálogo e de usuários, um resumo de vendas para um intervalo de datas, IDs de categoria e detalhes da plataforma, como a versão do software, para que as integrações sempre saibam com o que estão trabalhando. **Q: Os IDs de categoria são os mesmos em todas as nuvens Vodlix?** Não, e esse é o erro mais comum. As categorias são específicas de cada nuvem, então leia a lista de categorias da plataforma com que você está trabalhando e use os IDs que ela retorna, em vez de supor que um nome corresponde ao mesmo número em todo lugar. **Q: Podemos obter analytics pela API?** Sim, quando há um serviço de estatísticas configurado na sua nuvem, cobrindo os principais números, a atividade em tempo real e o conteúdo de melhor desempenho. Vale confirmar isso durante a implantação, porque ele é provisionado separadamente das operações de catálogo. **Q: A API é útil para migrar de outra plataforma?** É um dos motivos mais comuns para os operadores a usarem. Transferir um catálogo de forma programática transforma a migração em um processo repetível em vez de meses de cadastro manual, e ela pode ser executada novamente para capturar tudo o que mudou durante a transferência. **Q: Como as integrações se autenticam na API da Vodlix?** Com uma chave de API criada no admin em “Apps & APIs” e enviada no cabeçalho X-Api-Key. Uma chave de servidor age com as permissões do usuário a quem pertence e pode acessar rotas administrativas, por isso deve ficar em um back-end. Uma chave de cliente é segura para código no navegador e é bloqueada em todas as rotas administrativas. As chaves podem ter data de expiração, e excluir uma chave a revoga imediatamente.