API v Money S3

Co je to API?

API (Application Programming Interface) je rozhraní pro komunikaci mezi různými aplikacemi. Pomocí API můžou jiné aplikace (eshopy, mobilní appky a podobně) načítat údaje z Money S3 a také je i do Money S3 zapisovat (například načíst údaje o stavu zásob a zapsat do Money S3 objednávku nebo fakturu).

Na rozdíl od dosud možné XML výměny dat nevyžaduje fyzickou výměnu souborů, kde bylo nutné zabezpečit, jak daný XML soubor dostat z jedné aplikace do druhé. Tyto a jiné limity souborové výměny dat dokáže použití API eliminovat.

Ukažme si to na příkladu mobilní aplikace, která umožňuje vystavení faktury přímo u zákazníka. Po jejím uložení ji odešleme do Money S3, tam se zařadí do fronty importu a po zpracování se v Money S3 vytvoří.

Informace pro vývojáře

Pro propojení je nutné, aby druhá aplikace uměla komunikovat s Money S3 přes API. Buď už má toto řešení připravené nebo je možné ho dopracovat – více informací pro vývojáře API napojení na Money S3 najdete zde. Jakékoli otázky k napojení přes API směrujte na mailovou adresu api@money.cz

Rozsah přenášených dat přes API

Uvádíme aktuální rozsah oblastí, ve kterých je přes API možné načítat a zapisovat údaje. Podrobný popis polí a jejich vlastností (tedy zda jsou jen pro čtení nebo i pro zápis) je uveden v informacích pro vývojáře.

Instalace API

Instalaci API spustíte v rámci průvodce instalací Money S3.

INFO: instalaci spustíte přes kompletní instalační balík. Aktuální kompletní instalační balík Money S3 najdete po zadání licenčního čísla zde - https://zakportal.money.cz/Links/Default.aspx

1. Po spuštění instalace zvolíte Nastavení instalace

2. V dalších oknech pokračujete tlačítkem Pokračovat až do okna na obrázku, kde zakliknete Služba S3Api.

3. Následně proběhne instalace (případně aktualizace) Money S3 a na jejím konci se spustí instalace S3Api. Na úvodní obrazovce potvrdíte Instalovat. Během instalace se nabídne webové rozhraní, kde nastavíte:

• Úroveň logování: můžete ponechat na Varování
• Vidíte zde licenční číslo Money S3 a pod ním informaci zda je zakoupen modul S3 Api. Bez něj nelze vytvořit doménu
• Vaše doména: ten si vymyslíte nebo ji Vám dodá aplikace, která se bude na Money S3 napájet (název domény musí být jedinečný a nesmí obsahovat tečku).
• Tunnel povolen: doporučujeme zakliknout
• Potvrdíte tlačítkem Nastavit.

4. Tímto je instalace API dokončena.

Nastavení API v Money S3

1. Aby bylo možné nastavit API v Money S3, je nutné mít zakoupený rozšiřující modul API (pokud jej nemáte, kontaktujte naše obchodní oddělení na obchod@money.cz nebo 549 522 511).

2. Pro účely napojení jiné aplikace na Money S3 je nutné mít vygenerovaný Klíč API. Najdete je přes Nástroje / S3Api / Klíče API.

3. Tlačítkem Přidat nebo Přidat a generovat vytvoříte nový klíč. Rozdíl mezi nimi je v tom, že u druhé možnosti se Client ID a Client Secret vygenerují automaticky. Tyto dva údaje jsou důležité a je potřeba je zadat do aplikace, která se na Money S3 napojuje. Pro každou aplikaci napojující se na Money S3 vytvořte nový klíč.

Na Kartě klíče API je možné přidat Uživatele (zvolený uživatel pro API nesmí obsahovat mezeru). Právě ten určuje, jaké údaje bude moct daná aplikace číst, případně zapisovat – např. chcete definovat, aby aplikace mohla číst informace jen o skladových zásobách, ale nechcete, aby měla přístup k fakturám nebo objednávkám. Pokud nevyberete žádného uživatele, daná aplikace bude mít přístup ke všem údajům dostupným přes API (viz výše Rozsah přenášených dat přes API).

4. Aby nebylo nutné při importu záznamů je po jednom potvrzovat, je možné nastavit úlohu v S3 Automaticu. Ten najdete přes Nástroje / S3 Automatic. Zde tlačítkem Přidat úlohu, přidáte novou úlohu, kde z roletové nabídky vyberete S3Api – fronta XML importu.

Tato úloha zabezpečí, aby se automaticky importovaly nové požadavky na zápis. Volitelně si v záložce Nastavení e-mailu můžete nastavit posílání výsledku zpracovaní importu – např. jen v případě chyby.

Průběh výměny dat přes API

1. Čtení dat z Money S3 přes API probíhá na pozadí, v reálném čase a bez jakéhokoli zásahu uživatele.

2. Zápis do Money S3 je asynchronní, posílané údaje se zapíšou do fronty a odtud se postupně zapisují do dát Money S3.

3. Frontu importu je možné najít přes Nástroje / S3Api / Fronta importu.

4. Zde vidíte všechny záznamy pro zápis a také výsledek jejich zpracování, případně důvod, proč se záznam nezapsal. Zápis záznamu můžete spustit i ručně tlačítkem Importovat (např. nenaimportovala se faktura, protože na skladu nebyl dostatečný počet kusů. Po vyřešení situace můžete FA doimportovat).