Aan de slag

Platform-API

Met de API kunnen uw systemen de TV's, bestanden en playlists van uw account opvragen zonder het beheerpaneel te openen. Gebruik de API om de status van de TV's in uw eigen monitoring te tonen, te controleren wat er op elk scherm wordt afgespeeld of rapporten te maken.

Elke sleutel ziet precies wat de bijbehorende gebruiker in het beheerpaneel ziet: dezelfde organisaties en, binnen elke organisatie, wat die gebruiker op grond van zijn rechten mag opvragen.

Alleen-lezen

In deze versie kan de API alleen gegevens opvragen. Er wordt niets in uw account gewijzigd.

Dezelfde toegang als in het beheerpaneel

Een recht dat in het beheerpaneel wordt ingetrokken, geldt direct ook voor de API.

JSON via HTTPS

Antwoorden in JSON, datums in ISO 8601 met tijdzone.

Indeling van de antwoorden

Antwoorden zijn in JSON (UTF-8). Eén item staat in data; lijsten bevatten daarnaast meta, met de paginering.
Datums zijn in ISO 8601 met tijdzone, zoals 2026-11-03T14:32:10-03:00.
Elk item heeft een uid, dezelfde als in het beheerpaneel. Gebruik die om het item later op te vragen.
Een veld zonder waarde komt terug als null. Er kunnen op elk moment nieuwe velden bijkomen, dus negeer velden die u niet kent.

Begin hier

1Authenticatie: genereer een sleutel in Mijn account › API en stuur die mee in de header X-API-Key.
2Uw gebruiker: doe uw eerste verzoek om de sleutel te testen.
3Wat elke gebruiker kan zien: bekijk welke organisaties en items de sleutel kan opvragen.

Basis-URL

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

Wat u kunt opvragen

/meuw gebruiker en de gebruikte sleutel
/organizationsorganisaties en rechten
/tvsTV's en hun status
/filesgeüploade bestanden
/playlistsplaylists en hun items

Eerste verzoekcURLPHPJavaScript

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

Antwoord200

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