Referensi · File

Lihat file

GET /v1/files/{uid}

Menampilkan satu file berdasarkan uid, beserta ukuran, resolusi, URL file asli, dan playlist yang memuat file tersebut.

Parameter path

Nama	Jenis	Deskripsi
`uid`	`string`	uid file.

Field respons

uid string: ID file.
name string: Nama file di panel kontrol.
type string: Jenis file, seperti image atau video.
duration integer: Durasi, dalam detik.
archived boolean: true jika file diarsipkan.
organization object: Organisasi file: uid dan name.
size integer: Ukuran file asli, dalam byte.
width integer: Lebar file asli, dalam piksel.
height integer: Tinggi file asli, dalam piksel.
aspect_ratio string: Rasio antara lebar dan tinggi, seperti 1.78.
url string: URL file asli, atau string kosong jika tidak tersedia.
scheduled boolean: true jika file memiliki penjadwalan aktif.
playlists array: Playlist yang memuat file ini (uid, name, dan organization). Hanya playlist yang dapat dilihat pengguna yang ditampilkan.

Kemungkinan error

404 not_found Endpoint tidak ada, atau item tidak ada atau milik organisasi yang tidak dapat dilihat pengguna.
Error kunci dan batas permintaan berlaku untuk semua endpoint. Lihat semua error

PermintaancURLPHPJavaScript

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

Respons200

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

Item tidak ada atau tanpa akses404

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