เริ่มต้นใช้งาน

API ของแพลตฟอร์ม

API ช่วยให้ระบบของคุณดึงข้อมูลทีวี ไฟล์ และเพลย์ลิสต์ในบัญชีได้โดยไม่ต้องเปิดแผงควบคุม ใช้เพื่อแสดงสถานะทีวีในระบบมอนิเตอร์ของคุณ ตรวจสอบว่ากำลังเล่นอะไรอยู่บนแต่ละหน้าจอ หรือจัดทำรายงาน

คีย์แต่ละรายการเห็นข้อมูลเดียวกับที่ผู้ใช้เจ้าของคีย์เห็นในแผงควบคุมทุกประการ: องค์กรเดียวกัน และในแต่ละองค์กรจะเห็นเฉพาะสิ่งที่สิทธิ์ของผู้ใช้นั้นอนุญาตให้แสดงรายการ

อ่านอย่างเดียว

ในเวอร์ชันนี้ API ทำได้เพียงอ่านข้อมูล ไม่มีการเปลี่ยนแปลงใด ๆ ในบัญชีของคุณ

สิทธิ์เข้าถึงเหมือนแผงควบคุม

สิทธิ์ที่ถูกยกเลิกในแผงควบคุมจะมีผลกับ API ทันที

JSON ผ่าน HTTPS

การตอบกลับเป็น JSON และวันที่อยู่ในรูปแบบ ISO 8601 พร้อมเขตเวลา

รูปแบบการตอบกลับ

  • การตอบกลับเป็น JSON (UTF-8) รายการเดียวจะอยู่ใน data ส่วนการแสดงรายการจะมี meta ที่เก็บข้อมูลการแบ่งหน้ามาด้วย
  • วันที่อยู่ในรูปแบบ ISO 8601 พร้อมเขตเวลา เช่น 2026-11-03T14:32:10-03:00
  • ทุกรายการมี uid ซึ่งเป็นค่าเดียวกับที่ใช้ในแผงควบคุม ใช้ค่านี้เพื่อดึงข้อมูลรายการนั้นในภายหลัง
  • ฟิลด์ที่ไม่มีค่าจะเป็น null อาจมีการเพิ่มฟิลด์ใหม่ได้ทุกเมื่อ จึงควรข้ามฟิลด์ที่คุณไม่รู้จัก

เริ่มต้นที่นี่

  1. 1การยืนยันตัวตน: สร้างคีย์ใน บัญชีของฉัน › API แล้วส่งคีย์ในส่วนหัว X-API-Key
  2. 2ผู้ใช้ของคุณ: ส่งคำขอแรกเพื่อทดสอบคีย์
  3. 3ผู้ใช้แต่ละคนเห็นอะไรได้บ้าง: ดูว่าคีย์เข้าถึงองค์กรและรายการใดได้บ้าง

URL หลัก

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

ข้อมูลที่ดึงได้

  • /meผู้ใช้ของคุณและคีย์ที่กำลังใช้งาน
  • /organizationsองค์กรและสิทธิ์
  • /tvsทีวีและสถานะ
  • /filesไฟล์ที่อัปโหลด
  • /playlistsเพลย์ลิสต์และรายการในเพลย์ลิสต์
คำขอแรก
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();
การตอบกลับ200
{
  "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"
    }
  }
}