Autenticação

Autentique cada requisição com uma chave de API secreta no cabeçalho Authorization.

Toda requisição precisa de uma chave de API, enviada como bearer token:

Authorization: Bearer vu_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Quem pode usar a API

A API é para contas pagas: contas que compraram um pacote de créditos ou fizeram uma assinatura. Contas gratuitas não podem criar chaves de API, e toda requisição de uma conta que nunca pagou retorna 403:

{
  "error": {
    "code": "paid_plan_required",
    "message": "The API is available to accounts that have bought credits or subscribed. See https://videoupscaler.co/pricing"
  }
}

Compre qualquer pacote de créditos na página de preços para liberar o acesso. O acesso continua ativo depois que você gasta os créditos; a partir daí basta recarregar.

Como obter uma chave

Crie chaves em Configurações → Chaves de API. Você pode ter até 20 chaves ativas, por exemplo uma por servidor ou ambiente. A página mostra o nome de cada chave, os primeiros e últimos caracteres dela e quando foi usada pela última vez.

A chave completa é exibida apenas uma vez, no momento da criação. Guardamos só um hash dela, então não conseguimos mostrá-la de novo. Se você perder uma chave, exclua-a e crie outra.

Como manter suas chaves seguras

  • Uma chave gasta os créditos da sua conta. Trate-a como uma senha.
  • Chame a API a partir do seu servidor. Nunca coloque uma chave em um navegador, app mobile ou repositório público.
  • Leia a chave de uma variável de ambiente, como VIDEOUPSCALER_API_KEY.
  • Se uma chave vazar, exclua-a em Configurações. Ela para de funcionar na hora.

Erros

Uma chave ausente, malformada ou excluída retorna 401:

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key. Send it as \"Authorization: Bearer vu_live_...\"."
  }
}