Referencja · Pliki

Lista plików

GET /v1/files

Zwraca listę plików z organizacji, w których użytkownik może widzieć pliki, od najnowszych do najstarszych.

Odpowiedź z paginacją: elementy są zwracane w data, a informacje o stronie w meta. Paginacja i filtry

Parametry

Nazwa	Typ	Opis
`organization`	`string`	uid organizacji, aby zwrócić tylko jej elementy (zobacz `/organizations`).
`q`	`string`	Fragment nazwy, maksymalnie 100 znaków.
`type`	`string`	Typ pliku, np. `image` lub `video`.
`archived`	`integer`	`1` – tylko pliki zarchiwizowane, `0` – tylko niezarchiwizowane. Bez tego parametru zwracane są wszystkie.
`page`	`integer`	Strona, od 1. Domyślnie: 1.
`per_page`	`integer`	Liczba elementów na stronie, od 1 do 100. Domyślnie: 50.

Pola każdego elementu

uid string: Identyfikator pliku.
name string: Nazwa pliku w panelu sterowania.
type string: Typ pliku, np. image lub video.
duration integer: Czas trwania w sekundach.
archived boolean: true, jeśli plik jest zarchiwizowany.
organization object: Organizacja pliku: uid i name.

Możliwe błędy

400 invalid_parameter Parametr ma nieprawidłową wartość, np. per_page powyżej maksimum.
404 organization_not_found Podany parametr organization nie wskazuje organizacji, w której użytkownik może widzieć ten typ elementów.
Błędy klucza i limitu dotyczą wszystkich endpointów. Zobacz wszystkie błędy

ŻądaniecURLPHPJavaScript

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

Odpowiedź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
  }
}