Táto téma Pomocníka obsahuje všeobecné informácie o webových službách systému OBERON.

Má OBERON REST API?

• Systém OBERON neposkytuje klasické REST API v zmysle architektúry RESTful, ako ju definuje štandard HTTP. Ponúka však vlastné webové služby, ktoré plnia rovnaký účel - umožňujú externým aplikáciám komunikovať so systémom OBERON.
• Webové služby OBERON sú založené na protokole SOAP (XML), ako aj dátovom formáte JSON, pričom JSON je vhodný najmä pre moderné webové a mobilné aplikácie.
• Ak vývojár hľadá REST API pre OBERON, v skutočnosti hľadá informácie o našich webových službách, ktoré poskytujú podobnú funkcionalitu - prístup k dátam, zápis údajov či integráciu s externými systémami. Inými slovami, OBERON síce nemá REST API v úzkom zmysle slova, ale ponúka porovnateľné rozhranie s podobným využitím.

Základné informácie

• Webovú službu predstavuje rozhranie (endpoint) definované IP adresou a TCP/IP portom na danom počítači. Uvedené rozhranie umožňuje iným aplikáciám (napr. ASTON, LUKUL a iným aplikáciám tretích strán) komunikovať so systémom OBERON.
• OBERON komunikuje s nadstavbovými modulmi, resp. aplikáciami pomocou protokolu SOAP a formátu XML alebo JSON (podľa požiadavky klienta). Komunikácia prebieha pomocou sieťového protokolu TCP/IP, pričom ako transportný protokol sa používa HTTP alebo zabezpečené HTTPS.
• Hlavnou výhodou webových služieb je nezávislosť od platformy a vývojového jazyka, preto sa často používajú (či už v režime server alebo klient) na on-line komunikáciu aj s inými externými systémami.
• Ako hostiteľ webovej služby (v režime server) sa využíva program OBERON Automation Center.
• Samotné webové služby sa nastavujú ako automatické úlohy v ponuke Servis, Automatické úlohy programu OBERON - Agenda firmy. Tu je možné nakonfigurovať jednu, prípadne aj viac webových služieb súčasne.
• Všeobecný postup inštalácie webovej služby je popísaný v téme Inštalácia webovej služby. Konkrétne postupy inštalácie webových služieb jednotlivých nadstavbových modulov, resp. aplikácií alebo iných externých systémov implementovaných do systému OBERON sú spravidla popísané jednotlivo v príslušných témach Pomocníka.
• V systéme OBERON je k dispozícii viacero typov automatických úloh pre webové služby:
  • WebServices API - OBERON G1 - predstavuje základnú webovú službu systému OBERON prvej generácie, ktorá zabezpečuje komunikáciu s nasledujúcimi nadstavbovými modulmi a aplikáciami:
    • OBERON Web - nadstavbová webová aplikácia, ktorá poskytuje vybrané manažérske informácie zo systému OBERON v reálnom čase.
    • OBERON eMenu - jednoduchý elektronický jedálny alebo nápojový lístok (OBERON eMenu), ktorý si môže zákazník prezerať na svojom mobilnom zariadení.
    • Rezervačný formulár ubytovania na internetovej stránke ubytovacieho zariadenia (web booking).
    • Pre check-in na elektronickú registráciu hosťa (hotel on-line check-in) pred samotným príchodom do ubytovacieho zariadenia.
    • Rýchly check-in na elektronickú registráciu hosťa (hotel on-line check-in) bezprostredne po príchode do ubytovacieho zariadenia a následnom prevzatí izby.
  • WebServices API - OBERON G2 - predstavuje základnú webovú službu systému OBERON druhej generácie, ktorá zabezpečuje komunikáciu s nasledujúcimi aplikáciami:   
    • ASTON - mobilný skladník - mobilná aplikácia pre Android určená na použitie so systémom OBERON.
  • WebServices API - Pokladnica OBERON G1 - predstavuje webovú službu prvej generácie určenú aplikáciám na prístup k Pokladnici OBERON, ktorá zabezpečuje komunikáciu s nasledujúcimi nadstavbovými modulmi, resp. aplikáciami:  
    • LUKUL - nielen mobilný čašník - viacúčelová mobilná gastroaplikácia pre Android určená na použitie so systémom OBERON.
    • Systém bonovacích monitorov - bonovacie monitory sa v systéme OBERON používajú na zobrazenie objednávok do kuchyne (na prípravu jedál) alebo baru (na prípravu nápojov) z Pokladnice OBERON prevádzkovanej v reštauračnom režime, prípadne z aplikácie LUKUL - nielen mobilný čašník.
  • WebServices API - Pokladnica OBERON G2 - predstavuje webovú službu druhej generácie určenú aplikáciám na prístup k Pokladnici OBERON, ktorá zabezpečuje komunikáciu s nasledujúcimi nadstavbovými modulmi, resp. aplikáciami:
    • OBERON Smart Display - mobilná aplikácia pre zariadenia s operačným systémom Android (prípadne Windows), ktorá umožňuje zobrazovanie údajov zákazníckeho displeja priamo na obrazovke tabletu alebo počítača.
    • Qerko - mobilná aplikácia pre zariadenia s operačným systémom Android - riešenie pre gastroprevádzky.
  • WebServices API - OBERON vernostný systém G1 - webová služba servera vernostného systému pre OBERON vernostný systém (klient) prvej generácie.
