Referência · Ficheiros

Ver um ficheiro

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

Parâmetro no endereço

Campos da resposta

uid string

Identificador do ficheiro.

name string

Nome do ficheiro no painel.

type string

Tipo de ficheiro, como image ou video.

duration integer

Duração, em segundos.

archived boolean

true se o ficheiro estiver arquivado.

organization object

Empresa do ficheiro: uid e name.

size integer

Tamanho do ficheiro original, em bytes.

width integer

Largura do ficheiro original, em píxeis.

height integer

Altura do ficheiro original, em píxeis.

aspect_ratio string

Proporção entre a largura e a altura, como 1.78.

url string

Endereço do ficheiro original, ou texto vazio se não estiver disponível.

scheduled boolean

true se o ficheiro tiver um agendamento ativo.

playlists array

Listas de reprodução em que o ficheiro está incluído (uid, name e organization). Só aparecem as listas que o utilizador pode ver.

Erros possíveis

• 404 not_found O endpoint não existe, ou o item não existe ou pertence a uma empresa que o utilizador não pode ver.
• Os erros de chave e de limite aplicam-se a todos os endpoints. Ver todos os erros

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();

{
  "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"
        }
      }
    ]
  }
}

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