Bắt đầu

Mỗi người dùng thấy được gì

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. Không cần cấu hình gì trong API: các quy tắc đến từ tổ chức và quyền của người dùng.

Chỉ các tổ chức của người dùng

API chỉ xét các tổ chức được liên kết với người dùng, cũng là những tổ chức họ có thể chọn trong bảng điều khiển.

Quản trị viên thấy mọi thứ của tổ chức

Quản trị viên của tổ chức, hoặc của tổ chức chính, thấy tất cả TV, tệp và danh sách phát của tổ chức đó.

Những người khác tùy theo quyền

Với những người dùng khác, áp dụng quyền xem TV, tệp và danh sách phát trong từng tổ chức, cũng là các quyền mở các trang đó trong bảng điều khiển.

Thay đổi có hiệu lực ngay

Việc gỡ quyền, xóa tổ chức hoặc vô hiệu hóa người dùng trong bảng điều khiển có hiệu lực ngay từ yêu cầu tiếp theo.

Những gì bị loại ra

Các mục thuộc tổ chức không có quyền sẽ không xuất hiện trong kết quả liệt kê. Truy vấn trực tiếp một mục như vậy sẽ trả về 404, như thể mục đó không tồn tại.
Trong một danh sách phát, tệp mà người dùng không được xem sẽ có file bằng null. Các TV của một danh sách phát và các danh sách phát chứa một tệp chỉ hiển thị những gì người dùng được xem.
Các mục đã xóa và TV chưa được kích hoạt sẽ không xuất hiện.

Để biết một khóa có thể truy vấn những gì, hãy gọi /organizations: mỗi tổ chức đi kèm admin và permissions.

Nếu hệ thống của bạn chỉ cần một phần dữ liệu, hãy tạo trong bảng điều khiển một người dùng riêng cho hệ thống đó, chỉ với các quyền cần thiết, rồi tạo khóa trong tài khoản của người dùng này.

Yêu cầucURLPHPJavaScript

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/organizations');
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/organizations', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Phản hồi200

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}

Mục của tổ chức khác404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}