Referenca · Datoteke

Spisak datoteka

GET /v1/files

Prikazuje datoteke organizacija u kojima korisnik može vidjeti datoteke, od najnovijih prema najstarijima.

Odgovor podijeljen na stranice: stavke stižu u data, a podaci o stranici u meta. Paginacija i filteri

Parametri

Naziv	Tip	Opis
`organization`	`string`	uid organizacije, da dobijete samo njene stavke (pogledajte `/organizations`).
`q`	`string`	Dio naziva, do 100 znakova.
`type`	`string`	Tip datoteke, npr. `image` ili `video`.
`archived`	`integer`	`1` za samo arhivirane ili `0` za samo nearhivirane. Bez parametra stižu sve.
`page`	`integer`	Stranica, počevši od 1. Zadano: 1.
`per_page`	`integer`	Broj stavki po stranici, od 1 do 100. Zadano: 50.

Polja svake stavke

uid string: Identifikator datoteke.
name string: Naziv datoteke na kontrolnoj ploči.
type string: Tip datoteke, npr. image ili video.
duration integer: Trajanje u sekundama.
archived boolean: true ako je datoteka arhivirana.
organization object: Organizacija datoteke: uid i name.

Moguće greške

400 invalid_parameter Neki parametar ima nevažeću vrijednost, npr. per_page iznad maksimuma.
404 organization_not_found Navedeni organization nije organizacija u kojoj korisnik može vidjeti ovu vrstu stavki.
Greške vezane za ključ i ograničenje zahtjeva važe za sve endpointe. Pogledaj sve greške

ZahtjevcURLPHPJavaScript

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

Odgovor200

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