API Belgeleri v1
Türkçe
Belgelerin dili Kod örnekleri ve alanların adları tüm dillerde aynıdır.
Kontrol paneline git

Başlarken

Sayfalama ve filtreler

Listeler (/tvs, /files ve /playlists) sayfalanır. Öğeler data içinde, sayfa bilgileri ise meta içinde gelir.

AdTürAçıklama
pageintegerSayfa numarası, 1'den başlar. Varsayılan: 1.
per_pageintegerSayfa başına öğe sayısı, 1 ile 100 arasında. Varsayılan: 50.

meta alanları

page integer
Geçerli sayfa.
per_page integer
Sayfa başına öğe sayısı.
total integer
Bulunan toplam öğe sayısı (tüm sayfalar dahil).
total_pages integer
Toplam sayfa sayısı.

Tümünü almak için page=1 ile başlayın ve total_pages değerine ulaşana kadar ilerleyin. Son sayfadan sonraki bir sayfa boş bir data ile döner.

Filtreler

Filtreler birbiriyle ve sayfalamayla birlikte kullanılabilir. meta içindeki total değeri filtreleri zaten hesaba katar.

AdTürAçıklama
organizationstringYalnızca o kuruluşun öğelerini getirmek için bir kuruluşun uid değeri (bkz. /organizations).
qstringAdın bir kısmı, en fazla 100 karakter.
typestringDosya türü, ör. image veya video. Yalnızca /files için.
archivedintegerYalnızca arşivlenmiş dosyalar için 1, yalnızca arşivlenmemiş dosyalar için 0. Yalnızca /files için.

Sıralama

TV'ler ve oynatma listeleri alfabetik sırayla, dosyalar ise en yeniden en eskiye doğru gelir.

İstek
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();
Yanıt200
{
  "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
  }
}
Geçersiz parametre400
GET /v1/tvs?per_page=500

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