Primeros pasos

API de la plataforma

Con la API, tus sistemas pueden consultar las TVs, los archivos y las listas de reproducción de tu cuenta sin entrar al panel. Usala para mostrar el estado de las TVs en tu propio monitoreo, chequear qué se está reproduciendo en cada pantalla o armar reportes.

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

Solo lectura

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

El mismo acceso que en el panel

Si sacás un permiso en el panel, el cambio rige 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 también traen 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. Usalo para volver a consultar el elemento más adelante.
  • Un campo sin valor viene como null. Se pueden agregar campos nuevos en cualquier momento, así que ignorá los que no conozcas.

Empezá por acá

  1. 1Autenticación: generá una clave en Mi cuenta › API y enviala en el encabezado X-API-Key.
  2. 2Tu usuario: hacé la primera solicitud para probar la clave.
  3. 3Qué puede ver cada usuario: fijate qué organizaciones y elementos puede consultar la clave.

URL base

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

Qué se puede consultar

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