API

Prostredníctvom API je možný prístup tretích strán (systémov) získavať a pracovať s informáciami CMS.

Komunikácia

Komunikácia s API serverom prebieha prostredníctvom HTTP protokolu metódou: „POST“

Zoznam povinných parametrov hlavičky

• Content-Type: "application/x-www-form-urlencoded;application/json;"

Príklad jQuery:

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, textStatus, jqXHR) {
        let res_data=JSON.stringify(responseData);
    }
});

 
              

Čí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, textStatus, jqXHR) {
        let res_data=JSON.stringify(responseData);
    }
});

              

Odpoveď:

{
    "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)[get,set]

reqiesters - Pole registrov(Array). Položka je objekt s parametrami „path“ ako cesta k registru a „value“ hodnota registra pri API akcii „set“

Nastavenia

• Povolené: Povoliť a zakázať prístup do API
• Server - stav: Stav 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. Napríklad adresu v LAN.
• Server - Port: Port API servera

API kľúče

Zoznam profilov ktoré združujú zvolené cesty k API premenným. API kľúče sa používajú pri každom dopyte ako identifikátor prístupu. Parameter "api_key"

Pridajte nový kľuč (profile) a prepínačom povoľte.

Nastavenie API kľúča

• Názov: Pomenovanie API kľúča pre lepšiu identifikáciu
• Povolené: Povoliť zakázať API kľúč
• API kľúč: Hodnota API kľúča používaná pri dopytoch

Vyrovnávajúca pamäť

• Časový interval: Interval za ktorý sa synchronizujú aktuálne hodnoty z registrom.

Odosielanie udalostí

Používa sa v prípade keď používate vlastný server. Na tento server bude odoslaná udalosť ktorá nastane na registri.

API registre

V strome je potrebné zaškrtnúť registre do ktorých má mať príslušný API kľúč prístup. Z vetvy stromu sa potom tvorí prístupová cesta k registru ktorá sa používa v dopytoch.