Başlarken

Platform API'si

API sayesinde sistemleriniz, kontrol panelini açmadan hesabınızdaki TV'leri, dosyaları ve oynatma listelerini sorgulayabilir. TV'lerin durumunu kendi izleme sisteminizde göstermek, her ekranda neyin oynatıldığını kontrol etmek veya rapor hazırlamak için kullanabilirsiniz.

Her anahtar, sahibi olan kullanıcının kontrol panelinde gördüklerinin tam olarak aynısını görür: aynı kuruluşları ve her kuruluşta, kullanıcının izinlerinin listelemesine olanak tanıdığı öğeleri.

Salt okunur

Bu sürümde API yalnızca sorgulama yapar. Hesabınızda hiçbir şey değiştirilmez.

Kontrol paneliyle aynı erişim

Kontrol panelinde kaldırılan bir izin API için de anında geçerli olur.

HTTPS üzerinden JSON

Yanıtlar JSON biçiminde, tarihler saat dilimiyle birlikte ISO 8601 biçimindedir.

Yanıt biçimi

  • Yanıtlar JSON (UTF-8) biçimindedir. Tek bir öğe data içinde gelir; listelerde ayrıca sayfalama bilgilerini içeren meta bulunur.
  • Tarihler saat dilimiyle birlikte ISO 8601 biçiminde gelir, ör. 2026-11-03T14:32:10-03:00.
  • Her öğenin, kontrol panelinde kullanılanla aynı olan bir uid değeri vardır. Öğeyi daha sonra sorgulamak için bu değeri kullanın.
  • Değeri olmayan alanlar null olarak gelir. Her an yeni alanlar eklenebilir; bu nedenle tanımadığınız alanları yok sayın.

Buradan başlayın

  1. 1Kimlik doğrulama: Hesabım › API bölümünde bir anahtar oluşturun ve anahtarı X-API-Key başlığında gönderin.
  2. 2Kullanıcınız: Anahtarı test etmek için ilk isteğinizi gönderin.
  3. 3Her kullanıcı neleri görebilir: Anahtarın hangi kuruluşları ve öğeleri sorgulayabildiğini görün.

Temel URL

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

Neleri sorgulayabilirsiniz

İlk istek
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();
Yanıt200
{
  "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"
    }
  }
}