Довідник · Файли

Дані файлу

GET /v1/files/{uid}

Повертає файл за uid: розмір, роздільну здатність, URL-адресу оригінального файлу та плейлисти, до яких він входить.

Параметр шляху

Назва	Тип	Опис
`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: URL-адреса оригінального файлу або порожній рядок, якщо вона недоступна.
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."
  }
}