Tham chiếu · Tài khoản
Tổ chức
GET
/v1/organizations
Liệt kê các tổ chức mà người dùng có quyền truy cập và, với mỗi tổ chức, những gì họ có thể truy vấn qua API. Phản hồi này không phân trang.
Tham số
Endpoint này không nhận tham số.
Các trường của mỗi mục
uidstring- Mã định danh của tổ chức. Dùng trong tham số
organizationcủa các endpoint liệt kê. namestring- Tên tổ chức.
neutral_zonebooleantruenếu đây là tổ chức vùng trung lập, có tệp và danh sách phát mà mọi tổ chức khác đều dùng được.adminbooleantruenếu người dùng là quản trị viên của tổ chức hoặc của tổ chức chính. Khi đó, họ thấy mọi thứ của tổ chức.permissionsobject- Những gì người dùng có thể truy vấn trong tổ chức này.
permissions.tvsbooleantruenếu được xem TV.permissions.filesbooleantruenếu được xem tệp.permissions.playlistsbooleantruenếu được xem danh sách phát.
Các lỗi có thể gặp
- Lỗi về khóa và giới hạn yêu cầu áp dụng cho mọi endpoint. Xem tất cả lỗi
Yêu cầu
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
}
}
]
}