Reference · Soubory

Detail souboru

Vrací soubor podle uid včetně velikosti, rozlišení, adresy původního souboru a playlistů, ve kterých je zařazen.

Parametr v cestě

Pole odpovědi

uid string

Identifikátor souboru.

name string

Název souboru v ovládacím panelu.

type string

Typ souboru, například image nebo video.

duration integer

Délka v sekundách.

archived boolean

true, pokud je soubor archivovaný.

organization object

Organizace souboru: uid a name.

size integer

Velikost původního souboru v bajtech.

width integer

Šířka původního souboru v pixelech.

height integer

Výška původního souboru v pixelech.

aspect_ratio string

Poměr šířky a výšky, například 1.78.

url string

Adresa původního souboru, nebo prázdný řetězec, pokud není k dispozici.

scheduled boolean

true, pokud má soubor aktivní plánování.

playlists array

Playlisty, ve kterých je soubor zařazen (uid, name a organization). Zobrazují se jen playlisty, které uživatel může vidět.

Možné chyby

• 404 not_found Endpoint neexistuje, případně položka neexistuje nebo patří organizaci, kterou uživatel nemůže vidět.
• Chyby klíče a limitu platí pro všechny endpointy. Zobrazit všechny chyby

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."
  }
}