API v Money S3

Čo je to API?

API (Application Programming Interface) je rozhranie na komunikáciu medzi rôznymi aplikáciami. Pomocou neho môžu iné aplikácie (eshopy, mobilné appky a podobne) načítavať údaje z Money S3 a tiež ich aj do Money S3 zapisovať (napríklad načítať údaje o stave zásob a zapísať do Money S3 objednávku alebo faktúru).

Na rozdiel od doteraz možnej XML výmeny dát nevyžaduje fyzickú výmenu súborov, kde bolo nutné zabezpečiť ako daný XML súbor dostať z jednej aplikácie do druhej. Tieto a iné limity súborovej výmeny dát dokáže použitie API eliminovať.

Ukážme si to na príklade mobilnej aplikácie, ktorá umožňuje vystavenie faktúry priamo u zákazníka. Po jej vytvorení ju odošlem do Money S3 a tam sa zaradí do fronty na import a po spracovaní sa v Money S3 vytvorí.

Informácie pre vývojárov

Na prepojenie je nutné aby druhá aplikácia vedela komunikovať s Money S3 cez API. Buď už má takéto riešenie pripravené, alebo je možné ho dopracovať – viac informácií pre vývojárov API napojenia na Money S3 nájdete TU. Akékoľvek otázky k napojeniu cez API smerujte na mailovú adresu api@money.sk

Rozsah prenášaných dát cez API

Uvádzame aktuálny rozsah oblastí pre ktoré je cez API možné načítavať a zapisovať údaje. Podrobný popis polí a ich vlastností (teda či sú len na čítanie alebo aj na zápis) je uvedený v informáciách pre vývojárov.

Inštalácia API

Inštaláciu API spustíte v rámci sprievodcu inštaláciou Money S3.

INFO: inštaláciu spustíte znova cez kompletný inštalačný balík. Aktuálny kompletný inštalačný balík Money S3 nájdete po zadaní licenčného čísla tu - https://clientportal.money.sk/Links/Default.aspx

1. Po spustení inštalácie zvolíte Nastavenie inštalácie

2. V ďalších oknách pokračujete tlačidlom Pokračovať až do okna na obrázku, kde zakliknete Služba S3Api.

3. Následne prebehne inštalácia (prípadne aktualizácia) Money S3 a na jej konci sa spustí inštalácia S3Api. Na úvodnej obrazovke potvrdíte Inštalovať. V priebehu inštalácie sa ponúkne webové rozhranie, kde nastavíte:

• Vaša doména: tú si vymyslíte alebo Vám ju dodá aplikácia, ktorá sa bude na Money S3 napájať (názov domény musí byť jedinečný a nesmie obsahovať bodku)
• Úroveň logovania: odporúčame ponechať na Varovania
• Vidíte tu licenčné číslo Money S3 a pod ním informáciu či je zakúpený modul S3 Api. Bez neho nie je možné vytvoriť doménu
• Tunel povolený: odporúčame zakliknúť, umožní aby s Money mohla komunikovať aj API aplikácia, ktorá nebude na tom istom PC
• Potvrdíte tlačidlom Nastaviť.

4. Týmto je inštalácia API dokončená.

Nastavenie API v Money S3

1. Pre možnosť nastaviť API v Money S3 je nutné mať zakúpený rozširujúci modul API (v prípade ak ho nemáte, kontaktujte naše obchodné oddelenie obchod@money.sk alebo 02 / 492 12323).

2. Pre účely napojenia inej aplikácie na Money S3 je potrebné mať vygenerovaný Kľúč API. Nájdete ich cez Nástroje / S3Api / Kľúče API.

3. Tlačidlom Pridať alebo Pridať a generovať vytvoríte nový kľúč. Rozdiel medzi nimi je v tom, že pri druhej možnosti sa Client ID a Client Secret vygenerujú automaticky. Tieto 2 údaje sú dôležité a je ich potrebné zadať do aplikácie, ktorá sa na Money S3 napája. Pre každú aplikáciu napájajúcu sa na Money S3 vytvorte nový kľúč.

Na Karte kľúča API je možné pridať Používateľa (zvolený používateľ pre API nesmie obsahovať medzeru). Práve ten definuje aké všetky údaje bude môcť daná aplikácia čítať prípadne zapisovať – napr. chcete zadefinovať aby mohol čítať informácie len o skladových zásobách, ale nechcete aby mal prístup k faktúram alebo objednávkam. Ak nevyberiete žiadneho používateľa, tak daná aplikácia bude mať prístup ku všetkým údajom dostupným cez API (viď vyššie Rozsah prenášaných dát cez API).

4. Aby nebolo potrebné pri importe záznamov ich po jednom potvrdzovať je možné nastaviť úlohu v S3 Automaticu. Ten nájdete cez Nástroje / S3 Automatic. Tu tlačidlom Pridať úlohu, pridáte novú úlohu, kde z roletovej ponuky vyberiete S3Api – front XML importu.

Táto úloha zabezpečí, aby sa automaticky importovali nové požiadavky na zápis. Voliteľne si v záložke Nastavenie e-mailu viete nastaviť posielanie výsledky spracovania importu – napr. len v prípade chyby.

Priebeh výmeny dát cez API

1. Čítanie dát z Money S3 cez API prebieha na pozadí, v reálnom čase a bez akéhokoľvek zásahu používateľa.

2. Zápis do Money S3 je asynchrónny, teda poslané údaje sa zapíšu do fronty a odtiaľ sa postupne zapisujú do dát Money S3.

Frontu importu je možné nájsť cez Nástroje / S3Api / Front importu.

4. Tu je vidieť všetky záznamy na zápis a rovnako aj výsledok ich spracovania, prípadne dôvod prečo sa záznam nezapísal. Zápis záznamu viete odtiaľ spustiť aj ručne tlačidlom Importovať (napr. nenaimportovala sa faktúra, lebo na sklade nebol dostatočný počet kusov. Po vyriešení situácie, viete FA doimportovať).