API-dokumentaatio v1
Suomi
Dokumentaation kieli Koodiesimerkit ja kenttien nimet ovat samat kaikilla kielillä.
Avaa ohjauspaneeli

Aloitus

Sivutus ja suodattimet

Luettelot (/tvs, /files ja /playlists) on sivutettu. Kohteet palautetaan kentässä data ja sivun tiedot kentässä meta.

NimiTyyppiKuvaus
pageintegerSivunumero 1:stä alkaen. Oletus: 1.
per_pageintegerKohteita sivulla, 1–100. Oletus: 50.

Kentän meta tiedot

page integer
Nykyinen sivu.
per_page integer
Kohteita sivulla.
total integer
Löytyneiden kohteiden kokonaismäärä kaikilla sivuilla.
total_pages integer
Sivujen kokonaismäärä.

Jos haluat hakea kaiken, aloita arvosta page=1 ja jatka, kunnes saavutat arvon total_pages. Viimeisen sivun jälkeinen sivu palauttaa tyhjän kentän data.

Suodattimet

Suodattimia voi yhdistellä keskenään ja sivutuksen kanssa. Kentän meta arvo total ottaa suodattimet jo huomioon.

NimiTyyppiKuvaus
organizationstringOrganisaation uid, jos haluat vain sen kohteet (katso /organizations).
qstringOsa nimestä, enintään 100 merkkiä.
typestringTiedostotyyppi, esimerkiksi image tai video. Vain päätepisteessä /files.
archivedinteger1 vain arkistoiduille tai 0 vain arkistoimattomille tiedostoille. Vain päätepisteessä /files.

Järjestys

TV:t ja soittolistat palautetaan aakkosjärjestyksessä, tiedostot uusimmasta vanhimpaan.

Pyyntö
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();
Vastaus200
{
  "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
  }
}
Virheellinen parametri400
GET /v1/tvs?per_page=500

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