URL a výstupní formáty

V článku PHP načtení dat z FlexiBee jsme si ukázali, jak načíst data z ABRA FlexiBee. Základem úspěchu při načítání dat je správně sestavené URL.

URL pro získání dat z ABRA FlexiBee se skládá z adresy serveru, portu a identifikátoru firmy.

https://server:port/c/identifikátor_firmy
např. https://demo.flexibee.eu:5434/c/demo

Dále se za identifikátor firmy doplňuje evidence, ze které budete chtít data načítat, formát, ve kterém je ABRA FlexiBee poskytne a případné další parametry.

server:port/c/identifikátor_firmy/evidence.xml?detail=full
např. demo.flexibee.eu:5434/c/demo/adresar.xml?detail=full

Seznam dostupných evidencí je dostupný na adrese:

server:port/c/identifikátor_firmy/evidence-list
např. demo.flexibee.eu:5434/c/demo/evidence-list

Výstupní formáty

FlexiBee podporuje několik výstupních formátů.

1. XML

  • Nejčastější formát pokud potřebuji vidět strukturovaná data.
  • Náročný na datové přenosy.
  • Data v tomto formátu získáte tak, že za evidenci doplníte .xml.
demo.flexibee.eu/c/demo/adresar.xml

2. JSON

  • Nejčastěji používaný formát všech napojení na ABRA FlexiBee.
  • Lidským okem nečitelný ale datově méně náročný než XML.
  • Stačí za evidenci doplnit .json.
demo.flexibee.eu/c/demo/adresar.json

3. CSV

  • Pokud je potřeba získat data pro zpracování v některé ze starších aplikací, je možné z ABRA FlexiBee získat data ve formátu CSV.
  • Když za evidenci doplníte .csv, budou data uložena v tomto formátu.
  • Ovšem pozor. CSV oproti XML a JSON neumí vypsat vnořené kolekce (například položky faktur společně s fakturou).
  • U tohoto formátu je také možné parametrem encoding vynutit kódování výstupního souboru.
demo.flexibee.eu/c/demo/adresar.csv
demo.flexibee.eu/c/demo/adresar.csv?encoding=iso-8859-2

4. XLS a XLSX

  • I Excel je podporovaným výstupním formátem. Má ale stejná omezení jako CSV.
demo.flexibee.eu/c/demo/adresar.xls
demo.flexibee.eu/c/demo/adresar.xslx

5. PDF

  • Z FlexiBee je možné přes API získat i tiskové sestavy ve formátu PDF.
  • U tohoto výstupního formátu je možné parametrem ovlivnit, kterou tiskovou sestavu má ABRA FlexiBee vrátit, v jakém ji má vrátit jazyce a zda ji má podepsat.
  • Pro výběr tiskové sestavy se používá parametr report-name a pro výběr jazyka se používá parametr report-lang.
  • Podpis PDF se vynucuje pomocí parametru report-sign.
demo.flexibee.eu/c/demo/adresar.pdf
demo.flexibee.eu/c/demo/adresar.pdf?report-name=obalkaDL
demo.flexibee.eu/c/demo/adresar.pdf?report-lang=en

5. ISDOC

  • Formát isdoc je použitelný jen u vydaných faktur.
  • Pokud za evidenci doplníte .isdoc získáte z ABRA FlexiBee ISDOC s fakturou.
http://demo.flexibee.eu/c/demo/faktura-vydana.isdoc

6. DBF, vCard, iCalendar a EDI

  • Zbývající formáty jsou již použitelném méně a jen na některých evidencích.
  • vCard a iCalendar nemají na některých evidencích smysl, protože tyto evidence neobsahují data, která by se vyexportovala.
  • Formát DBF je již dnes nahrazen jinými formáty.
  • Ale i tak je možné z ABRA FlexiBee pře REST-API získat data v těchto formátech.
  • Jediný formát, který má smysluplné využití například kvůli obchodním řetězcům, je EDI. Tento formát ovšem podporují jen některé evidence (faktury vydané, výdejky a objednávky vydané). Importovat data ve formátu EDI je možné jen u objednávek přijatých.
http://demo.flexibee.eu/c/demo/adresar.dbf
demo.flexibee.eu/c/demo/adresar.vcf
demo.flexibee.eu/c/demo/udalost.ical
demo.flexibee.eu/c/demo/faktura-vydana/836.edi

Zdroj:
ABRA FlexiBee API Dokumentace