Nyaraka za API v1
Kiswahili
Lugha ya nyaraka Mifano ya msimbo na majina ya sehemu ni sawa katika lugha zote.
Fungua paneli ya udhibiti

Kuanza

Kurasa na vichujio

Orodha (/tvs, /files na /playlists) hugawanywa katika kurasa. Vipengee huja ndani ya data na maelezo ya ukurasa ndani ya meta.

JinaAinaMaelezo
pageintegerUkurasa, kuanzia 1. Chaguomsingi: 1.
per_pageintegerVipengee kwa kila ukurasa, kuanzia 1 hadi 100. Chaguomsingi: 50.

Sehemu za meta

page integer
Ukurasa wa sasa.
per_page integer
Vipengee kwa kila ukurasa.
total integer
Jumla ya vipengee vilivyopatikana, katika kurasa zote.
total_pages integer
Jumla ya kurasa.

Ili kupata kila kitu, anza na page=1 na uendelee hadi ufikie total_pages. Ukurasa ulio baada ya wa mwisho hurudi na data tupu.

Vichujio

Vichujio vinaweza kuunganishwa vyenyewe kwa vyenyewe na pia na kurasa. total ya meta tayari inazingatia vichujio.

JinaAinaMaelezo
organizationstringuid ya shirika, ili kuleta vipengee vyake pekee (tazama /organizations).
qstringSehemu ya jina, hadi herufi 100.
typestringAina ya faili, kama image au video. Kwa /files pekee.
archivedinteger1 kwa faili zilizo kwenye kumbukumbu pekee au 0 kwa zisizo kwenye kumbukumbu pekee. Kwa /files pekee.

Mpangilio

TV na orodha za kucheza huja kwa mpangilio wa alfabeti; faili, kuanzia mpya zaidi hadi za zamani zaidi.

Ombi
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();
Jibu200
{
  "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
  }
}
Kigezo batili400
GET /v1/tvs?per_page=500

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