Referencia · Fájlok

Fájl lekérése

Visszaadja egy fájl adatait uid alapján: a méretét, a felbontását, az eredeti fájl címét és azokat a lejátszási listákat, amelyekben szerepel.

Útvonalparaméter

A válasz mezői

uid string

A fájl azonosítója.

name string

A fájl neve a vezérlőpulton.

type string

A fájl típusa, például image vagy video.

duration integer

Időtartam másodpercben.

archived boolean

true, ha a fájl archivált.

organization object

A fájl szervezete: uid és name.

size integer

Az eredeti fájl mérete bájtban.

width integer

Az eredeti fájl szélessége pixelben.

height integer

Az eredeti fájl magassága pixelben.

aspect_ratio string

A szélesség és a magasság aránya, például 1.78.

url string

Az eredeti fájl címe, vagy üres szöveg, ha nem érhető el.

scheduled boolean

true, ha a fájlnak aktív ütemezése van.

playlists array

Azok a lejátszási listák, amelyekben a fájl szerepel (uid, name és organization). Csak a felhasználó számára látható listák jelennek meg.

Lehetséges hibák

• 404 not_found A végpont nem létezik, vagy az elem nem létezik, illetve olyan szervezethez tartozik, amelyet a felhasználó nem láthat.
• A kulccsal és a kéréskorláttal kapcsolatos hibák minden végpontra vonatkoznak. Az összes hiba megtekintése

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

{
  "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"
        }
      }
    ]
  }
}

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