Jak začít s API FlexiBee - Pomocí jakého programu testovat REST API? (2/6)

Ve FlexiBee doporučujeme a veškeré testování provádíme v programu Postman. Podíváme se tedy, jak v něm pracovat. Je volně ke stažení na adrese GetPostman, případně lze přidat jako rozšíření do Google Chrome (doporučujeme spíše desktopovou aplikaci). Napojení FlexiBee s jiným SW bude s největší pravděpodobností realizováno pomocí vlastního skriptu, nicméně pro naše testování je výše zmíněný Postman dostačující.

Pro jakoukoliv operaci je nejprve nutná autentizace uživatele, učiníte tak na záložce Auth. Pro testování postačí typ Basic Auth.
Pokud chcete využívat daného uživatele pouze pro přístup přes REST API, doporučujeme využívat “API uživatele”, tedy levnější variantu bez přístupu do desk. aplikace - viz Ceník.

Podporujeme další způsoby autentizace, viz naše dokumentace: Autentizace

Nyní si bod po bodu rozebereme rozhraní Postmanu na záložce Body.




1) Výběr HTTP operace (GET, POST, PUT, DELETE, …)

  • Program Postman nabízí širokou škálu podporovaných operací, nicméně pro práci s FlexiBee nám momentálně postačí 4 zmíněné výše.

  • Význam těchto operací si vysvětlíme ve článku HTTP operace.

2) Pole pro zadání URL adresy s kterou bude Postman pracovat

3) Výběr formátu, ve kterém budou data posílána na danou URL

  • POZOR – příponu URL adresy je nutné uvádět shodnou s formátem zasílaných dat.

4) Výběr podoby vytvářeného requestu (standardně raw)

5) Zde se po odeslání požadavku na danou URL adresu, zobrazí odpověď (response)

  • při operaci GET – odpověď flexibee v požadovaném formátu (XML/JSON)

  • při operaci POST, PUT, DELETE – odpověď flexibee s výsledkem operace, např:

¨

6) Tělo požadavku (request)

  • Tělo ve formátu XML/JSON

  • Příklad:

    • Vytvoří vydanou fakturu s kódem „TESTFAKTURA“, typem dokladu FAKTURA (standardní faktura), vystavenou 1. 1. 2018 s var. symbolem „20180101“   

Pomohl Vám tento článek?