Referencia · Ficheiros

Ver un ficheiro

Devolve un ficheiro a partir do seu uid, co tamaño, a resolución, o enderezo do ficheiro orixinal e as listas de reprodución nas que está.

Parámetro da ruta

Campos da resposta

uid string

Identificador do ficheiro.

name string

Nome do ficheiro no panel.

type string

Tipo de ficheiro, como image ou video.

duration integer

Duración, en segundos.

archived boolean

true se o ficheiro está arquivado.

organization object

Organización do ficheiro: uid e name.

size integer

Tamaño do ficheiro orixinal, en bytes.

width integer

Largura do ficheiro orixinal, en píxeles.

height integer

Altura do ficheiro orixinal, en píxeles.

aspect_ratio string

Proporción entre largura e altura, como 1.78.

url string

Enderezo do ficheiro orixinal, ou un texto baleiro se non está dispoñible.

scheduled boolean

true se o ficheiro ten unha programación activa.

playlists array

Listas de reprodución nas que está o ficheiro (uid, name e organization). Só aparecen as listas que o usuario pode ver.

Erros posibles

• 404 not_found O endpoint non existe, ou ben o elemento non existe ou pertence a unha organización que o usuario non pode ver.
• Os erros de chave e de límite aplícanse 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."
  }
}