Ako používať Postman

1. Čo je Postman?

Program Postman je jeden z populárných nástrojov na testovanie API.

Stiahnuť program Postman

2. Vytvorenie novej kolekcie a požiadavky

V programe Postman sa vytvorené požiadavky ukládajú do tzv. kolekcii. Novú kolekciu a novú požiadavku vytvoríte povelom New v menu File a následne zvolením požadovanej položky Collection, resp. HTTP v zobrazenom okne.

Voľbou HTTP sa založí nová požiadavka, pri ktorej je potrebné zadať názov a vybrať kolekciu, do ktorej ju chcete zaradiť.

tip Novú kolekciu môžete založiť taktiež priamo pri vytvorení novej požiadavky.

info Pre zjednodušenie práce sme pre vás pripravili kolekciu na stiahnutie so všetkými dostupnými požiadavkami, ktorú si môžete naimportovať do aplikácie Postman.

3. Zadanie autentizačného údaju k požiadavke

Pre odoslanie požiadavky na API je potrebné v hlavičke každej požiadavky uvádzať autentizačný údaj - získaný token alebo API kľúč. Spôsob získania týchto údajov je popisaný v kapitole Spôsoby autentizácie na stránke Všeobecné.

Aby ste nemuseli v programe Postman spôsob autentizácie opakovane zadávať do hlavičky každej požiadavky, nastavte ho priamo v kolekcii na záložke Authorization v poli Type vybratím jednej z možnosti Bearer Token alebo API Key a zadaním získaného tokena, resp. API kľúča.

Pokiaľ chcete použiť tokeny, umožňuje program Postman zjednodušený spôsob získania nového tokena a to konfiguracii priamo v kolekcii, kde na záložke Authorization zvoľte možnosť OAuth 2.0 v poli Type a v poli Add auth data to nechajte vybranú voľbu Request Headers.

Potom v časti Configure New Token vyplňte nasledujúce údaje:

• Token Name - Vaše pomenovanie tokena

• Grant Type - vyberte voľbu Client Credentials

• Access Token URL - doplňte adresu https://ucet.pohoda.cz/connect/token

• Client ID - zadajte Client Id vygenerovaný v agende API v aplikácii mPOHODA

• Client Secret - zadajte Client Secret vygenerovaný v agende API v aplikácii mPOHODA

• Scope - zadajte hodnotu Mph.OpenApi.Access.Sk

• Client Authentication - je možné ponechať ktorúkoľvek z oboch ponúkaných možností

Kliknutím na tlačidlo Get New Access Token sa získaný token pridá do zoznamu pola Access Token v časti Current Token. Nový token vyberte v zozname Available Tokens. Zmeny uložte pomocou tlačidla Save.

Metóda požiadavky

Pri každej požiadavke pred jej odoslaním na API, je potrebné nastaviť požadovanú HTTP metódu a zadať URL adresu.

Hlavička požiadavky

V prípade, že ste používaný spôsob autentizácie nezadali priamo na kolekcii, uveďte ho na záložke Headers.

Telo požiadavky

Údaje, ktoré majú byť uvedené na vytváranom zázname, sa uvádzajú na záložke Body. Pre zápis je potrebné nastaviť mód raw a hodnotu JSON v rozbalovacom menu, napravo od voľby módu.

Obsah tela požiadavky pre jednotlivé API metódy je popísaný v jednotlivých kapitolách na stránke Referencie. Sprievodca Naviazané záznamy vás zoznámí s tým, ako získať id záznamov, ktoré chcete v požiadavke využiť.

4. Odpoveď z API

Hotovú požiadavku odošlete na API kliknutím na tlačidlo Send.

V spodnej časti obrazovky sa zobrazí odpoveď API:

• úspešná operácia - vygenerované údaje

  

• neúspešná operácia - v sekcii detail je uvedený dôvod

  

5. Kontrola dokladu v aplikácii mPOHODA

Úspešné vytvorenie dokladu si môžete následne overiť aj priamo v aplikácii mPOHODA v príslušnej agende.