Začínáme s FlexiBee API
Snadno začít Samodokumentace Browser je nástroj Podívám se jak to funguje.
REST API
Příklad XML <winstrom version="1.0"> <faktura-vydana> <typDokl>code:FAKTURA</typDokl> <firma>code:FLEXIBEE</firma> <popis>Ukázková faktura</popis> <sumZklZakl>1000.0</sumZklZakl> <bezPolozek>true</bezPolozek> </faktura-vydana> </winstrom> Popsat rozdíl mezi XML a JSON, možná další slide
Příklad JSON { "winstrom": { "@version": "1.0", "faktura-vydana": { "typDokl": "code:FAKTURA", "firma": "code:FLEXIBEE", "popis": "Ukázková faktura", "sumZklZakl": 1000.0, "bezPolozek": true } XML je čitelnější a proto v demo obvykle používáme XML.
URL /c/<identifikátor firmy>/<evidence>/<ID záznamu>.<výstupní formát> /c/<identifikátor firmy>/<evidence>/(<filtr>).<výstupní formát>
Identifikace záznamů 123 code:CZK ext:SHOP:123 ean:4710937332698 vatid:CZ28019920 in:28019920 plu:4020 key:550e8400e29b41d4a716 [123][code:CZK][ext:SHOP:abc] Externí identifikátory používáme i pro importy. Uděláme velké XML a tím se pak odkazujeme.
Typ dokladu
Parametry URL Řazení: ?order=nazev@D Stránkování: ?limit=100&page=20 Počet záznamů: ?add-row-count=true
Detail záznamu ?detail=id ?detail=summary výchozí pro seznam záznamů ?detail=full výchozí pro detail záznamu ?detail=custom:kod,nazev ?detail=custom:kod,polozky(nazev,cena) ID vždy ?detail=custom:...&includes=...
Filtrace (typDokl=‘code:FAKTURA’ and uzivatel = me()) (firma = 'code:FIRMA') (firma.skupFir = 'code:ODBĚRATEL-STANDARD') (in subtree 7 nonrecursive)
Ukázka XML <winstrom version="1.0"> <adresar update=”ignore”> <id>ext:MY:firmicka</id> <id>vatid:CZ123456</id> <dic>CZ123456</dic> <nazev>Název firmy</nazev> </adresar> <faktura-vydana> <typDokl>code:FAKTURA</typDokl> <firma>ext:MY:firmicka</firma> <popis>Ukázková faktura</popis> <sumZklZakl>1000.0</sumZklZakl> <bezPolozek>true</bezPolozek> </faktura-vydana> </winstrom> Doklad je idempotentní. Import lze opakovat. Uvádíme jen to co měníme. I povinné atributy není nutné vyplňovat, protože se dopočtou/doplní Podporujeme formáty: XML, JSON, CSV, DBF, XLS, PDF, ISDOC, EDI, vCard, iCalendar, HTML. Umíme importovat i gigové XML (více než je RAM).
Seznam vazeb lze získat na adrese /c/firma/<evidence>/relations Navázané objekty ?relations= polozky vazby prilohy sklad-karty Seznam vazeb lze získat na adrese /c/firma/<evidence>/relations
?includes=… <stat>code:CZ</stat> Navázané objekty ?includes=… <stat>code:CZ</stat> ?includes=/adresar/stat <stat> <stat> <id>...</id> … </stat> </stat> Zvyšuje rychlost.
přebírá práva uživatele extra uživatel pro API nelze přihlásit GUI API a uživatelé přebírá práva uživatele extra uživatel pro API nelze přihlásit GUI Externí systém - licencování a partnerská řešení Existuje SUDO - do-as
Doklad je idempotentní. Import lze opakovat. Uvádíme jen to co měníme. I povinné atributy není nutné vyplňovat, protože se dopočtou/doplní Podporujeme formáty: XML, JSON, CSV, DBF, XLS, PDF, ISDOC, EDI, vCard, iCalendar, HTML. Umíme importovat i gigové XML (více než je RAM).