API dokumentacija v1
Lietuvių
Dokumentacijos kalba Kodo pavyzdžiai ir laukų pavadinimai visomis kalbomis yra vienodi.
Atidaryti valdymo skydelį

Pradžia

Puslapiavimas ir filtrai

Sąrašai (/tvs, /files ir /playlists) skaidomi puslapiais. Elementai pateikiami lauke data, o puslapio informacija – lauke meta.

PavadinimasTipasAprašymas
pageintegerPuslapis, pradedant nuo 1. Numatytoji reikšmė: 1.
per_pageintegerElementų skaičius puslapyje, nuo 1 iki 100. Numatytoji reikšmė: 50.

meta laukai

page integer
Dabartinis puslapis.
per_page integer
Elementų skaičius puslapyje.
total integer
Bendras rastų elementų skaičius visuose puslapiuose.
total_pages integer
Bendras puslapių skaičius.

Norėdami gauti viską, pradėkite nuo page=1 ir eikite toliau, kol pasieksite total_pages. Puslapis po paskutiniojo grąžina tuščią data.

Filtrai

Filtrus galima derinti tarpusavyje ir su puslapiavimu. meta laukas total jau atsižvelgia į filtrus.

PavadinimasTipasAprašymas
organizationstringOrganizacijos uid, jei norite gauti tik jos elementus (žr. /organizations).
qstringPavadinimo dalis, iki 100 simbolių.
typestringFailo tipas, pavyzdžiui, image arba video. Tik /files.
archivedinteger1 – tik suarchyvuoti failai, 0 – tik nesuarchyvuoti. Tik /files.

Tvarka

Televizoriai ir grojaraščiai pateikiami abėcėlės tvarka, failai – nuo naujausių iki seniausių.

Užklausa
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();
Atsakymas200
{
  "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
  }
}
Netinkamas parametras400
GET /v1/tvs?per_page=500

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