Jak funguje API a k čemu slouží
API (Application Programming Interface) je rozhraní, přes které si různé systémy předávají data automaticky. Představte si to jako číšníka v restauraci – vy (jeden program) řeknete, co chcete, číšník (API) to odnese do kuchyně (druhý program nebo systém), a pak vám přinese hotové jídlo – tedy data nebo výsledek. Díky API spolu mohou systémy automaticky sdílet informace, aniž by je musel člověk ručně přepisovat.
Technicky to funguje podobně jako otevření webové stránky – jen místo člověka v prohlížeči komunikuje jiný program. Požadavky se posílají na konkrétní URL adresy (tzv. API endpointy) a odpovědi chodí zpět ve strukturované podobě, nejčastěji jako JSON nebo XML uzpůsobené struktuře daného programu.
Jak API aktivovat ve Flexi
API není automaticky součástí licence, nejprve je potřeba mít API aktivované jako službu:
ve webové aplikaci přejděte do Nastavení -> záložka Licence a předplatné a aktivujte službu (předpokladem je uživatel s oprávněním Spravovat licence)
nebo kontaktujte obchodní oddělení a požádejte o aktivaci API služby k vaší licenci
Založení API uživatele
API ve Flexi funguje na principu komunikace skrz tzv. API uživatele, pod jehož loginem bude vedena veškerá aktivita napojené aplikace po API. Pokud tedy eshop vytváří objednávky, založení a úpravy těchto objednávek budou v přehledu změn vidět jako úpravy od tohoto uživatele.
Po aktivaci služby přejděte do sekce správy uživatelů, kde založíte API uživatele.
Webové rozhraní
Nastavení -> Přehled uživatelů -> v pravé horní části použijte tlačítko Založit uživatele a jako Typ uživatele vybereme API přístup.
Další údaje vyplníme dle potřeby a účelu uživatele, unikátní přihlašovací jméno, bezpečné heslo, role dle agend, kam bude API uživatel přistupovat a firmu, kam bude mít přístup.
Desktopová aplikace
Horní menu -> Nástroje -> Uživatelé ve firmě, nad seznamem stávajících uživatelů použijte tlačítko Nový, přejděte do záložky Přihlašovací údaje a jako Typ uživatele vybereme REST API.
Další údaje vyplníme dle potřeby a účelu uživatele, bezpečné heslo, unikátní přihlašovací jméno, role dle agend, kam bude API uživatel přistupovat. Oproti webové aplikaci nelze přiřadit uživatele jedním klikem do vícero firem, pokud stejného uživatele chcete přidat i do dalších firem, zaškrtněte "Přidávat uživatele z jiné firmy".
API uživatel vs "Normální" uživatel
Prvním rozdílem mezi uživateli je licencování, zatímco každý Normální uživatel pro zápis potřebuje hrazenou licenci, po aktivaci API služby můžete založit neomezené množství API uživatelů pro zápis bez nutnosti licence - doporučujeme pro každé napojení jednoho API uživatele.
Druhým rozdílem je, že Normální uživatel nemá přístup k API, tu má jen API uživatel. Hlavním důvodem je sdílení hesla uživatele s externí aplikací, což je potenciální riziko.
Třetím rozdílem je, že API uživatel se nepřihlásí do aplikací jako normální uživatel.
Co potřebuje externí aplikace k zápisu do Flexi?
Jak jsme si již řekli, komunikace probíhá přes API uživatele, aby tedy došlo k zápisu do Flexi, externí aplikace se musí do Flexi "přihlásit" a to udělá s přístupovými údaji API uživatele. Dále je třeba aplikaci dodat odkaz na vaše Flexi, který v případě, že máte data u nás v cloudu, končí flexibee.eu., port je vždy stejný, 5434 a id firmy, které snadno zjistíte z URL webové aplikace.
Pokud jste na vlastním serveru, pak je odkazem veřejná IP adresa serveru a port se může lišit v závislosti na nastavení serveru.
Příklad údajů:
login: api_uzivatel
heslo: DyQdsgg+12
odkaz: demo.flexibee.eu
port: 5434
id firmy: demo_firma (z URL demo.flexibee.eu/c/demo_firma/)
Další požadované informace záleží na požadavcích aplikace, kterou napojujete.
Slovníček
XML - Formát pro přenos dat mezi systémy. Data jsou zapsaná pomocí značek (např. <faktura>...</faktura>). Používá se hlavně u starších nebo robustnějších integrací.
JSON - Moderní a jednodušší formát pro přenos dat. Je přehlednější než XML a dnes se používá nejčastěji. Vypadá jako seznam položek a hodnot ve složených závorkách.
URL - Webová adresa, na kterou se (v API) posílá požadavek (běžný uživatel to zná jako adresu např. seznam.cz). U API to není stránka pro člověka, ale adresa, na kterou se obrací jiný systém pro data.
Request (požadavek) - Zpráva, kterou jedna aplikace posílá druhé přes API, obsahuje XML nebo JSON kód, který vyjadřuje zasílané / stahované doklady, nastavení apod.
API endpoint - Konkrétní URL adresa v API, která slouží pro určitou činnost nebo typ dat. Například jeden endpoint vrací faktury, jiný objednávky (např. demo.flexibee.eu/c/demo/faktura-vydana.xml vypíše všechny faktury v XML).
Timeout - Situace, kdy server druhé strany neodpoví včas. Spojení se po určité době automaticky ukončí a operace se nepovede.
HTTP/HTTPS - Způsob, jakým spolu komunikují webové služby. HTTP je běžné spojení, HTTPS je zabezpečené (šifrované) spojení, které chrání přenášená data.
FAQ
Instalovali jsme po velmi dlouhé době novou verzi Flexi a API přestalo fungovat
Pokud jste aktualizovali z verze starší než 2025.5.0 na nejnovější, ověřte, zda máte aktivní API službu - od 1.1.2025 proběhla změna z plateb za počet API uživatelů na jednotnou API službu.
Mám instalované Flexi lokálně na jednom zařízení a chci využívat API službu
Pro napojení bude třeba založit veřejnou IP adresu a provést některá ze serverových nastavení, aby mohlo Flexi přijímat API requesty z internetu a zároveň byla vaše síť chráněna. Pokud se Vám to zdá složité, řešením také může být přechod na náš cloud, kde nemusíte po aktivaci API služby nic dalšího řešit, stačí obnovit aktuální zálohu dat firmy a můžete pokračovat, kde jste přestali.