Справочник · Файлове

Данни за файл

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."
  }
}