Kom i gang

Plattformens API

Med API-et kan systemene dine hente TV-ene, filene og spillelistene i kontoen din uten å åpne kontrollpanelet. Bruk det til å vise statusen til TV-ene i din egen overvåking, sjekke hva som vises på hver skjerm, eller lage rapporter.

Hver nøkkel ser nøyaktig det samme som brukeren ser i kontrollpanelet: de samme organisasjonene og, i hver organisasjon, det som brukerens tillatelser gir tilgang til å vise.

Kun lesing

I denne versjonen kan API-et bare hente data. Ingenting i kontoen din blir endret.

Samme tilgang som i kontrollpanelet

En tillatelse som fjernes i kontrollpanelet, gjelder umiddelbart også for API-et.

JSON over HTTPS

Svar i JSON og datoer i ISO 8601 med tidssone.

Svarformat

  • Svarene er i JSON (UTF-8). Ett enkelt element kommer i data; lister har i tillegg meta med sideinndelingen.
  • Datoer er i ISO 8601 med tidssone, for eksempel 2026-11-03T14:32:10-03:00.
  • Hvert element har en uid, den samme som brukes i kontrollpanelet. Bruk den til å hente elementet senere.
  • Et felt uten verdi returneres som null. Nye felter kan bli lagt til når som helst, så ignorer felter du ikke kjenner.

Start her

  1. 1Autentisering: Generer en nøkkel under Min konto › API og send den i headeren X-API-Key.
  2. 2Brukeren din: Send den første forespørselen din for å teste nøkkelen.
  3. 3Hva hver bruker kan se: Se hvilke organisasjoner og elementer nøkkelen kan hente.

Basis-URL

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

Dette kan du hente

Første forespørsel
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"
    }
  }
}