Arayış · Fayllar

Fayla baxış

GET /v1/files/{uid}

Faylı uid üzrə qaytarır: ölçüsü, eni və hündürlüyü, orijinal faylın ünvanı və faylın daxil olduğu pleylistlər ilə birlikdə.

Yol parametri

Ad	Növ	Təsvir
`uid`	`string`	Faylın uid identifikatoru.

Cavab sahələri

uid string: Fayl identifikatoru.
name string: Faylın idarəetmə panelindəki adı.
type string: Faylın növü, məsələn, image və ya video.
duration integer: Müddət, saniyə ilə.
archived boolean: Fayl arxivləşdirilibsə, true.
organization object: Faylın şirkəti: uid və name.
size integer: Orijinal faylın ölçüsü, baytla.
width integer: Orijinal faylın eni, piksellə.
height integer: Orijinal faylın hündürlüyü, piksellə.
aspect_ratio string: En ilə hündürlüyün nisbəti, məsələn, 1.78.
url string: Orijinal faylın ünvanı və ya fayl əlçatan deyilsə, boş mətn.
scheduled boolean: Faylın aktiv cədvəli varsa, true.
playlists array: Faylın daxil olduğu pleylistlər (uid, name və organization). Yalnız istifadəçinin görə bildiyi pleylistlər göstərilir.

Mümkün xətalar

404 not_found Endpoint mövcud deyil, ya da element mövcud deyil və ya istifadəçinin görə bilmədiyi şirkətə aiddir.
Açar və limit xətaları bütün endpointlərə aiddir. Bütün xətalara bax

SorğucURLPHPJavaScript

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

Cavab200

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

Mövcud olmayan və ya girişi olmayan element404

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