Imibhalo ye-API v1
isiZulu
Ulimi lwemibhalo Izibonelo zekhodi namagama ezinkambu ziyafana kuzo zonke izilimi.
Vula iphaneli yokulawula

Ukuqalisa

Amakhasi nezihlungi

Izinhlu (/tvs, /files ne-/playlists) zehlukaniswe ngamakhasi. Izinto ziza ku-data kanti ulwazi lwekhasi luza ku-meta.

IgamaUhloboIncazelo
pageintegerIkhasi, kusukela ku-1. Okuzenzakalelayo: 1.
per_pageintegerIzinto ekhasini ngalinye, kusukela ku-1 kuya ku-100. Okuzenzakalelayo: 50.

Izinkambu ze-meta

page integer
Ikhasi lamanje.
per_page integer
Izinto ekhasini ngalinye.
total integer
Inani lezinto ezitholakele, kuwo wonke amakhasi.
total_pages integer
Inani lamakhasi.

Ukuze uthole konke, qala ku-page=1 bese uqhubeka uze ufike ku-total_pages. Ikhasi elingemuva kwelokugcina libuya ne-data engenalutho.

Izihlungi

Izihlungi zingahlanganiswa phakathi kwazo kanye namakhasi. I-total ye-meta isivele izibhekile izihlungi.

IgamaUhloboIncazelo
organizationstringI-uid yenhlangano, ukuze kulethwe izinto zayo kuphela (bona i-/organizations).
qstringIngxenye yegama, kufika ezinhlamvwini ezingu-100.
typestringUhlobo lwefayela, njenge-image noma i-video. Ku-/files kuphela.
archivedinteger1 kumafayela agciniwe kuphela noma 0 kumafayela angagciniwe kuphela. Ku-/files kuphela.

Ukulandelana

Ama-TV nezinhlu zokudlala kuza ngokulandelana kwezinhlamvu; amafayela, kusukela kwamasha kuya kwamadala.

Isicelo
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();
Impendulo200
{
  "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
  }
}
Ipharamitha engavumelekile400
GET /v1/tvs?per_page=500

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