Documentação da API v1
Português (Portugal)
Idioma da documentação Os exemplos de código e os nomes dos campos são iguais em todos os idiomas.
Aceder ao painel

Primeiros passos

Paginação e filtros

As listagens (/tvs, /files e /playlists) são paginadas. Os itens vêm em data e as informações da página, em meta.

NomeTipoDescrição
pageintegerPágina, a partir de 1. Predefinição: 1.
per_pageintegerItens por página, de 1 a 100. Predefinição: 50.

Campos de meta

page integer
Página atual.
per_page integer
Itens por página.
total integer
Total de itens encontrados, em todas as páginas.
total_pages integer
Total de páginas.

Para obter tudo, comece em page=1 e avance até chegar a total_pages. Uma página depois da última devolve data vazio.

Filtros

Os filtros podem ser combinados entre si e com a paginação. O total de meta já tem em conta os filtros.

NomeTipoDescrição
organizationstringuid de uma empresa, para devolver apenas os itens dessa empresa (consulte /organizations).
qstringParte do nome, com até 100 caracteres.
typestringTipo de ficheiro, como image ou video. Apenas em /files.
archivedinteger1 para obter apenas os arquivados ou 0 para obter apenas os não arquivados. Apenas em /files.

Ordem

As TVs e as listas de reprodução vêm por ordem alfabética; os ficheiros, dos mais recentes para os mais antigos.

Pedido
curl "https://api.on-cloud.live/v1/tvs?per_page=2" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?per_page=2');
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/tvs?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();
Resposta200
{
  "data": [
    {
      "uid": "d3d9446802a44259755d38e6d163e820",
      "name": "Caixa 2",
      "description": "",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "playlist": null,
      "status": "offline",
      "last_seen_at": "2026-11-01T18:04:51-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.83",
      "os": "android",
      "device": {
        "brand": "Philco",
        "model": "PTV32G70"
      },
      "timezone": "America/Sao_Paulo"
    },
    {
      "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
      "name": "Recepção",
      "description": "TV da entrada",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "playlist": {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal"
      },
      "status": "online",
      "last_seen_at": "2026-11-03T14:32:10-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.84",
      "os": "android",
      "device": {
        "brand": "TCL",
        "model": "43P635"
      },
      "timezone": "America/Sao_Paulo"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}
Parâmetro inválido400
GET /v1/tvs?per_page=500

{
  "error": {
    "code": "invalid_parameter",
    "message": "per_page must be a number between 1 and 100."
  }
}