Документація API v1
Українська
Мова документації Приклади коду й назви полів однакові для всіх мов.
Відкрити панель керування

Початок роботи

Пагінація й фільтри

Списки (/tvs, /files і /playlists) розбито на сторінки. Об’єкти повертаються в data, а відомості про сторінку — в meta.

НазваТипОпис
pageintegerНомер сторінки, починаючи з 1. За замовчуванням: 1.
per_pageintegerОб’єктів на сторінці, від 1 до 100. За замовчуванням: 50.

Поля meta

page integer
Поточна сторінка.
per_page integer
Об’єктів на сторінці.
total integer
Загальна кількість знайдених об’єктів на всіх сторінках.
total_pages integer
Загальна кількість сторінок.

Щоб отримати все, почніть із page=1 і переходьте далі, доки не дійдете до total_pages. Сторінка після останньої повертає порожній data.

Фільтри

Фільтри можна поєднувати між собою та з пагінацією. Значення total у meta вже враховує фільтри.

НазваТипОпис
organizationstringuid компанії, щоб отримати лише її об’єкти (див. /organizations).
qstringЧастина назви, до 100 символів.
typestringТип файлу, наприклад image або video. Лише в /files.
archivedinteger1 — лише архівовані файли, 0 — лише неархівовані. Лише в /files.

Порядок

Телевізори й плейлисти повертаються в алфавітному порядку, файли — від найновіших до найстаріших.

Запит
curl "https://api.on-cloud.live/v1/tvs?per_page=2" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?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/tvs?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();
Відповідь200
{
  "data": [
    {
      "uid": "d3d9446802a44259755d38e6d163e820",
      "name": "Caixa 2",
      "description": "",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "playlist": null,
      "status": "offline",
      "last_seen_at": "2026-11-01T18:04:51-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.83",
      "os": "android",
      "device": {
        "brand": "Philco",
        "model": "PTV32G70"
      },
      "timezone": "America/Sao_Paulo"
    },
    {
      "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
      "name": "Recepção",
      "description": "TV da entrada",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "playlist": {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal"
      },
      "status": "online",
      "last_seen_at": "2026-11-03T14:32:10-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.84",
      "os": "android",
      "device": {
        "brand": "TCL",
        "model": "43P635"
      },
      "timezone": "America/Sao_Paulo"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}
Недійсний параметр400
GET /v1/tvs?per_page=500

{
  "error": {
    "code": "invalid_parameter",
    "message": "per_page must be a number between 1 and 100."
  }
}