FlexiBee API - URL a výstupní formáty

V jednom z předchozích článků jsme si ukázali jak načíst data z FlexiBee. Základem úspěchu při načítání dat je správně sestavené URL.

Jak již bylo zmíněno URL pro získání dat z FlexiBee se skládá adresy serveru, portu, 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é chceme data načítat, formát, ve kterém nám je 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


FlexiBee podporuje také 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 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é starší aplikaci je možné z FlexiBee získat data ve formátu CSV. Když za evidenci doplníte .csv tak data budou 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, kteru tiskovou sestavu má 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 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 zase smysl, protože tyto evidence neobsahují data, která by se vyexportovala. A formát DBF je již dnes nahrazen jinými formáty.
Ale i tak je možné z 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 ale také podporují jen některé evidence (faktury vydané, výdejky a objednávky vydané).
Importovat data ve formátu EDI je pak 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:
FlexiBee API Dokumentace

ABRA FlexiBee, REST API, Tvorba URL

-
Kája z Norska
Kája z Norska

Jsem programátor, horolezec a tak trochu FlexiBee fanatik :-).
Na CharlieBlogu sepisuji své nápady a poznatky už od roku 2006.