İlk addımlar

Səhifələmə və filtrlər

Siyahılar (/tvs, /files və /playlists) səhifələrə bölünür. Elementlər data daxilində, səhifə məlumatları isə meta daxilində gəlir.

Ad	Növ	Təsvir
`page`	`integer`	Səhifə nömrəsi, 1-dən başlayır. Standart: 1.
`per_page`	`integer`	Səhifədəki element sayı, 1 ilə 100 arasında. Standart: 50.

`meta` sahələri

page integer: Cari səhifə.
per_page integer: Səhifədəki element sayı.
total integer: Bütün səhifələr üzrə tapılan elementlərin ümumi sayı.
total_pages integer: Səhifələrin ümumi sayı.

Hamısını almaq üçün page=1 ilə başlayın və total_pages dəyərinə çatana qədər irəliləyin. Sonuncudan sonrakı səhifə boş data qaytarır.

Filtrlər

Filtrləri bir-biri ilə və səhifələmə ilə birləşdirmək olar. meta daxilindəki total filtrləri artıq nəzərə alır.

Ad	Növ	Təsvir
`organization`	`string`	Yalnız həmin şirkətin elementlərini qaytarmaq üçün şirkətin uid identifikatoru (bax: `/organizations`).
`q`	`string`	Adın bir hissəsi, ən çoxu 100 simvol.
`type`	`string`	Faylın növü, məsələn, `image` və ya `video`. Yalnız `/files` üçün.
`archived`	`integer`	Yalnız arxivləşdirilmiş fayllar üçün `1`, yalnız arxivləşdirilməmiş fayllar üçün `0`. Yalnız `/files` üçün.

Sıralama

TV-lər və pleylistlər əlifba sırası ilə, fayllar isə ən yenidən ən köhnəyə doğru gəlir.

SorğucURLPHPJavaScript

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();

Cavab200

{
  "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
  }
}

Yanlış parametr400

GET /v1/tvs?per_page=500

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

Səhifələmə və filtrlər

meta sahələri

Filtrlər

Sıralama

`meta` sahələri