Лавлах · Файлууд

Нэг файл харах

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