Referenz · Dateien

Eine Datei abrufen

GET /v1/files/{uid}

Liefert eine Datei anhand ihrer uid, mit Größe, Auflösung, URL der Originaldatei und den Playlists, in denen sie enthalten ist.

Pfadparameter

Name	Typ	Beschreibung
`uid`	`string`	uid der Datei.

Antwortfelder

uid string: Kennung der Datei.
name string: Name der Datei im Kontrollzentrum.
type string: Dateityp, z. B. image oder video.
duration integer: Dauer in Sekunden.
archived boolean: true, wenn die Datei archiviert ist.
organization object: Organisation der Datei: uid und name.
size integer: Größe der Originaldatei in Bytes.
width integer: Breite der Originaldatei in Pixeln.
height integer: Höhe der Originaldatei in Pixeln.
aspect_ratio string: Verhältnis von Breite zu Höhe, z. B. 1.78.
url string: URL der Originaldatei oder ein leerer String, wenn sie nicht verfügbar ist.
scheduled boolean: true, wenn für die Datei eine aktive Planung besteht.
playlists array: Playlists, in denen die Datei enthalten ist (uid, name und organization). Es werden nur Playlists aufgeführt, die der Benutzer sehen kann.

Mögliche Fehler

404 not_found Der Endpunkt existiert nicht, oder das Element existiert nicht bzw. gehört zu einer Organisation, die der Benutzer nicht sehen kann.
Fehler zum Schlüssel und zum Anfragelimit gelten für alle Endpunkte. Alle Fehler ansehen

AnfragecURLPHPJavaScript

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

Antwort200

{
  "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 existiert nicht oder kein Zugriff404

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