Primers passos

API de la plataforma

Amb l'API, els vostres sistemes poden consultar les TV, els fitxers i les llistes de reproducció del vostre compte sense obrir el tauler. Feu-la servir per mostrar l'estat de les TV a la vostra eina de monitoratge, comprovar què s'està reproduint a cada pantalla o elaborar informes.

Cada clau veu exactament el mateix que veu al tauler l'usuari a qui pertany: les mateixes organitzacions i, en cadascuna, allò que els seus permisos li permeten llistar.

Només lectura

En aquesta versió, l'API només consulta dades. No es modifica res del vostre compte.

El mateix accés que al tauler

Si retireu un permís al tauler, el canvi s'aplica a l'API a l'instant.

JSON sobre HTTPS

Respostes en JSON i dates en ISO 8601 amb fus horari.

Format de les respostes

Les respostes són en JSON (UTF-8). Un element individual es retorna a data; els llistats també inclouen meta, amb la paginació.
Les dates s'expressen en ISO 8601 amb el fus horari, per exemple 2026-11-03T14:32:10-03:00.
Cada element té un uid, el mateix que s'utilitza al tauler. Feu-lo servir per tornar a consultar l'element més endavant.
Un camp sense valor es retorna com a null. Es poden afegir camps nous en qualsevol moment, així que ignoreu els que no conegueu.

Per on començar

1Autenticació: genereu una clau a El meu compte › API i envieu-la a la capçalera X-API-Key.
2El vostre usuari: feu la primera sol·licitud per provar la clau.
3Què pot veure cada usuari: comproveu quines organitzacions i quins elements pot consultar la clau.

URL base

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

Què es pot consultar

/meel vostre usuari i la clau en ús
/organizationsorganitzacions i permisos
/tvsTV i el seu estat
/filesfitxers pujats
/playlistsllistes de reproducció i els seus elements

Primera sol·licitudcURLPHPJavaScript

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

Resposta200

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