Primeiros passos

API da plataforma

Com a API, os seus sistemas consultam as TVs, os ficheiros e as listas de reprodução da sua conta sem abrir o painel. Utilize-a para mostrar o estado das TVs no seu sistema de monitorização, verificar o que está a passar em cada ecrã ou criar relatórios.

Cada chave vê exatamente o mesmo que o respetivo utilizador vê no painel: as mesmas empresas e, em cada empresa, aquilo que as permissões desse utilizador lhe permitem listar.

Apenas leitura

Nesta versão, a API apenas consulta dados. Nada é alterado na sua conta.

O mesmo acesso do painel

Uma permissão retirada no painel aplica-se de imediato à API.

JSON sobre HTTPS

Respostas em JSON e datas em ISO 8601 com fuso horário.

Formato das respostas

As respostas são em JSON (UTF-8). Um item vem em data; as listagens trazem também meta, com a paginação.
As datas vêm em ISO 8601 com o fuso horário, como 2026-11-03T14:32:10-03:00.
Cada item tem um uid, o mesmo utilizado no painel. Utilize-o para consultar o item mais tarde.
Um campo sem valor vem como null. Podem ser adicionados novos campos a qualquer momento, por isso ignore os que não conhece.

Comece por aqui

1Autenticação: gere uma chave em A Minha Conta › API e envie-a no cabeçalho X-API-Key.
2O seu utilizador: faça o primeiro pedido para testar a chave.
3O que cada utilizador pode ver: veja que empresas e itens a chave pode consultar.

Endereço base

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

O que pode consultar

/meo seu utilizador e a chave em uso
/organizationsempresas e permissões
/tvsTVs e respetivo estado
/filesficheiros carregados
/playlistslistas de reprodução e respetivos itens

Primeiro pedidocURLPHPJavaScript

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