Primeros pasos

API de la plataforma

Con la API, sus sistemas pueden consultar las TVs, los archivos y las listas de reproducción de su cuenta sin abrir el panel. Úsela para mostrar el estado de las TVs en su propia herramienta de monitorización, comprobar qué se reproduce en cada pantalla o generar informes.

Cada clave ve exactamente lo mismo que ve en el panel el usuario al que pertenece: las mismas organizaciones y, en cada una de ellas, lo que sus permisos le dejan listar.

Solo lectura

En esta versión, la API solo consulta datos. No se modifica nada en su cuenta.

El mismo acceso que en el panel

Si retira un permiso en el panel, el cambio se aplica al instante en la API.

JSON sobre HTTPS

Respuestas en JSON y fechas en ISO 8601 con zona horaria.

Formato de las respuestas

Las respuestas están en JSON (UTF-8). Un elemento individual viene en data; los listados incluyen además meta, con la paginación.
Las fechas vienen en ISO 8601 con la zona horaria, por ejemplo 2026-11-03T14:32:10-03:00.
Cada elemento tiene un uid, el mismo que se usa en el panel. Utilícelo para volver a consultar el elemento más adelante.
Un campo sin valor viene como null. Se pueden añadir campos nuevos en cualquier momento, así que ignore los que no conozca.

Empiece por aquí

1Autenticación: genere una clave en Mi cuenta › API y envíela en la cabecera X-API-Key.
2Su usuario: haga la primera petición para probar la clave.
3Qué puede ver cada usuario: compruebe qué organizaciones y elementos puede consultar la clave.

URL base

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

Qué se puede consultar

/mesu usuario y la clave en uso
/organizationsorganizaciones y permisos
/tvsTVs y su estado
/filesarchivos subidos
/playlistslistas de reproducción y sus elementos

Primera peticióncURLPHPJavaScript

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

Respuesta200

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