Referencia · Súbory

Detail súboru

GET /v1/files/{uid}

Vráti súbor podľa uid vrátane veľkosti, rozlíšenia, adresy pôvodného súboru a playlistov, v ktorých je zaradený.

Parameter v ceste

Názov	Typ	Popis
`uid`	`string`	uid súboru.

Polia odpovede

uid string: Identifikátor súboru.
name string: Názov súboru v ovládacom paneli.
type string: Typ súboru, napríklad image alebo video.
duration integer: Dĺžka v sekundách.
archived boolean: true, ak je súbor archivovaný.
organization object: Organizácia súboru: uid a name.
size integer: Veľkosť pôvodného súboru v bajtoch.
width integer: Šírka pôvodného súboru v pixeloch.
height integer: Výška pôvodného súboru v pixeloch.
aspect_ratio string: Pomer šírky a výšky, napríklad 1.78.
url string: Adresa pôvodného súboru, alebo prázdny reťazec, ak nie je k dispozícii.
scheduled boolean: true, ak má súbor aktívne plánovanie.
playlists array: Playlisty, v ktorých je súbor zaradený (uid, name a organization). Zobrazujú sa iba playlisty, ktoré používateľ môže vidieť.

Možné chyby

404 not_found Endpoint neexistuje, prípadne položka neexistuje alebo patrí organizácii, ktorú používateľ nemôže vidieť.
Chyby kľúča a limitu platia pre všetky endpointy. Zobraziť všetky chyby

PožiadavkacURLPHPJavaScript

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

Odpoveď200

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

Neexistujúca položka alebo bez prístupu404

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