Referência · Arquivos

Ver um arquivo

GET /v1/files/{uid}

Mostra um arquivo pelo uid, com o tamanho, a resolução, o endereço do arquivo original e as listas de reprodução em que ele está.

Parâmetro no endereço

Nome	Tipo	Descrição
`uid`	`string`	uid do arquivo.

Campos da resposta

uid string: Identificador do arquivo.
name string: Nome do arquivo no painel.
type string: Tipo do arquivo, como image ou video.
duration integer: Duração, em segundos.
archived boolean: true se o arquivo está arquivado.
organization object: Empresa do arquivo: uid e name.
size integer: Tamanho do arquivo original, em bytes.
width integer: Largura do arquivo original, em pixels.
height integer: Altura do arquivo original, em pixels.
aspect_ratio string: Proporção entre largura e altura, como 1.78.
url string: Endereço do arquivo original, ou texto vazio se não estiver disponível.
scheduled boolean: true se o arquivo tem um agendamento ativo.
playlists array: Listas de reprodução em que o arquivo está (uid, name e organization). Só aparecem as listas que o usuário pode ver.

Erros possíveis

404 not_found O endpoint não existe, ou o item não existe ou é de uma empresa que o usuário não pode ver.
Os erros de chave e de limite valem para todos os endpoints. Ver todos os erros

RequisiçãocURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Resposta200

{
  "data": {
    "uid": "a87ff679a2f3e71d9181a67b7542122c",
    "name": "Promoção de verão",
    "type": "video",
    "duration": 30,
    "archived": false,
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "size": 18734520,
    "width": 1920,
    "height": 1080,
    "aspect_ratio": "1.78",
    "url": "https://oncloud.bunny.files.on-cloud.live/files/a87ff679a2f3e71d9181a67b7542122c-1.mp4",
    "scheduled": true,
    "playlists": [
      {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}

Item que não existe ou sem acesso404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}