API-н баримт бичиг v1
Монгол
Баримт бичгийн хэл Кодын жишээ болон талбаруудын нэр бүх хэл дээр ижил.
Хяналтын самбар руу орох

Эхлэх

Хуудаслалт ба шүүлтүүр

Жагсаалтууд (/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 дээр.
archivedinteger1 бол зөвхөн архивласан, 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."
  }
}