Referință · Fișiere

Detaliile unui fișier

GET /v1/files/{uid}

Returnează un fișier după uid, cu dimensiunea, rezoluția, URL-ul fișierului original și playlisturile în care se află.

Parametru în cale

Nume	Tip	Descriere
`uid`	`string`	uid-ul fișierului.

Câmpurile răspunsului

uid string: Identificatorul fișierului.
name string: Numele fișierului în panoul de control.
type string: Tipul fișierului, de exemplu image sau video.
duration integer: Durata, în secunde.
archived boolean: true dacă fișierul este arhivat.
organization object: Organizația fișierului: uid și name.
size integer: Dimensiunea fișierului original, în octeți.
width integer: Lățimea fișierului original, în pixeli.
height integer: Înălțimea fișierului original, în pixeli.
aspect_ratio string: Raportul dintre lățime și înălțime, de exemplu 1.78.
url string: URL-ul fișierului original sau text gol dacă nu este disponibil.
scheduled boolean: true dacă fișierul are o programare activă.
playlists array: Playlisturile în care se află fișierul (uid, name și organization). Apar doar playlisturile pe care utilizatorul le poate vedea.

Erori posibile

404 not_found Endpointul nu există sau elementul nu există ori aparține unei organizații pe care utilizatorul nu o poate vedea.
Erorile de cheie și de limită se aplică tuturor endpointurilor. Vedeți toate erorile

CererecURLPHPJavaScript

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

Răspuns200

{
  "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 inexistent sau fără acces404

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