Tham chiếu · Tệp

Xem một tệp

GET /v1/files/{uid}

Trả về một tệp theo uid, kèm kích thước, độ phân giải, URL của tệp gốc và các danh sách phát có chứa tệp.

Tham số trong đường dẫn

Tên	Loại	Mô tả
`uid`	`string`	uid của tệp.

Các trường của phản hồi

uid string: Mã định danh của tệp.
name string: Tên tệp trong bảng điều khiển.
type string: Loại tệp, ví dụ image hoặc video.
duration integer: Thời lượng, tính bằng giây.
archived boolean: true nếu tệp đã được lưu trữ.
organization object: Tổ chức của tệp: uid và name.
size integer: Kích thước của tệp gốc, tính bằng byte.
width integer: Chiều rộng của tệp gốc, tính bằng pixel.
height integer: Chiều cao của tệp gốc, tính bằng pixel.
aspect_ratio string: Tỷ lệ giữa chiều rộng và chiều cao, ví dụ 1.78.
url string: URL của tệp gốc, hoặc chuỗi rỗng nếu không có sẵn.
scheduled boolean: true nếu tệp có lịch phát đang hoạt động.
playlists array: Các danh sách phát có chứa tệp (uid, name và organization). Chỉ hiển thị các danh sách phát mà người dùng được xem.

Các lỗi có thể gặp

404 not_found Endpoint không tồn tại, hoặc mục không tồn tại hay thuộc một tổ chức mà người dùng không được xem.
Lỗi về khóa và giới hạn yêu cầu áp dụng cho mọi endpoint. Xem tất cả lỗi

Yêu cầ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();

Phản hồi200

{
  "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ục không tồn tại hoặc không có quyền truy cập404

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