API dokumentācija v1
Latviešu
Dokumentācijas valoda Koda piemēri un lauku nosaukumi visās valodās ir vienādi.
Atvērt vadības paneli

Darba sākšana

Lapošana un filtri

Saraksti (/tvs, /files un /playlists) tiek dalīti lapās. Vienumi tiek atgriezti laukā data, bet informācija par lapu — laukā meta.

NosaukumsTipsApraksts
pageintegerLapa, sākot no 1. Noklusējums: 1.
per_pageintegerVienumu skaits lapā, no 1 līdz 100. Noklusējums: 50.

meta lauki

page integer
Pašreizējā lapa.
per_page integer
Vienumu skaits lapā.
total integer
Kopējais atrasto vienumu skaits visās lapās.
total_pages integer
Kopējais lapu skaits.

Lai iegūtu visu, sāciet ar page=1 un turpiniet, līdz sasniedzat total_pages. Lapa pēc pēdējās atgriež tukšu data.

Filtri

Filtrus var kombinēt savā starpā un ar lapošanu. meta lauks total jau ņem vērā filtrus.

NosaukumsTipsApraksts
organizationstringOrganizācijas uid, lai iegūtu tikai tās vienumus (skatiet /organizations).
qstringNosaukuma daļa, līdz 100 rakstzīmēm.
typestringFaila tips, piemēram, image vai video. Tikai galapunktā /files.
archivedinteger1 — tikai arhivētie faili, 0 — tikai nearhivētie. Tikai galapunktā /files.

Secība

TV un atskaņošanas saraksti tiek kārtoti alfabētiski, faili — no jaunākā līdz vecākajam.

Pieprasījums
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();
Atbilde200
{
  "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
  }
}
Nederīgs parametrs400
GET /v1/tvs?per_page=500

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