Reference · Soubory

Seznam souborů

GET /v1/files

Vypíše soubory z organizací, ve kterých uživatel může vidět soubory, od nejnovějších po nejstarší.

Stránkovaná odpověď: položky přicházejí v data a informace o stránce v meta. Stránkování a filtry

Parametry

Název	Typ	Popis
`organization`	`string`	uid organizace, pokud chcete jen její položky (viz `/organizations`).
`q`	`string`	Část názvu, nejvýše 100 znaků.
`type`	`string`	Typ souboru, například `image` nebo `video`.
`archived`	`integer`	`1` jen pro archivované soubory, `0` jen pro nearchivované. Bez parametru se vrátí všechny.
`page`	`integer`	Stránka, počínaje 1. Výchozí hodnota: 1.
`per_page`	`integer`	Počet položek na stránku, od 1 do 100. Výchozí hodnota: 50.

Pole každé položky

uid string: Identifikátor souboru.
name string: Název souboru v ovládacím panelu.
type string: Typ souboru, například image nebo video.
duration integer: Délka v sekundách.
archived boolean: true, pokud je soubor archivovaný.
organization object: Organizace souboru: uid a name.

Možné chyby

400 invalid_parameter Parametr má neplatnou hodnotu, například per_page nad povoleným maximem.
404 organization_not_found Zadaný parametr organization neodpovídá organizaci, ve které uživatel může vidět tento typ položek.
Chyby klíče a limitu platí pro všechny endpointy. Zobrazit všechny chyby

PožadavekcURLPHPJavaScript

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

Odpověď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
  }
}