Viiteopas · Tiedostot

Hae tiedosto

GET /v1/files/{uid}

Palauttaa yhden tiedoston tunnisteen uid perusteella: koon, resoluution, alkuperäisen tiedoston osoitteen ja soittolistat, joissa tiedosto on.

Polkuparametri

Nimi	Tyyppi	Kuvaus
`uid`	`string`	Tiedoston uid.

Vastauksen kentät

uid string: Tiedoston tunniste.
name string: Tiedoston nimi ohjauspaneelissa.
type string: Tiedostotyyppi, esimerkiksi image tai video.
duration integer: Kesto sekunteina.
archived boolean: true, jos tiedosto on arkistoitu.
organization object: Tiedoston organisaatio: uid ja name.
size integer: Alkuperäisen tiedoston koko tavuina.
width integer: Alkuperäisen tiedoston leveys pikseleinä.
height integer: Alkuperäisen tiedoston korkeus pikseleinä.
aspect_ratio string: Leveyden ja korkeuden suhde, esimerkiksi 1.78.
url string: Alkuperäisen tiedoston osoite tai tyhjä merkkijono, jos tiedosto ei ole saatavilla.
scheduled boolean: true, jos tiedostolla on aktiivinen ajastus.
playlists array: Soittolistat, joissa tiedosto on (uid, name ja organization). Mukana ovat vain soittolistat, jotka käyttäjä voi nähdä.

Mahdolliset virheet

404 not_found Päätepistettä ei ole olemassa, tai kohdetta ei ole olemassa tai se kuuluu organisaatiolle, jota käyttäjä ei näe.
Avaimeen ja pyyntörajaan liittyvät virheet koskevat kaikkia päätepisteitä. Näytä kaikki virheet

PyyntöcURLPHPJavaScript

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

Vastaus200

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

Kohdetta ei ole tai siihen ei ole oikeutta404

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