REST API pre merací systém nSoric

Konfiguračný súbor

Súbor server/goAPI/config.json.local premenuj na config.json a nastav správne parametre.

Nastavenie projektu

• go get github.com/gorilla/mux
• go get github.com/dgrijalva/jwt-go
• go get github.com/go-sql-driver/mysql
• go get github.com/jinzhu/gorm
• go get github.com/gorilla/handlers
• go get github.com/rs/cors
• go run main.go

Opis princípu API - login, manage

Model senzorického systému sa skladá z 2 základných častí:

• model používateľov a ich oprávnení (AUTH API)
• model samotnej aplikácie (MANAGE API)

Model používateľov a nastavení existuje vždy práve jeden. Obsahuje záznamy pre všetkých používateľov (z roznych inštálácií) a ich pridelených aplikácií. V tomto modely sú uložené informácie o všetkých inštaláciách sysnzorického systému. Každá inštalácia senzorického systému má svoju pridelenú databázu, kde sú ukladané nemerané hodnoty.

API v2 endpoints

AUTH API

base url: http://login.nsoric.com/nsoric/auth/

In all requests is need to authentificate with JWT token.

POST requests

• login/ - login to system (with login and poassword)
• user/ - create a new user (in login DB and application DB)

PUT requests

• user/ - modify user

DELETE requests

• user/{login} - delete user with given login. Note: delete user in Login and Application database

GET requests

• user/{login} - get user info

MANAGE API

base url: http://{app}.nsoric.com/{endpoint}/manage/

POST requests

• login/ - automatic login to application
• port/ - list of all ports
• port/{id} - selected port (by id)
• user/ - create APP user, also create new user in AUTH API database
• groupView/ - add groupArea record (add user tp area)

GET requests

• user/{login} - get info about user (areas, sectors)
• sector/{sectorID} - get info about sector (list of sensors)
• sector/{sectorID}/values/ - get measured sensor values from selected sector. Header parameter 'interval'
• sector/{sectorID}/last-values/ - get last measured values from sensors in selected sector.
• sensor/ - list all sensors (with details) *
• sensor/{sid} - sensor detail *
• area - get all areas

PUT requests

• port/ - modify communication port
• sensor/{sid} - modify sensor *
• user/{login} - modify application user

DELETE requests

• port/ - delete communication port
• user/{login} - delete application user, alse delete user in AUTH API database
• groupView/{userId}/{appId} - delete groupArea record (remove user from area)

| requres user rights: manage

STORE API

base url: http://{app}.nsoric.com/{endpoint}/store/

POST requests

• value/ - store measured valut to application database

GET requests

• config/ - get information about application confguration