logo AbraFlexi

Dokumentace REST API AbraFlexi

Tato příručka shrnuje REST API systému AbraFlexi (FlexiBee) — nejde o dokumentaci žádné konkrétní klientské knihovny (např. python-abraflexi), ale o samotné HTTP rozhraní AbraFlexi serveru, jak jej může využít libovolný klient v libovolném jazyce.

Obsah je sestaven a přeložen z oficiální dokumentace na podpora.flexibee.eu a doplněn o ověření proti referenční PHP knihovně AbraFlexi. Zaměřuje se na obecné mechanismy REST API použitelné napříč evidencemi; nepokrývá vyloženě obchodní témata jednotlivých agend (mzdy, DPH přiznání, sklad do detailu apod.) ani XML schéma — příklady všude používají formát JSON.

Rychlý přehled

Základní tvar URL:

https://server:port/c/<identifikátor firmy>/<evidence>/<ID záznamu>.<formát>

  • Autentizace: HTTP Basic, nebo JSON přihlašovací token (authSessionId).

  • Formát: JSON i XML jsou plnohodnotně podporovány (CSV, XLS, PDF, ISDOC, EDI, vCard, iCalendar pro export); tato příručka se drží JSON.

  • Čtení: GET na výpisové (bez ID) nebo detailní (s ID) URL, s volitelnou filtrací, řazením, stránkováním a úrovní detailu.

  • Zápis: PUT/POST se stejnou strukturou dat jako u čtení; AbraFlexi nerozlišuje vytvoření a aktualizaci — určuje to podle existence identifikátoru.

  • Mazání: HTTP DELETE, nebo obecnější action="delete" na libovolné evidenci.

Zdroje