Referencja · Pliki

Szczegóły pliku

GET /v1/files/{uid}

Zwraca plik o podanym uid wraz z rozmiarem, rozdzielczością, adresem oryginalnego pliku i playlistami, w których się znajduje.

Parametr ścieżki

NazwaTypOpis
uidstringuid pliku.

Pola odpowiedzi

uid string
Identyfikator pliku.
name string
Nazwa pliku w panelu sterowania.
type string
Typ pliku, np. image lub video.
duration integer
Czas trwania w sekundach.
archived boolean
true, jeśli plik jest zarchiwizowany.
organization object
Organizacja pliku: uid i name.
size integer
Rozmiar oryginalnego pliku w bajtach.
width integer
Szerokość oryginalnego pliku w pikselach.
height integer
Wysokość oryginalnego pliku w pikselach.
aspect_ratio string
Stosunek szerokości do wysokości, np. 1.78.
url string
Adres oryginalnego pliku lub pusty ciąg, jeśli nie jest dostępny.
scheduled boolean
true, jeśli plik ma aktywny harmonogram.
playlists array
Playlisty, w których znajduje się plik (uid, name i organization). Wyświetlane są tylko playlisty, które użytkownik może widzieć.

Możliwe błędy

  • 404 not_found Endpoint nie istnieje albo element nie istnieje lub należy do organizacji, której użytkownik nie może widzieć.
  • Błędy klucza i limitu dotyczą wszystkich endpointów. Zobacz wszystkie błędy
Żądanie
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();
Odpowiedź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"
        }
      }
    ]
  }
}
Element nie istnieje lub brak dostępu404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}