O que é a Vimeo API?
A API do Vimeo é uma interface de programação automatizada que permite aos usuários enviar vídeos para a plataforma Vimeo por meio de seus próprios aplicativos. Essa funcionalidade também permite gerenciar vídeos e incorporá-los aos seus recursos na web.
Como obter a chave API do Vimeo
- Passo 1 – Criar uma conta
Para obter acesso às ferramentas para desenvolvedores do Vimeo, é necessário ter uma conta cadastrada no serviço. Se já for membro da plataforma, vá direto para o Passo 2. Caso contrário, acesse o site de desenvolvedores do Vimeo e clique em Desenvolvedores do Vimeo.
Você pode criar um novo perfil usando seu e-mail ou continuar com sua conta do Google.
Em seguida, você será convidado a especificar como deseja usar o vídeo do Vimeo.
Se não souber o que escolher ou não quiser compartilhar esse tipo de informação, você pode clicar em Pular.
Depois disso, você será direcionado para a página com as Informações de preços do Vimeo, onde poderá ver os planos e recursos oferecidos, experimentar uma demonstração ou escolher o plano certo para você.
- Passo 2 – Acesse o portal de desenvolvedores
Depois de criar uma conta, acesse o portal de desenvolvedores e clique no botão Começar.
- Etapa 3 – Crie e cadastre seu aplicativo
Em seguida, você verá um formulário que precisa preencher para criar o seu app.
Depois de registrar seu aplicativo, você precisa adicionar algumas informações a ele para gerar seu token de acesso.
Clique em Configurações, adicione a descrição curta e um link para o site ativo do seu projeto, e salve as alterações.
- Etapa 4 – Gerar token de acesso
Depois de inserir todas as informações necessárias, você poderá gerar seus tokens de acesso para fazer chamadas à API Vimeo.
Clique em Gerar Token de Acesso ou role a página até a seção de Autenticação.
Marque a categoria do token de acesso que precisa criar. Existem 2 opções disponíveis – Autenticado e Não Autenticado. Se você marcar a caixa Autenticado, deverá especificar os escopos que deseja acessar. Ao passar o mouse sobre cada opção você verá uma dica rápida.
Se quiser ter acesso aos seus dados privados, mantenha desmarada a opção Criar token não autenticado.Caso precise ter acesso aos seus dados privados, não escolha a opção Criar token sem autenticação. O tipo de token de autorização determina quem são os usuários finais de um aplicativo. Optar por um token sem autenticação faz do proprietário do app o usuário final.
Após clicar no botão Gerar, o novo token é exibido na tabela de Tokens de Acesso Pessoal abaixo.
Recomendamos fortemente copiar a string do token e mantê-la em um local seguro. Lembre-se de que um token perdido não pode ser recuperado, mas você pode gerar um novo a qualquer momento.Como usar a API do Vimeo
Esta é uma API RESTful. Isso significa que os parâmetros da API do Vimeo seguem princípios e práticas REST para interagir com recursos online — neste caso, vídeos — usando métodos HTTP padrão, como GET, POST e PATCH.
Para começar a trabalhar com a API do Vimeo, primeiro é necessário registrar seu aplicativo e gerar um token de acesso para ele. Em seguida, pode ser necessário configurar um ambiente de desenvolvimento para conexão e interação com a API. O Vimeo oferece suporte oficial para quase uma dúzia de ambientes de desenvolvimento. Você pode encontrar a lista completa na página de Bibliotecas e SDKs. Depois disso, você pode começar a fazer chamadas à API do Vimeo para garantir que tudo esteja configurado corretamente.
Exemplos de API do Vimeo
API do Player Vimeo
Há também a opção de usar uma solução similar à API do player Vimeo, chamada Player SDK. Isso permite que o usuário interaja com o player do Vimeo por meio do código da sua página. É possível modificar o player de vídeo da Vimeo API padrão em termos de recursos como autoplay, looping, eventos de reprodução e até dimensões do player na tela e cores dos controles.
O Player SDK – uma biblioteca JavaScript – é independente da API. As opções de conexão são diferentes, e a solução oferece uma variedade de opções. Você pode aprender mais sobre incorporar vídeo usando esta ferramenta em esta seção de documentação.
Se você quer ter controle total sobre vídeos do Vimeo incorporados no seu site, experimente um widget do Vimeo Player pronto para uso no seu site!
API de Incorporação Vimeo
Você pode incorporar vídeos da plataforma Vimeo usando o padrão aberto oEmbed, em vez da API. É uma maneira fácil de colocar vídeos do Vimeo em sites externos. Ao obter uma URL especial que corresponde ao conteúdo que você quer incorporar, você recebe informações detalhadas sobre esse conteúdo com um elemento <iframe> incorporável.
Este padrão oEmbed é separado das soluções da API do Vimeo, e não é necessário obter autenticação da API do Vimeo para usar esta função.Vimeo Upload API
A API do Vimeo oferece um conjunto completo de funcionalidades para enviar e gerenciar arquivos de vídeo. Usando esta solução, é possível acessar as capacidades de envio do Vimeo através do front-end da sua própria aplicação. Para isso, você precisa de um token de acesso com os escopos de envio e edição. Além disso, observe que, para que um aplicativo possa enviar vídeos para o Vimeo, é necessário ativar o acesso de envio — essa opção não está habilitada por padrão.
Para habilitar o acesso de upload, faça o seguinte:- Visite a página Meus Apps.
- Clique no seu app para abrir a página de informações.
- Encontre a seção Acesso de Upload no menu Informações Gerais e clique no link Solicitar Acesso de Upload.
- Ofereça várias respostas sobre o seu app da API do Vimeo.
- Clique na opção Solicitar Acesso de Upload.
Últimas mudanças na API e limites
A documentação oferece informações detalhadas sobre as versões da Vimeo API e as mudanças implementadas. Na seção de Alterações da Vimeo API estão descritas as versões 3.0 a 3.4 – que é a versão atual da interface de programação.
A API do Vimeo impõe limites de taxa – isto significa o número máximo de chamadas que seu app pode fazer à API por minuto. Se qualquer usuário exceder esse limite, a plataforma Vimeo coloca o app em cooldown para esse usuário. Em seguida, o usuário precisa aguardar até que o limite seja redefinido para poder fazer novas solicitações pelo app.
A quantidade de chamadas que um usuário pode realizar por minuto depende do tipo de assinatura do Vimeo. Veja o número detalhado de chamadas na tabela abaixo.
A filiação do usuário final Solicitações de API por minuto (por usuário) Vimeo Básico 25 Vimeo Plus 125 Vimeo PRO 250 Vimeo Business 500 Vimeo Premium 750 Vimeo Enterprise Responda rapidamente e com cuidado a comentários ou dúvidas. A plataforma Vimeo contabiliza todas as solicitações como se viessem do proprietário de um aplicativo não autenticado, mesmo que sejam geradas por vários usuários. O período de espera do aplicativo é ativado se o total de chamadas de API exceder o limite correspondente ao nível de assinatura do proprietário do aplicativo.Documentação da API do Vimeo
FAQ
O Vimeo tem uma API?
Sim, as soluções da API do Vimeo são abertas e públicas e estão disponíveis para qualquer membro do serviço, independentemente do seu nível de assinatura.
Como obter a API de desenvolvedor do Vimeo?
A API do Vimeo é pública e a única coisa que você precisa fazer para obtê-la é criar uma conta no Vimeo e escolher o tipo de assinatura que deseja manter. Isso permite criar aplicações no portal de desenvolvedores do Vimeo.
Como encontro minha chave de API do Vimeo?
A chave no formato de token de acesso é gerada pelo próprio usuário, após ele ter criado e registrado seu aplicativo na seção My Apps do site de desenvolvedores do Vimeo.
Como obter um token de acesso do Vimeo?
Primeiro, crie sua aplicação e depois vá para a seção Gerar Token de Acesso na página de informações da sua aplicação. Lá você poderá especificar o tipo de token de que precisa e copiá-lo após o procedimento de geração. Para mais informações, consulte nosso artigo acima.
Como incorporar o Vimeo no meu site?
Adicione um player Vimeo personalizado ao seu site usando a API, oEmbed ou a opção Player SDK. Também há uma opção para experimentar apps prontos para usar e personalizáveis fornecidos pela Elfsight, por exemplo.
