መጀመር

ገጽ መከፋፈል እና ማጣሪያዎች

ዝርዝሮቹ (/tvs፣ /files እና /playlists) በገጾች የተከፋፈሉ ናቸው። ንጥሎቹ በdata ውስጥ፣ የገጹ መረጃ ደግሞ በmeta ውስጥ ይመጣሉ።

ስምአይነትመግለጫ
pageintegerገጽ፣ ከ1 ጀምሮ። ነባሪ፦ 1።
per_pageintegerበአንድ ገጽ ያሉ ንጥሎች፣ ከ1 እስከ 100። ነባሪ፦ 50።

የmeta መስኮች

page integer
የአሁኑ ገጽ።
per_page integer
በአንድ ገጽ ያሉ ንጥሎች።
total integer
በሁሉም ገጾች የተገኙ ንጥሎች ጠቅላላ ብዛት።
total_pages integer
ጠቅላላ የገጾች ብዛት።

ሁሉንም ለማግኘት ከpage=1 ይጀምሩ እና total_pages እስኪደርሱ ድረስ ይቀጥሉ። ከመጨረሻው በኋላ ያለ ገጽ ባዶ data ይመልሳል።

ማጣሪያዎች

ማጣሪያዎችን እርስ በርሳቸው እና ከገጽ መከፋፈል ጋር ማጣመር ይቻላል። በmeta ውስጥ ያለው total ማጣሪያዎቹን አስቀድሞ ከግምት ያስገባል።

ስምአይነትመግለጫ
organizationstringየአንድ ድርጅት uid፣ የእሱን ንጥሎች ብቻ ለማምጣት (/organizationsን ይመልከቱ)።
qstringየስሙ ክፍል፣ እስከ 100 ቁምፊዎች።
typestringየፋይሉ አይነት፣ ለምሳሌ image ወይም video። በ/files ውስጥ ብቻ።
archivedintegerበማህደር የተቀመጡትን ብቻ ለማግኘት 1፣ በማህደር ያልተቀመጡትን ብቻ ለማግኘት 0። በ/files ውስጥ ብቻ።

ቅደም ተከተል

ቲቪዎች እና ፕሌይሊስቶች በፊደል ቅደም ተከተል ይመጣሉ፤ ፋይሎች ደግሞ ከአዲሱ ወደ አሮጌው።

ጥያቄ
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();
ምላሽ200
{
  "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
  }
}
ልክ ያልሆነ ፓራሜትር400
GET /v1/tvs?per_page=500

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