Pierwsze kroki

API platformy

Dzięki API Twoje systemy mogą odczytywać telewizory, pliki i playlisty z Twojego konta bez otwierania panelu sterowania. Możesz w ten sposób pokazywać status telewizorów we własnym systemie monitoringu, sprawdzać, co jest wyświetlane na każdym ekranie, lub tworzyć raporty.

Każdy klucz widzi dokładnie to samo, co jego użytkownik w panelu sterowania: te same organizacje, a w każdej z nich to, co pozwalają mu wyświetlić jego uprawnienia.

Tylko odczyt

W tej wersji API tylko odczytuje dane. Na Twoim koncie nic się nie zmienia.

Taki sam dostęp jak w panelu sterowania

Uprawnienie odebrane w panelu sterowania od razu przestaje działać także w API.

JSON przez HTTPS

Odpowiedzi w formacie JSON, a daty w ISO 8601 ze strefą czasową.

Format odpowiedzi

Odpowiedzi są w formacie JSON (UTF-8). Pojedynczy element jest zwracany w data; listy zawierają też meta z informacjami o paginacji.
Daty są w formacie ISO 8601 ze strefą czasową, np. 2026-11-03T14:32:10-03:00.
Każdy element ma uid, taki sam jak w panelu sterowania. Użyj go, aby później pobrać ten element.
Pole bez wartości ma wartość null. Nowe pola mogą zostać dodane w dowolnym momencie, więc ignoruj te, których nie znasz.

Zacznij tutaj

1Uwierzytelnianie: wygeneruj klucz w sekcji Moje konto › API i wysyłaj go w nagłówku X-API-Key.
2Twój użytkownik: wyślij pierwsze żądanie, aby przetestować klucz.
3Co widzi każdy użytkownik: sprawdź, które organizacje i elementy może odczytywać klucz.

Adres bazowy

https://api.on-cloud.live/v1

Co możesz odczytać

/meTwój użytkownik i używany klucz
/organizationsorganizacje i uprawnienia
/tvstelewizory i ich status
/filesprzesłane pliki
/playlistsplaylisty i ich elementy

Pierwsze żądaniecURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
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/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Odpowiedź200

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}