Memulai

API platform

Dengan API, sistem Anda dapat membaca TV, file, dan playlist di akun Anda tanpa membuka panel kontrol. Gunakan untuk menampilkan status TV di sistem pemantauan Anda, memeriksa apa yang sedang tayang di setiap layar, atau menyusun laporan.

Setiap kunci melihat persis apa yang dilihat penggunanya di panel kontrol: organisasi yang sama dan, di setiap organisasi, apa saja yang boleh ditampilkan sesuai izin pengguna tersebut.

Hanya baca

Pada versi ini, API hanya membaca data. Tidak ada yang diubah di akun Anda.

Akses sama dengan panel kontrol

Izin yang dicabut di panel kontrol langsung berlaku untuk API.

JSON melalui HTTPS

Respons dalam JSON, dengan tanggal dalam ISO 8601 beserta zona waktu.

Format respons

Respons berformat JSON (UTF-8). Satu item dikirim dalam data; daftar juga menyertakan meta, yang berisi informasi paginasi.
Tanggal menggunakan ISO 8601 dengan zona waktu, seperti 2026-11-03T14:32:10-03:00.
Setiap item memiliki uid, sama dengan yang digunakan di panel kontrol. Gunakan untuk mengambil item tersebut nanti.
Field tanpa nilai dikirim sebagai null. Field baru dapat ditambahkan kapan saja, jadi abaikan field yang tidak Anda kenali.

Mulai di sini

1Autentikasi: buat kunci di Akun Saya › API dan kirimkan di header X-API-Key.
2Pengguna Anda: kirim permintaan pertama untuk menguji kunci.
3Apa yang dapat dilihat setiap pengguna: lihat organisasi dan item mana saja yang dapat dibaca dengan kunci tersebut.

URL dasar

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

Apa yang dapat dibaca

/mepengguna Anda dan kunci yang sedang digunakan
/organizationsorganisasi dan izin
/tvsTV dan statusnya
/filesfile yang diunggah
/playlistsplaylist dan item-itemnya

Permintaan pertamacURLPHPJavaScript

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

Respons200

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