Erste Schritte

Plattform-API

Mit der API rufen Ihre Systeme die TVs, Dateien und Playlists Ihres Kontos ab, ohne das Kontrollzentrum zu öffnen. Nutzen Sie sie, um den Status der TVs in Ihrem eigenen Monitoring anzuzeigen, zu prüfen, was auf welchem Bildschirm läuft, oder um Berichte zu erstellen.

Jeder Schlüssel sieht genau das, was sein Benutzer im Kontrollzentrum sieht: dieselben Organisationen und in jeder Organisation das, was dieser Benutzer laut seinen Berechtigungen auflisten darf.

Nur Lesezugriff

In dieser Version ruft die API nur Daten ab. In Ihrem Konto wird nichts geändert.

Gleicher Zugriff wie im Kontrollzentrum

Eine im Kontrollzentrum entzogene Berechtigung gilt sofort auch für die API.

JSON über HTTPS

Antworten in JSON, Datumsangaben in ISO 8601 mit Zeitzone.

Antwortformat

Antworten sind JSON (UTF-8). Ein einzelnes Element steht in data; Listen enthalten zusätzlich meta mit der Paginierung.
Datumsangaben folgen ISO 8601 mit Zeitzone, z. B. 2026-11-03T14:32:10-03:00.
Jedes Element hat eine uid, dieselbe wie im Kontrollzentrum. Damit können Sie das Element später abrufen.
Felder ohne Wert werden als null geliefert. Neue Felder können jederzeit hinzukommen; ignorieren Sie daher Felder, die Sie nicht kennen.

So starten Sie

1Authentifizierung: Generieren Sie unter Mein Konto › API einen Schlüssel und senden Sie ihn im Header X-API-Key.
2Ihr Benutzer: Senden Sie Ihre erste Anfrage, um den Schlüssel zu testen.
3Was jeder Benutzer sehen kann: Prüfen Sie, welche Organisationen und Elemente der Schlüssel abrufen kann.

Basis-URL

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

Was Sie abrufen können

/meIhr Benutzer und der verwendete Schlüssel
/organizationsOrganisationen und Berechtigungen
/tvsTVs und ihr Status
/filesHochgeladene Dateien
/playlistsPlaylists und ihre Elemente

Erste AnfragecURLPHPJavaScript

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

Antwort200

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