Довідник · Файли

Список файлів

GET /v1/files

Повертає файли компаній, у яких користувач може бачити файли, від найновіших до найстаріших.

Відповідь із пагінацією: об’єкти повертаються в data, а відомості про сторінку — в meta. Пагінація й фільтри

Параметри

Назва	Тип	Опис
`organization`	`string`	uid компанії, щоб отримати лише її об’єкти (див. `/organizations`).
`q`	`string`	Частина назви, до 100 символів.
`type`	`string`	Тип файлу, наприклад `image` або `video`.
`archived`	`integer`	`1` — лише архівовані, `0` — лише неархівовані. Без параметра повертаються всі.
`page`	`integer`	Номер сторінки, починаючи з 1. За замовчуванням: 1.
`per_page`	`integer`	Об’єктів на сторінці, від 1 до 100. За замовчуванням: 50.

Поля кожного об’єкта

uid string: Ідентифікатор файлу.
name string: Назва файлу в панелі керування.
type string: Тип файлу, наприклад image або video.
duration integer: Тривалість у секундах.
archived boolean: true, якщо файл архівовано.
organization object: Компанія файлу: uid і name.

Можливі помилки

400 invalid_parameter Параметр має недійсне значення, наприклад per_page понад максимум.
404 organization_not_found Указаний organization не належить до компаній, у яких користувач може бачити об’єкти цього типу.
Помилки ключа й ліміту запитів стосуються всіх ендпоінтів. Усі помилки

ЗапитcURLPHPJavaScript

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

Відповідь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
  }
}