Referenca · Datoteke

Podrobnosti datoteke

GET /v1/files/{uid}

Vrne datoteko glede na uid, skupaj z velikostjo, ločljivostjo, naslovom izvirne datoteke in seznami predvajanja, na katerih je.

Parameter poti

Ime	Vrsta	Opis
`uid`	`string`	uid datoteke.

Polja odgovora

uid string: Identifikator datoteke.
name string: Ime datoteke na nadzorni plošči.
type string: Vrsta datoteke, na primer image ali video.
duration integer: Trajanje v sekundah.
archived boolean: true, če je datoteka arhivirana.
organization object: Organizacija datoteke: uid in name.
size integer: Velikost izvirne datoteke v bajtih.
width integer: Širina izvirne datoteke v slikovnih pikah.
height integer: Višina izvirne datoteke v slikovnih pikah.
aspect_ratio string: Razmerje med širino in višino, na primer 1.78.
url string: Naslov izvirne datoteke ali prazen niz, če ni na voljo.
scheduled boolean: true, če ima datoteka aktiven urnik.
playlists array: Seznami predvajanja, na katerih je datoteka (uid, name in organization). Prikazani so samo seznami predvajanja, ki jih uporabnik lahko vidi.

Možne napake

404 not_found Končna točka ne obstaja ali pa element ne obstaja oziroma pripada organizaciji, ki je uporabnik ne more videti.
Napake ključa in omejitve zahtev veljajo za vse končne točke. Prikaži vse napake

ZahtevacURLPHPJavaScript

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

Odgovor200

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

Element ne obstaja ali ni dostopa404

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