Dokumentaro de la API v1
Esperanto
Lingvo de la dokumentaro La kodekzemploj kaj la nomoj de la kampoj estas samaj en ĉiuj lingvoj.
Iri al la kontrolpanelo

Unuaj paŝoj

Paĝigo kaj filtriloj

La listoj (/tvs, /files kaj /playlists) estas paĝigitaj. La eroj venas en data kaj la informoj pri la paĝo en meta.

NomoTipoPriskribo
pageintegerPaĝo, ekde 1. Defaŭlte: 1.
per_pageintegerEroj por paĝo, de 1 ĝis 100. Defaŭlte: 50.

Kampoj de meta

page integer
Nuna paĝo.
per_page integer
Eroj por paĝo.
total integer
Tuta nombro de trovitaj eroj, en ĉiuj paĝoj.
total_pages integer
Tuta nombro de paĝoj.

Por akiri ĉion, komencu ĉe page=1 kaj antaŭeniru ĝis vi atingos total_pages. Paĝo post la lasta revenas kun malplena data.

Filtriloj

La filtriloj kombineblas inter si kaj kun la paĝigo. La total de meta jam konsideras la filtrilojn.

NomoTipoPriskribo
organizationstringuid de organizaĵo, por ricevi nur ĝiajn erojn (vidu /organizations).
qstringParto de la nomo, ĝis 100 signoj.
typestringTipo de la dosiero, ekzemple image aŭ video. Nur en /files.
archivedinteger1 por nur la arĥivitaj aŭ 0 por nur la nearĥivitaj. Nur en /files.

Ordo

Televidiloj kaj ludlistoj venas laŭ alfabeta ordo; dosieroj, de la plej novaj al la plej malnovaj.

Peto
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();
Respondo200
{
  "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
  }
}
Nevalida parametro400
GET /v1/tvs?per_page=500

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