Dokumentasi API v1
Bahasa Indonesia
Bahasa dokumentasi Contoh kode dan nama field sama di semua bahasa.
Buka panel kontrol

Memulai

Paginasi dan filter

Daftar (/tvs, /files, dan /playlists) dipaginasi. Item dikirim dalam data dan informasi halaman dalam meta.

NamaJenisDeskripsi
pageintegerHalaman, mulai dari 1. Default: 1.
per_pageintegerItem per halaman, dari 1 hingga 100. Default: 50.

Field meta

page integer
Halaman saat ini.
per_page integer
Item per halaman.
total integer
Jumlah total item yang ditemukan, dari semua halaman.
total_pages integer
Jumlah total halaman.

Untuk mengambil semuanya, mulai dari page=1 dan lanjutkan hingga mencapai total_pages. Halaman setelah halaman terakhir mengembalikan data kosong.

Filter

Filter dapat dikombinasikan satu sama lain dan dengan paginasi. Nilai total di meta sudah memperhitungkan filter.

NamaJenisDeskripsi
organizationstringuid organisasi, untuk menampilkan item dari organisasi itu saja (lihat /organizations).
qstringBagian dari nama, hingga 100 karakter.
typestringJenis file, seperti image atau video. Hanya di /files.
archivedinteger1 untuk file yang diarsipkan saja atau 0 untuk file yang tidak diarsipkan saja. Hanya di /files.

Urutan

TV dan playlist diurutkan menurut abjad; file, dari yang terbaru hingga yang terlama.

Permintaan
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();
Respons200
{
  "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
  }
}
Parameter tidak valid400
GET /v1/tvs?per_page=500

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