Atsauce · Faili

Iegūt vienu failu

GET /v1/files/{uid}

Atgriež failu pēc uid ar tā izmēru, izšķirtspēju, oriģinālā faila adresi un atskaņošanas sarakstiem, kuros tas ir iekļauts.

Ceļa parametrs

Nosaukums	Tips	Apraksts
`uid`	`string`	Faila uid.

Atbildes lauki

uid string: Faila identifikators.
name string: Faila nosaukums vadības panelī.
type string: Faila tips, piemēram, image vai video.
duration integer: Ilgums sekundēs.
archived boolean: true, ja fails ir arhivēts.
organization object: Faila organizācija: uid un name.
size integer: Oriģinālā faila izmērs baitos.
width integer: Oriģinālā faila platums pikseļos.
height integer: Oriģinālā faila augstums pikseļos.
aspect_ratio string: Platuma un augstuma attiecība, piemēram, 1.78.
url string: Oriģinālā faila adrese vai tukša virkne, ja fails nav pieejams.
scheduled boolean: true, ja failam ir aktīvs grafiks.
playlists array: Atskaņošanas saraksti, kuros ir šis fails (uid, name un organization). Tiek rādīti tikai tie saraksti, kurus lietotājs var redzēt.

Iespējamās kļūdas

404 not_found Galapunkts neeksistē, vai arī vienums neeksistē vai pieder organizācijai, kuru lietotājs nevar redzēt.
Atslēgas un ierobežojumu kļūdas attiecas uz visiem galapunktiem. Skatīt visas kļūdas

PieprasījumscURLPHPJavaScript

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

Atbilde200

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

Vienums neeksistē vai nav piekļuves404

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