Αναφορά · Αρχεία

Ανάκτηση αρχείου

GET /v1/files/{uid}

Επιστρέφει ένα αρχείο με βάση το uid, με το μέγεθος, την ανάλυση, τη διεύθυνση του αρχικού αρχείου και τις λίστες αναπαραγωγής στις οποίες περιλαμβάνεται.

Παράμετρος διαδρομής

Όνομα	Τύπος	Περιγραφή
`uid`	`string`	uid του αρχείου.

Πεδία απόκρισης

uid string: Αναγνωριστικό του αρχείου.
name string: Όνομα του αρχείου στον πίνακα ελέγχου.
type string: Τύπος αρχείου, π.χ. image ή video.
duration integer: Διάρκεια, σε δευτερόλεπτα.
archived boolean: true αν το αρχείο είναι αρχειοθετημένο.
organization object: Οργανισμός του αρχείου: uid και name.
size integer: Μέγεθος του αρχικού αρχείου, σε byte.
width integer: Πλάτος του αρχικού αρχείου, σε pixel.
height integer: Ύψος του αρχικού αρχείου, σε pixel.
aspect_ratio string: Αναλογία πλάτους προς ύψος, π.χ. 1.78.
url string: Διεύθυνση του αρχικού αρχείου ή κενό κείμενο αν δεν είναι διαθέσιμο.
scheduled boolean: true αν το αρχείο έχει ενεργό προγραμματισμό.
playlists array: Λίστες αναπαραγωγής στις οποίες περιλαμβάνεται το αρχείο (uid, name και organization). Εμφανίζονται μόνο οι λίστες που μπορεί να δει ο χρήστης.

Πιθανά σφάλματα

404 not_found Το τελικό σημείο δεν υπάρχει ή το στοιχείο δεν υπάρχει ή ανήκει σε οργανισμό που ο χρήστης δεν μπορεί να δει.
Τα σφάλματα κλειδιού και ορίου ισχύουν για όλα τα τελικά σημεία. Δείτε όλα τα σφάλματα

Αίτημα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();

Απόκριση200

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

Στοιχείο που δεν υπάρχει ή χωρίς πρόσβαση404

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