FLORES API Tutoriál - Autentizace a kontrolní dotaz

Spustíme Postman (HTTP klient používaný v našem návodu). Nejprve si předvedeme, jak se k Web API přihlašují uživatelé (každý požadavek musí obsahovat přihlašovací údaje, protože každý může pocházet od jiného uživatele). Poté si vyzkoušíme několik základních operací.

Načtení kolekce objednávek přijatých

Zvolíme metodu GET a zadáme URL sestavenou následovně:

/{spojení}/{kolekce Business objektů}

Tj. v našem případě následovně ("data" je identifikátor, který jsme uvedli jako alias našeho spojení a receivedorders je název kolekce BO objednávek):

http://localhost:8082/data/receivedorders

V URL je třeba uvést i port 8082, jelikož jsme si jej nastavili v konfiguraci jako port, na kterém server naslouchá. V případě, že jsme v konfiguraci žádný port nenastavili, není zapotřebí port uvádět, neboť defaultní port pro Web API (80) je současně defaultním portem protokolu HTTP. Bez uvedení portu se požadavek zašle na localhost:80.

Požadavek odešleme tlačítkem Send. Pokud bylo vše správně zadáno, obdržíte odpověď dle následujícího obrázku:

Vidíte, že se jedná o JSON pole, které obsahuje objekty, které jsou v dané kolekci dostupné (zohledňují se přístupová práva k chráněným objektům, tj. např. řadám dokladů).

Pozor, pokud načtete kolekci výše uvedeným dotazem, bez specifikace jakýchkoli dalších parametrů (což si ukážeme dále v sekci dotazování pomocí query parametrů), jsou vráceny úplně VŠECHNY objekty v dané kolekci. Tzn. není nejvhodnější se dotazovat tímto způsobem do produkčních dat obsahujících velké množství záznamů. Ve výchozích předpokladech v kap. FLORES API Tutoriál - Nastavení a příprava rozhraní Web API bylo doporučeno, abyste pracovali nad spojením s nahranými demodaty.

Ve výchozím stavu takto provedený dotaz vrací všechny persistentní položky daného BO. Jak získat i nepersistentní, viz další kap.

Stejným způsobem bychom prováděli další dotazování, které probereme příště.

Dále viz . Kap.: Struktura URI a Dotazovací jazyk REST API systému IS FLORES. Dále viz Práva k objektům obecně.

TEST

1. Obdrželi jste odpověď systému s daty objednávek, jak ukazuje obrázek níže?

NE, chyba přihlášení uživatele

Obdržel jsem chybovou odpověď:

{"title":"Chyba přihlášení","description":"Uživatel nemá povoleno přihlášení z Webového API"}

Pak nemáte v IS FLORES u daného uživatele povolen přístup k API. Vraťte se do kap. FLORES API Tutoriál - Nastavení a příprava rozhraní Web API, nastavte mu přístup a akci zopakujte.

NE, status Unauthorized

Dotaz skončil následující chybou:

Pak jste chybně provedli autentizaci, viz výše. Příčin této chyby může být několik:

Zadali jste chybné jméno nebo heslo existujícího uživatele.
Zadaný uživatel neexistuje.

Zapomněli jste zadat jméno uživatele.

V tomto případě je chybový status 401 doplněn upřesněním v těle odpovědi:

{"title":"Neproběhlo přihlášení uživatele","description":"Nevalidní operace - pro provedení akce je nutné přihlášení"}

Vraťte se k nastavení přístupu uživatele a zadejte autentizační údaje ještě jednou.