Анықтамалық · Файлдар

Файлды көру

GET /v1/files/{uid}

Файлды uid бойынша қайтарады: өлшемі, ажыратымдылығы, түпнұсқа файлдың мекенжайы және файл кіретін ойнату тізімдері.

Жолдағы параметр

Атауы	Түрі	Сипаттамасы
`uid`	`string`	Файлдың uid идентификаторы.

Жауап өрістері

uid string: Файл идентификаторы.
name string: Файлдың басқару панеліндегі атауы.
type string: Файл түрі, мысалы, image немесе video.
duration integer: Ұзақтығы, секундпен.
archived boolean: Файл мұрағатталған болса, true.
organization object: Файлдың ұйымы: uid және name.
size integer: Түпнұсқа файлдың өлшемі, байтпен.
width integer: Түпнұсқа файлдың ені, пиксельмен.
height integer: Түпнұсқа файлдың биіктігі, пиксельмен.
aspect_ratio string: Ені мен биіктігінің арақатынасы, мысалы, 1.78.
url string: Түпнұсқа файлдың мекенжайы немесе ол қолжетімсіз болса, бос мәтін.
scheduled boolean: Файлдың белсенді кестесі болса, true.
playlists array: Файл кіретін ойнату тізімдері (uid, name және organization). Тек пайдаланушы көре алатын тізімдер көрсетіледі.

Болуы мүмкін қателер

404 not_found Эндпоинт жоқ, не элемент жоқ немесе ол пайдаланушы көре алмайтын ұйымға тиесілі.
Кілт пен шектеу қателері барлық эндпоинттерге қатысты. Барлық қателерді көру

СұранысcURLPHPJavaScript

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

Жауап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"
        }
      }
    ]
  }
}

Жоқ немесе қолжетімсіз элемент404

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