Faktury web API

Zkratka API z anglického Application Programming Interface je rozhraní pro programování aplikací. Obecně lze říci, že jde o soubor pravidel, postupů a funkcí, pomocí kterých lze propojit dva nezávislé systémy. V tomto případě jde o propojení Faktury webu například s vaším e-shopem nebo webem. Výsledkem bude vytvoření dokumentu faktury ve Faktury webu na základě dat pocházejících z vašeho e-shopu.

Představte si dvě vlakové stanice propojené železniční tratí. Ze stanice A pravidelně vyjíždí nákladní vlak, který veze data do stanice B. Tam se náklad zpracuje a vlak se následně vrací zpět s informací o výsledku. Přesně takto funguje i API Faktury webu.
Vaše aplikace, například e-shop, představuje stanici A. Faktury web je stanice B a vlak spolu s kolejnicemi představuje samotné API. Váš systém odešle požadavek s daty, která potřebujete zpracovat. Faktury web tato data přijmou, zpracují a okamžitě pošlou zpět odpověď s výsledkem. Vše probíhá automaticky, bez manuálních zásahů.
Výsledkem je úspora času, méně chyb a plynulý chod procesů. Faktury se mohou vytvářet, odesílat nebo zpracovávat na pozadí přesně v momentě, kdy je potřebujete.
Stačí jediné. Napojit váš systém na API, tedy vybudovat „kolejnice“, po kterých budou vaše data bezpečně a spolehlivě proudit mezi vaším systémem a Faktury webem. Celý proces přitom řídí váš systém. On rozhoduje, kdy se vlak rozjede, jaký náklad ponese a kdy se má vrátit zpět s výsledkem.

V praxi jde o komunikaci mezi dvěma servery prostřednictvím HTTP(S) požadavků. Váš e-shop (klient) odešle na server Faktury webu API požadavek (request), který obsahuje potřebná data, nejčastěji ve formátu JSON.
Server Faktury webu požadavek přijme, ověří jeho platnost (například autentifikaci a správnost dat), následně jej zpracuje a provede požadovanou operaci, například vytvoření faktury.
Po zpracování server odešle zpět odpověď (response), která obsahuje informaci o výsledku operace. Odpověď může obsahovat například identifikátor vytvořeného dokumentu, jeho stav nebo chybovou hlášku v případě neúspěchu.
Celý proces probíhá automaticky v reálném čase a je řízen vaším systémem, který rozhoduje, kdy a jaké požadavky bude odesílat.

Implementace API do vašeho e-shopu je technický zásah. Musí jej provést člověk nebo společnost, která váš e-shop vytvořila, případně někdo, kdo se technicky vyzná v jeho fungování. Ve většině případů jde o úpravu zdrojového kódu e-shopu nebo instalaci a nastavení příslušného modulu.
Obvykle jde o implementaci na míru, univerzální řešení neexistuje. Realizaci musí zajistit odpovědná osoba nebo společnost, která má přístup ke zdrojovému kódu nebo administraci systému. Faktury web neumí API zavést přímo do vašeho systému, implementace je vždy na vaší straně.
Doporučujeme obrátit se na autora vašeho systému nebo na kvalifikovaného odborníka. S implementací vám mohou pomoci i externí společnosti, které se na tato řešení specializují, například goodeshop.cz.

Momentálně je možné přes API vytvářet faktury a cenové nabídky. Kromě samotného vytvoření API umožňuje i jejich zobrazení, stažení a získání informace o jejich stavu (statusu).
Vytváření dokumentů probíhá na základě dat, která odesíláte ze svého systému. Díky tomu mohou být dokumenty flexibilní a přizpůsobené vašim potřebám.

Prakticky jakékoli. Jedinou podmínkou je, aby byl systém připojen k internetu. Propojení přes API je vhodné zejména pro systémy, které potřebují automaticky vytvářet daňové doklady, jako jsou faktury nebo cenové nabídky.
Může jít například o webové aplikace, e-shopy, CRM systémy, prodejní systémy a podobně.

Podrobný technický manuál s ukázkami zdrojových kódů naleznete na stránce Manuál pro vývojáře.

Ano, Faktury web API můžete používat bezplatně v rámci svého účtu ve Faktury webu. API není samostatně zpoplatněno ani nijak zvlášt limitováno. Na jeho používání se vztahují všeobecné podmínky služby.