Dokumentasyon ng API v1
Filipino
Wika ng dokumentasyon Pareho sa lahat ng wika ang mga halimbawa ng code at ang mga pangalan ng field.
Buksan ang control panel

Pagsisimula

Pagination at mga filter

May pagination ang mga listahan (/tvs, /files at /playlists). Nasa data ang mga item at nasa meta ang impormasyon ng pahina.

PangalanUriPaglalarawan
pageintegerPahina, simula sa 1. Default: 1.
per_pageintegerMga item bawat pahina, mula 1 hanggang 100. Default: 50.

Mga field ng meta

page integer
Kasalukuyang pahina.
per_page integer
Mga item bawat pahina.
total integer
Kabuuang bilang ng mga item na nahanap, sa lahat ng pahina.
total_pages integer
Kabuuang bilang ng mga pahina.

Para makuha ang lahat, magsimula sa page=1 at magpatuloy hanggang maabot ang total_pages. Ang pahina pagkatapos ng huli ay babalik na may walang lamang data.

Mga filter

Puwedeng pagsamahin ang mga filter sa isa't isa at sa pagination. Isinasaalang-alang na ng total sa meta ang mga filter.

PangalanUriPaglalarawan
organizationstringuid ng isang organisasyon, para ang mga item lang nito ang makuha (tingnan ang /organizations).
qstringBahagi ng pangalan, hanggang 100 character.
typestringUri ng file, gaya ng image o video. Sa /files lang.
archivedinteger1 para sa mga naka-archive lang o 0 para sa mga hindi naka-archive lang. Sa /files lang.

Pagkakasunod-sunod

Nakaayos ayon sa alpabeto ang mga TV at playlist; ang mga file, mula sa pinakabago hanggang sa pinakaluma.

Request
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();
Response200
{
  "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
  }
}
Invalid na parameter400
GET /v1/tvs?per_page=500

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