Per iniziare

API della piattaforma

Con l'API, i tuoi sistemi possono consultare le TV, i file e le playlist del tuo account senza aprire il pannello di controllo. Usala per mostrare lo stato delle TV nel tuo sistema di monitoraggio, controllare cosa va in onda su ogni schermo o creare report.

Ogni chiave vede esattamente ciò che il suo utente vede nel pannello di controllo: le stesse organizzazioni e, in ciascuna organizzazione, ciò che i suoi permessi gli consentono di elencare.

Sola lettura

In questa versione, l'API serve solo a consultare. Nel tuo account non viene modificato nulla.

Stesso accesso del pannello

Un permesso rimosso nel pannello di controllo vale subito anche per l'API.

JSON su HTTPS

Risposte in JSON e date in formato ISO 8601 con fuso orario.

Formato delle risposte

Le risposte sono in JSON (UTF-8). Un singolo elemento arriva in data; gli elenchi includono anche meta, con la paginazione.
Le date sono in formato ISO 8601 con il fuso orario, ad esempio 2026-11-03T14:32:10-03:00.
Ogni elemento ha un uid, lo stesso usato nel pannello di controllo. Usalo per consultare l'elemento in seguito.
Un campo senza valore arriva come null. Possono essere aggiunti nuovi campi in qualsiasi momento, quindi ignora quelli che non conosci.

Inizia da qui

1Autenticazione: genera una chiave in Il mio account › API e inviala nell'intestazione X-API-Key.
2Il tuo utente: fai la prima richiesta per provare la chiave.
3Cosa può vedere ogni utente: scopri quali organizzazioni ed elementi può consultare la chiave.

URL di base

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

Cosa puoi consultare

/meil tuo utente e la chiave in uso
/organizationsorganizzazioni e permessi
/tvsTV e relativo stato
/filesfile caricati
/playlistsplaylist e relativi elementi

Prima richiestacURLPHPJavaScript

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

Risposta200

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