Faktury Web API

Zkratka API z anglického Application Programming Interface je rozhraní pro programování aplikací. Můžeme obecně říci, že jde o jakousi sbírku pravidel, postupů či funkcí, pomocí kterých lze propojit dva nezávislé systémy. V tomto případě se jedná o propojení Faktury webu například s Vaším eshopem nebo webem. Výsledkem bude vytvoření dokumentu faktury ve Faktury webu na základě dat pocházejících z Vašeho eshopu.

Můžeme si představit následující situaci. Máme dvě vlakové stanice, které jsou propojeny kolejnicemi, po kterých jezdí nákladní vlak. Vlak s nákladem jezdí ze stanice A po železniční trati do stanice B, kde je náklad vyložen a dále zpracován. Následně se vlak otočí a vrátí se zpět do stanice A se zprávou, že náklad byl doručen a zpracován. V tomto případě představuje stanice A váš systém (například eshop), stanice B je Faktury web a vlak s kolejnicemi je API. Technicky tedy můžeme říci, že váš eshop (stanice A) odešle požadovaná data prostřednictvím API (vlak s nákladem po železnici) do Faktury webu (stanice B), kde se data zpracují a o výsledku zpracování odešlou zprávu zpět (návrat vlaku do stanice A). Důležité je si uvědomit, že přípojku k železniční trati je třeba vybudovat ve vašem eshopu, což můžeme nazvat implementací API do systému. Druhou důležitou věcí je, že vlak s nákladem vždy odjíždí pouze ze stanice A do stanice B, což znamená, že váš eshop iniciuje spojení a odesílá požadavek (request).

V praxi jde o komunikaci mezi dvěma servery. Váš eshop odesílá požadavek (request) na server Faktury webu. Faktury web tento požadavek zpracují a informují o výsledku zpracování (respose). Více můžete vyčíst z tohoto schématu:

Implementace API do Vašeho eshopu je technický zásah. Musí jej provést člověk nebo společnost, která Vám eshop vytvořila nebo se technicky vyzná v chodu systému. Většinou jde o úpravu zdrojového kódu eshopu nebo instalaci a nastavení příslušného modulu v systému eshopu. Téměř v každém případě jde o implementaci na míru a univerzální řešení neexistuje. Musí jej provést zodpovězený člověk nebo společnost, kteří mají přístup přímo do zdrojového kódu případně administrace management systému. Faktury web nijakým způsobem neumí API zavést do Vašeho systému, realizace je na Vaší straně. Je nutné se obrátit na příslušného odborníka, ideální autora systému. S implementací API Vám umí pomoci i externí společnosti, které se takovými implementacemi zabývají, například goodeshop.cz.

Momentálně lze přes API vytvořit faktury a cenové nabídky. Kromě vytvoření těchto dokumentů API umožňuje i jejich zobrazení, stažení nebo poskytne informaci o jejich statusu. Vytvoření dokumentů probíhá na bázi dat, která se odesílají z Vašeho systému. Proto informace v dokumentech mohou být poměrně různorodé a flexibilní.

Prakticky všechny. Jedinou podminekou je, že systém, který chce využívat Faktury web musí být připojen k internetu. Propojení přes API do Faktury webu může být vhodné zejména pro systémy, které potřebují vytvářet daňové doklady – faktury nebo cenové nabídky. Mohou to být různé weby, online obchody, CRM systémy, prodejní systémy a podobně.

Podrobný technický manuál k implementaci s ukázkami zdrojových kódů naleznete na této stránce.

Ano, Faktury web API můžete používat zdarma v rámci svého účtu ve Faktury webu. API není nijak limitováno a ani zvlást zpoplatněno. Pro používání Faktury web API platí všeobecné podmínky používání.