Referencia · Súbory

Zoznam súborov

GET /v1/files

Vypíše súbory z organizácií, v ktorých môže používateľ vidieť súbory, od najnovších po najstaršie.

Stránkovaná odpoveď: položky prichádzajú v data a informácie o stránke v meta. Stránkovanie a filtre

Parametre

Názov	Typ	Popis
`organization`	`string`	uid organizácie, ak chcete iba jej položky (pozri `/organizations`).
`q`	`string`	Časť názvu, najviac 100 znakov.
`type`	`string`	Typ súboru, napríklad `image` alebo `video`.
`archived`	`integer`	`1` iba pre archivované súbory, `0` iba pre nearchivované. Bez parametra sa vrátia všetky.
`page`	`integer`	Stránka, od 1. Predvolená hodnota: 1.
`per_page`	`integer`	Počet položiek na stránku, od 1 do 100. Predvolená hodnota: 50.

Polia každej položky

uid string: Identifikátor súboru.
name string: Názov súboru v ovládacom paneli.
type string: Typ súboru, napríklad image alebo video.
duration integer: Dĺžka v sekundách.
archived boolean: true, ak je súbor archivovaný.
organization object: Organizácia súboru: uid a name.

Možné chyby

400 invalid_parameter Parameter má neplatnú hodnotu, napríklad per_page nad povoleným maximom.
404 organization_not_found Zadaný parameter organization nezodpovedá organizácii, v ktorej môže používateľ vidieť tento typ položiek.
Chyby kľúča a limitu platia pre všetky endpointy. Zobraziť všetky chyby

PožiadavkacURLPHPJavaScript

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

Odpoveď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
  }
}