Kom igång

Plattformens API

Med API:et kan dina system hämta TV-apparaterna, filerna och spellistorna i ditt konto utan att öppna kontrollpanelen. Använd det för att visa TV-apparaternas status i din egen övervakning, kontrollera vad som visas på varje skärm eller ta fram rapporter.

Varje nyckel ser exakt det som dess användare ser i kontrollpanelen: samma organisationer och, i varje organisation, det som användarens behörigheter tillåter att listas.

Endast läsning

I den här versionen kan API:et bara läsa data. Ingenting i ditt konto ändras.

Samma åtkomst som i kontrollpanelen

En behörighet som tas bort i kontrollpanelen gäller direkt även för API:et.

JSON över HTTPS

Svar i JSON och datum i ISO 8601 med tidszon.

Svarsformat

Svaren är i JSON (UTF-8). Ett enskilt objekt kommer i data; listor innehåller även meta med sidindelningen.
Datum anges i ISO 8601 med tidszon, till exempel 2026-11-03T14:32:10-03:00.
Varje objekt har ett uid, samma som används i kontrollpanelen. Använd det för att hämta objektet senare.
Ett fält utan värde returneras som null. Nya fält kan läggas till när som helst, så ignorera fält som du inte känner igen.

Börja här

1Autentisering: generera en nyckel under Mitt konto › API och skicka den i headern X-API-Key.
2Din användare: gör ditt första anrop för att testa nyckeln.
3Vad varje användare kan se: se vilka organisationer och objekt nyckeln kan hämta.

Bas-URL

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

Det här kan du hämta

/medin användare och nyckeln som används
/organizationsorganisationer och behörigheter
/tvsTV-apparater och deras status
/filesuppladdade filer
/playlistsspellistor och deras objekt

Första anropetcURLPHPJavaScript

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

Svar200

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