Než začnete zostavovať vlastné požiadavky, potrebujete nástroj, ktorým ich odošlete. V tomto diele si ukážeme program Postman, v ktorom na podpore Flexi vykonávame všetko testovanie, a prejdeme si prihlásenie používateľa.

Na zoznámenie sa s API a na testovanie odporúčame Postman. Ponúka prehľadné grafické rozhranie, v ktorom ľahko zostavíte aj zložitejšiu požiadavku a rovno uvidíte odpoveď servera. Je voľne na stiahnutie na stránkach výrobcu, odporúčame desktopovú aplikáciu.

Postman ale nie je jediná cesta. Dáta možno čítať aj priamo v prehliadači, odosielať požiadavky z príkazového riadku nástrojom cURL alebo napísať vlastný skript. Ostrá integrácia Flexi s iným systémom bude nakoniec vždy stáť na vlastnom kóde, na zoznámenie sa s rozhraním a na ladenie je však Postman najrýchlejší.

Pre akúkoľvek operáciu je najprv nutné sa prihlásiť. V Postmane na to slúži záložka Authorization (v starších verziách Auth), kde vyplníte prihlasovacie údaje. Na testovanie postačí typ Basic Auth.

Ak chcete daného používateľa používať výhradne na prístup cez REST API, založte si používateľa pre API. Prístup k API sa obstaráva samostatne a stojí toľko, čo jeden štandardný prístup danej varianty licencie; počet API používateľov už potom nie je obmedzený. Podrobnosti popisuje článok o licencovaní prístupu k API, ceny nájdete v cenníku.

Basic Auth je najjednoduchší spôsob prihlásenia a na zoznámenie sa s API stačí. Pre dlhodobo bežiace integrácie sa hodí skôr JSON autentizácia, kedy si raz vyžiadate autentizačný token a ten potom posielate s ďalšími požiadavkami. Oba spôsoby, vrátane prihlasovania cez SAMLv2 a OpenID, popisuje článok o autentizácii.

Nasledujúce oblasti rozhrania budete potrebovať pri každej požiadavke.

Postman ponúka širokú škálu operácií, na prácu s Flexi vystačíte s tromi: GET, POST a PUT. Ich význam si vysvetlíme v diele o čítaní, zápise a mazaní záznamov.

Sem zapíšete adresu, s ktorou bude Postman pracovať. Spôsob, ako ju poskladať, popisuje diel o zostavovaní URL adresy.

Táto oblasť sa uplatní len vtedy, keď dáta do Flexi zapisujete.

Súvisí s predchádzajúcim bodom a týka sa opäť len odosielania dát. Štandardne vyberte raw.

Tu sa po odoslaní zobrazí odpoveď Flexi:

Do tejto oblasti zapisujete obsah požiadavky vo formáte XML alebo JSON, teda dáta, ktoré chcete do Flexi uložiť.

Uvedený príklad vytvorí vydanú faktúru s kódom TESTFAKTURA, typom dokladu FAKTURA (štandardná faktúra), vystavenú 1. 1. 2018 a s variabilným symbolom 20180101. Ďalšie príklady nájdete v poslednom diele série.