Τεκμηρίωση 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.

Φίλτρα

Τα φίλτρα μπορούν να συνδυαστούν μεταξύ τους και με τη σελιδοποίηση. Το total του meta λαμβάνει ήδη υπόψη τα φίλτρα.

ΌνομαΤύποςΠεριγραφή
organizationstringuid ενός οργανισμού, για να επιστραφούν μόνο τα δικά του στοιχεία (βλ. /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."
  }
}