Web service-rajapinta

Web service -rajapinnan voidaan kutsua seuraavia operaatioita.

Operaatio	Metodi	URL-pohja	Parametrit
Kirjautuminen (käyttäjä)	POST	plc.php	user=[username] secret=[passwd]
Kirjautuminen (robotti)	GET	plc.php	&key=[keyString]&id=[idString]
Lue pisteen arvo	GET	plc.php	&get=[pointName]
Kirjoita pisteen arvo	GET	plc.php	&set=[pointName]&value=[json]
Historia-datan lukeminen	GET	plc.php	&historybuffer=[bufferName] &db=[historyfile]&time=[starttime]
Listaa pisteet	GET	plc.php	&list=[namefilter]&fields=[fieldfilter]

HUOM! Operaatioita voidaan suorittaa vain onnistuneen kirjautumisen jälkeen.

Rajapinnassa on kaksi eri kirjautumistapaa:
    • POST-pohjainen kirjautuminen on tarkoitettu ihmisten käytettäväksi käyttöpaneeleiden kautta. Luo uuden session. (ei siis                yleensä web service käyttöön).
    • GET-pohjainen (shared key -tyyppinen) kirjautuminen on tarkoitettu roboteille ja automaattisten tiedonkeräysjärjestelmien              käytettäväksi (ei luo sessiota).

Jaettu tunnistautumisavain syötetään laitteeseen käyttöönoton yhteydessä. Rajapinnan tarjoama data on JSON-muotoista.

Versiossa 3 voi valvomon kautta suorittaa kyselyjä myös ala-asemille. Tällöin ala-aseman NodeID annetaan "remote" -parametrina, mutta muilta osin komento on sama.