Primeiros pasos

API da plataforma

Coa API, os seus sistemas poden consultar as TV, os ficheiros e as listas de reprodución da súa conta sen abrir o panel. Úsea para mostrar o estado das TV na súa propia ferramenta de monitorización, comprobar que se está a reproducir en cada pantalla ou elaborar informes.

Cada chave ve exactamente o mesmo que ve no panel o usuario ao que pertence: as mesmas organizacións e, en cada unha, o que os seus permisos lle permiten listar.

Só lectura

Nesta versión, a API só consulta datos. Non se modifica nada na súa conta.

O mesmo acceso que no panel

Se retira un permiso no panel, o cambio aplícase ao instante na API.

JSON sobre HTTPS

Respostas en JSON e datas en ISO 8601 con fuso horario.

Formato das respostas

As respostas están en JSON (UTF-8). Un elemento individual vén en data; as listaxes inclúen ademais meta, coa paxinación.
As datas veñen en ISO 8601 co fuso horario, por exemplo 2026-11-03T14:32:10-03:00.
Cada elemento ten un uid, o mesmo que se usa no panel. Úseo para volver consultar o elemento máis adiante.
Un campo sen valor vén como null. Poden engadirse campos novos en calquera momento, así que ignore os que non coñeza.

Por onde comezar

1Autenticación: xere unha chave en A miña conta › API e envíea na cabeceira X-API-Key.
2O seu usuario: faga a primeira solicitude para probar a chave.
3Que pode ver cada usuario: comprobe que organizacións e elementos pode consultar a chave.

Enderezo base

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

Que se pode consultar

/meo seu usuario e a chave en uso
/organizationsorganizacións e permisos
/tvsTV e o seu estado
/filesficheiros subidos
/playlistslistas de reprodución e os seus elementos

Primeira solicitudecURLPHPJavaScript

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