Ovládání FAPI přes API rozhraní

Kromě standardního způsobu (přes webové rozhraní) lze s FAPI pracovat také pomocí tzv. API ( Application Programming Interface) rozhraní. API je služba umožňující spouštět funkce FAPI pomocí požadavků zasílaných z jiné aplikace. To má význam zejména při propojení s libovolným jiným systémem (typicky např. s e-shopem), který v této situaci může sloužit pouze jako uživatelské rozhraní pro zadání objednávky, přičemž zbytek prodejního procesu - tedy vystavení faktury, přijetí platby, doručení zakoupeného produktu atd. - se již odehrává ve FAPI.

Když jsme začali FAPI vyvíjet, jedním z našich hlavních záměrů byla snadnost jeho využití a možnost vystavování faktur z dalších aplikací či webových stránek. Toho jsme docílili díky využití API rozhraní pro ovládání FAPI. Ostatně aplikace to má přímo ve svém názvu FAPI = Fakturační API.

K čemu lze API například využít?

  • vystavení a úprava faktury
  • stažení všech existujících faktur a pravidelných faktur
  • vytvoření, úprava a mazání klientů
  • vytvoření, úprava a mazání položek faktury
  • zprostředkování funkcí prodejního formuláře atd.

Nejčastější případy použití API přehledně shrnuje tento návod, který využívá knihovnu FAPIClient pro PHP.

Další příklady volání API bez použití knihovny FAPIClient najdete zde.

Dokumentace API

FAPI využívá tzv. REST API. Jeho dokumentaci naleznete na adrese http://docs.fapi.apiary.io.

Některé API metody nejsou ve výše uvedené dokumentaci popsané. Pokud nenajdete to, co potřebujete, obraťte se na naši podporu, kde vám rádi pomůžeme vyřešit konkrétní požadavek.

Testování API na mock serveru

Chcete-li si funkčnost API vyzkoušet na mock serveru, místo adresy http://api.fapi.cz použijte http://fapi.apiary.io.

Při zkoušení na mock serveru nezadávejte platné přihlašovací údaje, protože na této stránce jsou veřejně vidět všechny přijaté žádosti a bylo by tam vidět i vaše heslo.