Inkomba · Ama-TV
Bonisa ama-TV
GET
/v1/tvs
Ibonisa ama-TV enziwe asebenza ezinhlanganweni lapho umsebenzisi angabona khona ama-TV, ngokulandelana kwezinhlamvu.
Impendulo ehlukaniswe ngamakhasi: izinto ziza ku-data kanti ulwazi lwekhasi luza ku-meta. Amakhasi nezihlungi
Amapharamitha
| Igama | Uhlobo | Incazelo |
|---|---|---|
organization | string | I-uid yenhlangano, ukuze kulethwe izinto zayo kuphela (bona i-/organizations). |
q | string | Ingxenye yegama, kufika ezinhlamvwini ezingu-100. |
page | integer | Ikhasi, kusukela ku-1. Okuzenzakalelayo: 1. |
per_page | integer | Izinto ekhasini ngalinye, kusukela ku-1 kuya ku-100. Okuzenzakalelayo: 50. |
Izinkambu zento ngayinye
uidstring- Isihlonzi se-TV, esifanayo nesisetshenziswa ephanelini yokulawula.
namestring- Igama le-TV.
descriptionstring- Incazelo ye-TV (ingaba ngenalutho).
organizationobject- Inhlangano ye-TV:
uidne-name. playlistobject | null- Uhlu lokudlala lwe-TV (
uidne-name), nomanulluma lungekho. statusstringonline,alertnomaoffline, njengoba kuchazwe ngezansi.last_seen_atstring | null- Ukuxhumana kokugcina kwe-TV nenkundla, noma
nulluma ingakaze ixhume. activated_atstring | null- Isikhathi i-TV eyenziwe yasebenza ngaso.
app_versionstring- Inguqulo ye-app efakwe ku-TV.
osstring- Isistimu yokusebenza ye-TV, njenge-
android. deviceobject- Uphawu (
brand) nemodeli (model) yedivayisi, uma i-TV iyibika. timezonestring | null- Indawo yesikhathi ye-TV, njenge-
America/Sao_Paulo, nomanull.
Indlela isimo esibalwa ngayo
onlineukuxhumana kungaphansi kwemizuzu emi-3 edlule, iyadlalaalertukuxhumana phakathi kwemizuzu emi-3 nemi-9 edlule, noma i-TV isaqalaofflineakukho kuxhumana imizuzu eyi-10 noma ngaphezulu, noma ayikaze ixhume
Kungumthetho ofanayo nowemibala yesimo ephanelini yokulawula.
Amaphutha angenzeka
- 400
invalid_parameterIpharamitha inenani elingavumelekile, njenge-per_pageengaphezu komkhawulo ophezulu. - 404
organization_not_foundI-organizationenikeziwe akuyona inhlangano lapho umsebenzisi angabona khona lolu hlobo lwento. - Amaphutha okhiye nawomkhawulo asebenza kuwo wonke ama-endpoint. Bona wonke amaphutha
Isicelo
curl "https://api.on-cloud.live/v1/tvs?per_page=2" \
-H "X-API-Key: $API_KEY"<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?per_page=2');
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/tvs?per_page=2', {
headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();Impendulo200
{
"data": [
{
"uid": "d3d9446802a44259755d38e6d163e820",
"name": "Caixa 2",
"description": "",
"organization": {
"uid": "1679091c5a880faf6fb5e6087eb1b2dc",
"name": "Loja Shopping Norte"
},
"playlist": null,
"status": "offline",
"last_seen_at": "2026-11-01T18:04:51-03:00",
"activated_at": "2025-03-12T09:41:05-03:00",
"app_version": "3.12.83",
"os": "android",
"device": {
"brand": "Philco",
"model": "PTV32G70"
},
"timezone": "America/Sao_Paulo"
},
{
"uid": "c98cb8f9cc62887d1f6cf5693df9219c",
"name": "Recepção",
"description": "TV da entrada",
"organization": {
"uid": "8f14e45fceea167a5a36dedd4bea2543",
"name": "Loja Centro"
},
"playlist": {
"uid": "e4da3b7fbbce2345d7772b0674a318d5",
"name": "Lista principal"
},
"status": "online",
"last_seen_at": "2026-11-03T14:32:10-03:00",
"activated_at": "2025-03-12T09:41:05-03:00",
"app_version": "3.12.84",
"os": "android",
"device": {
"brand": "TCL",
"model": "43P635"
},
"timezone": "America/Sao_Paulo"
}
],
"meta": {
"page": 1,
"per_page": 2,
"total": 3,
"total_pages": 2
}
}