Bắt đầu

API của nền tảng

Với API, hệ thống của bạn có thể đọc TV, tệp và danh sách phát trong tài khoản mà không cần mở bảng điều khiển. Hãy dùng API để hiển thị trạng thái TV trong hệ thống giám sát của bạn, kiểm tra nội dung đang phát trên từng màn hình hoặc lập báo cáo.

Mỗi khóa thấy đúng những gì người dùng của khóa đó thấy trong bảng điều khiển: cùng các tổ chức và, trong mỗi tổ chức, những gì quyền của người dùng đó cho phép liệt kê.

Định dạng phản hồi

• Phản hồi ở dạng JSON (UTF-8). Một mục được trả về trong data; kết quả liệt kê còn có thêm meta chứa thông tin phân trang.
• Ngày giờ theo ISO 8601 kèm múi giờ, ví dụ 2026-11-03T14:32:10-03:00.
• Mỗi mục có một uid, giống với uid dùng trong bảng điều khiển. Dùng uid này để truy vấn lại mục đó sau này.
• Trường không có giá trị sẽ là null. Trường mới có thể được thêm vào bất cứ lúc nào, vì vậy hãy bỏ qua những trường bạn không nhận ra.

Bắt đầu từ đây

1. 1Xác thực: tạo khóa trong Tài khoản của tôi › API và gửi khóa trong header X-API-Key.
2. 2Người dùng của bạn: gửi yêu cầu đầu tiên để kiểm tra khóa.
3. 3Mỗi người dùng thấy được gì: xem khóa có thể truy vấn những tổ chức và mục nào.

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

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