Dokimantasyon API a v1
Kreyòl ayisyen
Lang dokimantasyon an Egzanp kòd yo ak non chan yo se menm bagay nan tout lang.
Ale nan panèl la

Premye pa

Paginasyon ak filtè

Lis yo (/tvs, /files ak /playlists) divize an paj. Eleman yo vini nan data, epi enfòmasyon sou paj la vini nan meta.

NonTipDeskripsyon
pageintegerPaj, apati 1. Pa defo: 1.
per_pageintegerKantite eleman pa paj, soti 1 rive 100. Pa defo: 50.

Chan meta yo

page integer
Paj kounye a.
per_page integer
Kantite eleman pa paj.
total integer
Kantite total eleman yo jwenn, nan tout paj yo.
total_pages integer
Kantite total paj.

Pou jwenn tout bagay, kòmanse nan page=1 epi avanse jiskaske ou rive nan total_pages. Yon paj apre dènye a retounen ak yon data vid.

Filtè

Ou ka konbine filtè yo youn ak lòt, epi ak paginasyon an tou. total nan meta deja konte filtè yo.

NonTipDeskripsyon
organizationstringuid yon òganizasyon, pou jwenn sèlman eleman pa l yo (gade /organizations).
qstringYon pati nan non an, jiska 100 karaktè.
typestringTip fichye a, tankou image oswa video. Sèlman nan /files.
archivedinteger1 pou fichye ki achive yo sèlman oswa 0 pou fichye ki pa achive yo sèlman. Sèlman nan /files.

Lòd

TV yo ak playlist yo vini nan lòd alfabetik; fichye yo, soti nan pi nouvo yo rive nan pi ansyen yo.

Demann
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();
Repons200
{
  "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
  }
}
Paramèt ki pa valab400
GET /v1/tvs?per_page=500

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