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

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

GET /v1/files

Παραθέτει τα αρχεία των οργανισμών όπου ο χρήστης μπορεί να βλέπει αρχεία, από τα νεότερα στα παλαιότερα.

Σελιδοποιημένη απόκριση: τα στοιχεία επιστρέφονται στο data και οι πληροφορίες της σελίδας στο meta. Σελιδοποίηση και φίλτρα

Παράμετροι

Όνομα	Τύπος	Περιγραφή
`organization`	`string`	uid ενός οργανισμού, για να επιστραφούν μόνο τα δικά του στοιχεία (βλ. `/organizations`).
`q`	`string`	Μέρος του ονόματος, έως 100 χαρακτήρες.
`type`	`string`	Τύπος αρχείου, π.χ. `image` ή `video`.
`archived`	`integer`	`1` μόνο για αρχειοθετημένα ή `0` μόνο για μη αρχειοθετημένα. Χωρίς την παράμετρο, επιστρέφονται όλα.
`page`	`integer`	Σελίδα, ξεκινώντας από το 1. Προεπιλογή: 1.
`per_page`	`integer`	Στοιχεία ανά σελίδα, από 1 έως 100. Προεπιλογή: 50.

Πεδία κάθε στοιχείου

uid string: Αναγνωριστικό του αρχείου.
name string: Όνομα του αρχείου στον πίνακα ελέγχου.
type string: Τύπος αρχείου, π.χ. image ή video.
duration integer: Διάρκεια, σε δευτερόλεπτα.
archived boolean: true αν το αρχείο είναι αρχειοθετημένο.
organization object: Οργανισμός του αρχείου: uid και name.

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

400 invalid_parameter Μια παράμετρος έχει μη έγκυρη τιμή, π.χ. per_page πάνω από το μέγιστο.
404 organization_not_found Το organization που δόθηκε δεν αντιστοιχεί σε οργανισμό όπου ο χρήστης μπορεί να δει αυτόν τον τύπο στοιχείων.
Τα σφάλματα κλειδιού και ορίου ισχύουν για όλα τα τελικά σημεία. Δείτε όλα τα σφάλματα

ΑίτημαcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Απόκριση200

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}