Inštalácia služby API

PREMIER API je nutné nainštalovať (rozbaliť) na disk serveru, kde je lokálne uložený program PREMIER.
Súbor, potrebný na inštaláciu Vám zašleme po objednaní tejto služby. Po stiahnutí ZIP súboru, rozbaľte prosím obsah priamo na lokálny disk C:\ . V ZIP súbore je adresár www_api, ktorý sa tak vytvorí na disku, napr. C:\ www_api

Pre prístup do API je najskôr nutné nastaviť požadovanú jednotku, ktorá je už v SQL dátach. Po otvorení adresára www_api nájdeme súbor "ApiComPremForm.exe", zobrazí sa hlavný dialóg pre nastavenie.

Požiadavky

• SQL verzia Premier minimálne vo verzii MS SQL 2016 (platí aj pre edíciu Express)
• Voľba "Compatibility level" v administrácii SQL musí byť nastavená minimálne na "SQL Server 2016 (130)" - v opačnom prípade nemusia správne prebehnúť všetky príkazy

Základné nastavenie

V hornej časti nastavíme port, na ktorom bude webová služba načúvať. Default cesta k HTML je cesta do adresára www_api. Je možné zvoliť HTTP alebo HTTPS komunikáciu. Pre HTTPS komunikáciu je potrebné zriadiť certifikát pre danú doménu, ktorý sa potom nastaví v dialógu nižšie. V spodnej časti je potom možné pridať účtovnú jednotku, ktorá bude na API napojená. Pridať jednotku je možné kliknutím na tlačidlo so symbolom PLUS.

Premier path je cesta do adresára \premier\ - priamo na root zložky, tam kde sa nachádza "premier.exe". Po zadaní cesty, klikneme na tlačidlo "R", načíta sa tým zoznam všetkých účtovných jednotiek, z ktorého potom vyberieme požadovanú jednotku. Po výbere sa nižšie zobrazí názov SQL server a typ autorizácie. Tieto údaje sú len na čítanie. Je vhodné v tejto fáze overiť spojenie s SQL serverom - "Test pripojenia". Ak je spojenie v poriadku môžeme vygenerovať tzv. ID_UJ (ID účtovnej jednotky), ktoré už po uložení nemeňte. V prípade zmeny musíte o tomto informovať vývojárov, ktorí Vám riešia túto komunikáciu s Vašim SW.

"Asynchrónna komunikácia" default - nezaškrtnuté.
Pri komunikácii sa vytvorí kanál medzi serverom a klientom. Ak sa v rámci kanálu posiela viac požiadaviek na viac firiem, neodporúčame zapínať!

"Asynchrónne komunikácia" - zaškrtnuté.
Túto voľbu zapnite vtedy, ak SW tretej strany zabezpečia, že vždy bude čakať na odpoveď zo servera a zároveň sa potrebuje pripájať na API z viacerých klientov (rôzne IP). Súbežne sa vykoná niekoľko príkazov naraz a komunkácia tak bude rýchejšia. Je to vhodné pre nové HTML funkcie ako sú načítanie dokumentov z odkazov v emailoch a podobne.

Posledné políčko je www_path, je to zase adresár C:\www_api\. Potom už len uložíme dialóg a sme späť v hlavnom okne, kde už na prvom riadku je zobrazený "Názov jednotky a jej číslo". Po kliknutí Uložiť na hlavnom okne, sa spustí automatická registrácia DLL knižníc na SQL server. Aby bolo možné zaregistrovať na strane SQL servera tieto knižnice a vytvoriť tak potrebné procedúry CLR na strane SQL servera, musí účet, ktorý je nastavený v IS PREMIER byť sysadmin účtom. Treba len pre toto nastavenie a inštaláciu. Bez sysadmin účtu nie je možné pokračovať ďalej a CLR procedúry sa nevytvoria. Ak sa vytvoria procedúry, na obrazovke prebehne len malý dialóg, že prebieha registrácia funkcií.

Ak je všetko v poriadku, môžeme všetko uložiť a dialóg zatvoriť.

Inštalácia služby

Ďalším krokom je inštalácia a nastavenie služby vo Windows.
Spustíme príkazový riadok "ako správca", prepneme sa do adresára C:\www_api a zadáme príkaz:

apicompremservice -install

Podobný postup je tiež pre odinštalovanie služby, len s parametrom -uninstall
Po inštalácii služby otvoríme vo Windows "Služby" a zmeníme účet, pod ktorým sa bude služba spúšťať. Je potrebné nastaviť konto zo skupiny správcov, ktorý má zároveň sysadmin práva na SQL server.
Po zmene je nutné službu reštartovať.

Aktualizácia služby API

Je tiež vhodné vykonať aktualizáciu samotnej služby. Tú vykonáme spustením súboru C:\www_api\ ApiComUpdate.exe. Zobrazí sa dialóg, kde budú automaticky vybrané moduly, potrebné k aktualizácii. Stačí len kliknúť na tlačidlo "Aktualizovať".

Všetko prebehne automaticky. Po aktualizácii je potrebné reštertovať službu ApiComPrem.

Webové rozhranie

Ak je všetko aktuálne, služba je spustená, môžeme v lokálnom PC spustiť prehliadač a vyskúšať základnú komunikáciu.
V prehliadači zadáme: http://IP_SERVERA:PORT napr. http://192.168.0.38:19901 - ak sme nepoužili certifikát pre SSL, inak bude zápis https:// .....  

Zobrazí sa webové rozhranie služby

Môžeme vyplniť požadované údaje a zadať JSON pre výstup, napríklad:

{
  "select": "select top 10 * from partnery"
}
 
nebo
 
{
  "command": {
    "inComm": "VERZEAPI"
  }
}

Výsledkom by mal byť výstup v pravej časti textového pola so zobrazením partnerov zadaných v účtovnej jednotke.