Referanse · Filer

Hent én fil

GET /v1/files/{uid}

Viser en fil ut fra uid, med størrelse, oppløsning, URL-en til originalfilen og spillelistene filen ligger i.

Stiparameter

Navn	Type	Beskrivelse
`uid`	`string`	uid for filen.

Felter i svaret

uid string: Filens ID.
name string: Filens navn i kontrollpanelet.
type string: Filtype, for eksempel image eller video.
duration integer: Varighet i sekunder.
archived boolean: true hvis filen er arkivert.
organization object: Filens organisasjon: uid og name.
size integer: Størrelsen på originalfilen i byte.
width integer: Bredden på originalfilen i piksler.
height integer: Høyden på originalfilen i piksler.
aspect_ratio string: Forholdet mellom bredde og høyde, for eksempel 1.78.
url string: URL-en til originalfilen, eller en tom streng hvis den ikke er tilgjengelig.
scheduled boolean: true hvis filen har aktiv tidsplanlegging.
playlists array: Spillelister som filen ligger i (uid, name og organization). Bare spillelister som brukeren kan se, vises.

Mulige feil

404 not_found Endepunktet finnes ikke, eller elementet finnes ikke eller tilhører en organisasjon som brukeren ikke kan se.
Feil knyttet til nøkkel og grenser gjelder for alle endepunkter. Se alle feil

ForespørselcURLPHPJavaScript

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

Svar200

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

Element som ikke finnes eller ikke er tilgjengelig404

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