Տեղեկատու · Ֆայլեր

Ֆայլի տվյալներ

GET /v1/files/{uid}

Ցույց է տալիս ֆայլը ըստ դրա uid արժեքի, ներառյալ չափը, լուծաչափը, բնօրինակ ֆայլի հասցեն և այն փլեյլիստները, որոնցում այն ներառված է։

Ուղու պարամետր

ԱնունՏեսակՆկարագրություն
uidstringՖայլի 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 Վերջնակետը գոյություն չունի, կամ տարրը գոյություն չունի կամ պատկանում է կազմակերպության, որը օգտատերը չի կարող տեսնել։
  • Բանալու և սահմանաչափի սխալները վերաբերում են բոլոր վերջնակետերին։ Տեսնել բոլոր սխալները
Հարցում
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."
  }
}