Žinynas · Failai

Failų sąrašas

GET /v1/files

Pateikia failus iš organizacijų, kuriose naudotojas gali matyti failus, nuo naujausių iki seniausių.

Atsakymas skaidomas puslapiais: elementai pateikiami lauke data, o puslapio informacija – lauke meta. Puslapiavimas ir filtrai

Parametrai

Pavadinimas	Tipas	Aprašymas
`organization`	`string`	Organizacijos uid, jei norite gauti tik jos elementus (žr. `/organizations`).
`q`	`string`	Pavadinimo dalis, iki 100 simbolių.
`type`	`string`	Failo tipas, pavyzdžiui, `image` arba `video`.
`archived`	`integer`	`1` – tik suarchyvuoti failai, `0` – tik nesuarchyvuoti. Be šio parametro grąžinami visi.
`page`	`integer`	Puslapis, pradedant nuo 1. Numatytoji reikšmė: 1.
`per_page`	`integer`	Elementų skaičius puslapyje, nuo 1 iki 100. Numatytoji reikšmė: 50.

Kiekvieno elemento laukai

uid string: Failo identifikatorius.
name string: Failo pavadinimas valdymo skydelyje.
type string: Failo tipas, pavyzdžiui, image arba video.
duration integer: Trukmė sekundėmis.
archived boolean: true, jei failas suarchyvuotas.
organization object: Failo organizacija: uid ir name.

Galimos klaidos

400 invalid_parameter Parametras turi netinkamą reikšmę, pavyzdžiui, per_page viršija didžiausią leistiną.
404 organization_not_found Nurodytas organization nėra organizacija, kurioje naudotojas gali matyti šio tipo elementus.
Rakto ir apribojimų klaidos galioja visiems galiniams taškams. Žiūrėti visas klaidas

UžklausacURLPHPJavaScript

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

Atsakymas200

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