Dogfennaeth yr API v1
Cymraeg
Iaith y ddogfennaeth Mae'r enghreifftiau cod ac enwau'r meysydd yr un fath ym mhob iaith.
Agor y Panel Rheoli

Dechrau arni

Tudaleniad a hidlwyr

Mae'r rhestrau (/tvs, /files a /playlists) wedi'u tudalennu. Daw'r eitemau yn data a gwybodaeth y dudalen yn meta.

EnwMathDisgrifiad
pageintegerTudalen, gan ddechrau ar 1. Rhagosodiad: 1.
per_pageintegerEitemau fesul tudalen, o 1 i 100. Rhagosodiad: 50.

Meysydd meta

page integer
Y dudalen bresennol.
per_page integer
Eitemau fesul tudalen.
total integer
Cyfanswm yr eitemau a ganfuwyd, ar draws pob tudalen.
total_pages integer
Cyfanswm y tudalennau.

I nôl popeth, dechreuwch ar page=1 a symud ymlaen nes cyrraedd total_pages. Mae tudalen ar ôl yr olaf yn dychwelyd data gwag.

Hidlwyr

Gellir cyfuno hidlwyr â'i gilydd ac â'r tudaleniad. Mae'r total yn meta eisoes yn ystyried yr hidlwyr.

EnwMathDisgrifiad
organizationstringuid sefydliad, i ddychwelyd ei eitemau ef yn unig (gweler /organizations).
qstringRhan o'r enw, hyd at 100 nod.
typestringMath o ffeil, fel image neu video. Yn /files yn unig.
archivedinteger1 ar gyfer ffeiliau wedi'u harchifo yn unig neu 0 ar gyfer ffeiliau heb eu harchifo yn unig. Yn /files yn unig.

Trefn

Daw setiau teledu a rhestrau chwarae yn nhrefn yr wyddor; ffeiliau, o'r mwyaf newydd i'r hynaf.

Cais
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();
Ymateb200
{
  "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
  }
}
Paramedr annilys400
GET /v1/tvs?per_page=500

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