• Rozhranie webovej služby OBERON je popísané pomocou formátu WSDL - obsahuje všetky metódy, dátové typy parametrov metód, štruktúry atď. Na zobrazenie všetkých objektov je možné použiť aj vývojové prostredie Microsoft Visual Studio pri pridaní tzv. Service Reference.
• Prístup k určitým funkciám webovej služby typu OBERON je možné z dôvodu bezpečnosti obmedziť - je možné povoliť len určitú konkrétnu funkciu, pričom ostatné môžu byť zakázané.
• Metódy obsiahnuté v tejto webovej službe nie sú konečné, v prípade potreby je možné implementovať ďalšie požadované funkcie.

Tabuľka č. 1: Prehľad dostupných typov webových služieb v systéme OBERON

Typ automatickej úlohy pre webovú službu	Generácia	Podporované moduly a aplikácie
WebServices API - OBERON	G1	OBERON Web OBERON eMenu Rezervačný formulár ubytovania Pre check-in Rýchly check-in
WebServices API - OBERON	G2	ASTON - mobilný skladník
WebServices API - Pokladnica OBERON	G1	LUKUL - nielen mobilný čašník Systém bonovacích monitorov
WebServices API - Pokladnica OBERON	G2	OBERON Smart Display Qerko
WebServices API - OBERON vernostný systém	G1	OBERON vernostný systém (klient)

Dokumentácia k webovým službám

• Odkazy na dokumentáciu k webovým službám (referenčné príručky pre vývojárov) sú dostupné v téme Špecializovaná dokumentácia.

Technické informácie

• Pred nastavením automatickej úlohy v systéme OBERON sa uistite, že je na počítači, ktorý je neustále zapnutý (spravidla sieťovom databázovom serveri), správne nastavený server OBERON Automation Center. Postup nastavenia je dostupný v téme Nastavenie servera OBERON Automation Center. Správnosť nastavenia a fungovania servera OAC môžete skontrolovať v programe OBERON Automation Center (klient) (v programe OBERON - Agenda firmy, ponuka OBERON, OBERON Automation Center (klient)). Pri použití OBERON Automation Center odporúčame používať databázu SQL.
• Automatická úloha pre webovú službu sa vždy nastavuje na serveri (nie na klientskom počítači). Dôvodom je nutnosť registrácie (prípadne zrušenia registrácie) webovej služby priamo na počítači, kde bude táto služba hosťovaná.
• Počítač vyhradený na server webovej služby by mal mať pevnú IP adresu a na bráne firewall povolené príslušné komunikačné TCP/IP porty.
• V prípade využívania služby aj mimo lokálnej počítačovej siete je nevyhnutné nastaviť presmerovanie portu na smerovači (routeri) z verejnej IP adresy na IP adresu počítača v lokálnej sieti, na ktorom je služba spustená (predpokladá sa, že príslušná prevádzka má verejnú statickú IP adresu alebo dynamické DNS), pričom je nutné povoliť aj bránu firewall.
• OBERON Automation Center môže hosťovať súčasne aj viac od seba nezávislých webových služieb, ich počet je však obmedzený hardvérom počítača - jeho výkonom a hlavne operačnou pamäťou.
• Pre vývojárov a systémových integrátorov je k dispozícii on-line dokumentácia (referenčná príručka), ktorá obsahuje opis štruktúr a metód webových služieb.

Obrázok č. 1: Štruktúra systému OBERON z hľadiska vývojára