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 қайтарады.

Сүзгілер

Сүзгілерді бір-бірімен және беттеумен біріктіруге болады. meta ішіндегі total сүзгілерді ескереді.

АтауыТүріСипаттамасы
organizationstringТек сол ұйымның элементтерін алу үшін ұйымның uid идентификаторы (/organizations қараңыз).
qstringАтаудың бір бөлігі, ең көбі 100 таңба.
typestringФайл түрі, мысалы, image немесе video. Тек /files үшін.
archivedintegerТек мұрағатталғандар үшін 1, тек мұрағатталмағандар үшін 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."
  }
}