Reference · Filer

Hent én fil

GET /v1/files/{uid}

Viser en fil ud fra dens uid med størrelse, opløsning, URL til den originale fil og de playlister, filen ligger i.

Stiparameter

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

Felter i svaret

uid string: Filens id.
name string: Filens navn i kontrolpanelet.
type string: Filtype, f.eks. image eller video.
duration integer: Varighed i sekunder.
archived boolean: true, hvis filen er arkiveret.
organization object: Filens organisation: uid og name.
size integer: Den originale fils størrelse i bytes.
width integer: Den originale fils bredde i pixels.
height integer: Den originale fils højde i pixels.
aspect_ratio string: Forholdet mellem bredde og højde, f.eks. 1.78.
url string: URL til den originale fil eller en tom streng, hvis den ikke er tilgængelig.
scheduled boolean: true, hvis filen har en aktiv tidsplan.
playlists array: Playlister, som filen ligger i (uid, name og organization). Kun playlister, som brugeren kan se, vises.

Mulige fejl

404 not_found Endpointet findes ikke, eller elementet findes ikke eller tilhører en organisation, som brugeren ikke kan se.
Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl

ForespørgselcURLPHPJavaScript

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, der ikke findes eller ikke er adgang til404

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