Referenco · Dosieroj

Vidi dosieron

GET /v1/files/{uid}

Montras dosieron laŭ ĝia uid, kun la grandeco, la distingivo, la adreso de la originala dosiero kaj la ludlistoj, en kiuj ĝi estas.

Parametro en la vojo

NomoTipoPriskribo
uidstringuid de la dosiero.

Kampoj de la respondo

uid string
Identigilo de la dosiero.
name string
Nomo de la dosiero en la kontrolpanelo.
type string
Tipo de la dosiero, ekzemple image aŭ video.
duration integer
Daŭro, en sekundoj.
archived boolean
true se la dosiero estas arĥivita.
organization object
Organizaĵo de la dosiero: uid kaj name.
size integer
Grandeco de la originala dosiero, en bajtoj.
width integer
Larĝo de la originala dosiero, en pikseloj.
height integer
Alto de la originala dosiero, en pikseloj.
aspect_ratio string
Proporcio inter larĝo kaj alto, ekzemple 1.78.
url string
Adreso de la originala dosiero, aŭ malplena teksto se ĝi ne disponeblas.
scheduled boolean
true se la dosiero havas aktivan horarigon.
playlists array
Ludlistoj, en kiuj la dosiero estas (uid, name kaj organization). Aperas nur la ludlistoj, kiujn la uzanto povas vidi.

Eblaj eraroj

  • 404 not_found La finpunkto ne ekzistas, aŭ la ero ne ekzistas aŭ apartenas al organizaĵo, kiun la uzanto ne povas vidi.
  • La eraroj pri ŝlosilo kaj limo validas por ĉiuj finpunktoj. Vidi ĉiujn erarojn
Peto
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();
Respondo200
{
  "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"
        }
      }
    ]
  }
}
Neekzistanta ero aŭ sen aliro404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}