API
API umožňuje prístup tretích strán (systémov) na získavanie a spracovanie informácií v CMS.
Komunikácia
Komunikácia s API serverom prebieha cez protokol HTTP pomocou metódy POST.
Zoznam povinných parametrov hlavičky
- Content-Type: "application/x-www-form-urlencoded;application/json;"
Príklad: Nastavenie registrov
$.ajax({
headers: {
"Content-Type": "application/x-www-form-urlencoded, application/json"
},
type: "POST",
url: "http://192.168.5.40:86/",
crossDomain: true,
dataType: "json",
data: {
api_key: "8e930dfd384c0d4c0a29",
action: "set",
registers: [
{
path: "io.io_channel.out_switch.1.value",
value: { value: "tgl", exe: true }
},
{
path: "io.io_channel.out_switch.2.value",
value: { value: "tgl", exe: true }
}
]
},
success: function(responseData) {
console.log(JSON.stringify(responseData)); // Výpis odpovede do konzoly
}
});
Príklad: Čítanie z registrov
$.ajax({
headers: {
"Content-Type": "application/x-www-form-urlencoded, application/json"
},
type: "POST",
url: "http://192.168.5.40:86/",
crossDomain: true,
dataType: "json",
data: {
api_key: "8e930dfd384c0d4c0a29",
action: "get"
},
success: function(responseData) {
console.log(JSON.stringify(responseData)); // Výpis odpovede do konzoly
}
});
Odpoveď API:
{
"result": "ok",
"registers": [
{ "path": "io.io_channel.in_temperature.1.value", "value": 0 },
{ "path": "io.io_channel.in_binary.22.value", "value": true }
]
}
Štruktúra dát pre odoslanie
- api_key – API kľúč (String).
- action – Akcia dopytu (String). Možné hodnoty:
get
, set
.
- registers – Pole registrov (Array). Každá položka je objekt s parametrami:
- path – Cesta k registru.
- value – Hodnota registra pri API akcii
set
.
Nastavenia
- Povolené – Povolenie alebo zakázanie prístupu k API.
- Server – stav – Informácia o stave otvorenia komunikačného portu.
- Server – IP adresa – Použitá IP adresa servera. Hodnota
0.0.0.0
reprezentuje všetky adresy v sieťach CU, vrátane adresy v LAN.
- Server – Port – Port API servera.
API kľúče
API kľúče sú identifikátory prístupu, ktoré umožňujú prístup len k určeným cestám API premenných.
Pridajte nový kľúč (profil) a povoľte ho pomocou prepínača.
Nastavenie API kľúča
- Názov – Identifikačný názov API kľúča.
- Povolené – Povolenie alebo zakázanie API kľúča.
- API kľúč – Hodnota API kľúča používaná pri dopytoch.
Vyrovnávajúca pamäť
- Časový interval – Interval, v ktorom sa synchronizujú aktuálne hodnoty s registrom.
Odosielanie udalostí
Používa sa v prípade, že používate vlastný server. Na tento server bude odoslaná udalosť, ktorá nastane v registri.
API registre
V strome je potrebné zaškrtnúť registre, ku ktorým má mať príslušný API kľúč prístup. Z vetvy stromu sa následne vytvorí prístupová cesta k registru, ktorá sa používa v dopytoch.
Posledná úprava: 11.03.2025
Nenašli ste, čo ste hľadali?
Ak Vám v článku niečo chýba, alebo ste v ňom našli chybu, dajte nám o tom vedieť. Pomáhate nám tak zlepšovať naše produkty.