V této sekci naleznete vše, co se týká dotazování, tj. jaké jsou podporované zdroje, podporované http metody, jak probíhá autentizace, jaká je struktura URI. Dále je zde výklad dotazovacího jazyka a řada příkladů dotazování.
Dostupné zdroje
Popis zdrojů, které lze dotazovat, viz kap. Dostupné zdroje.
HTTP hlavičky
Přehled vybraných hlaviček HTTP požadavku a jejich využití. Více viz kap. Web API - HTTP hlavičky.
dostupné metody
Přehled podporovaných metod a jejich využití, viz kap. Podporované http metody.
Autentizace
V této kapitole je uvedeno, jakým způsobem provádět autentizaci, tj. jak přihlásit uživatele k Web API. Více viz kap. Autentizace, autorizace a práva.
Struktura uri
Z jakých částí se skládá URL adresa pro různé typy dotazování a jak ji sestavovat, je uvedeno v kap. Struktura URI.
Dotazovací jazyk Web API ABRA Gen
Zde je uveden rozdíl mezi základním a rozšířeným dotazováním a popis konstrukce výrazů. Více viz kap. Dotazovací jazyk Web API systému ABRA Gen.
Příklady dotazování
K dispozici je řada příkladů Web API ABRA Gen s výkladem. Viz kap.:
- Typové příklady základního dotazování Web API (Query String)
- Typové příklady rozšířeného dotazování Web API (JSON Object)
- Web API zdroje pro funkce v MS Excelu
- Tisky a exporty prostřednictvím Web API ABRA Gen
- Práce s Úkoly prostřednictvím Web API
- Knihovna praktických příkladů Web API
Inspiraci naleznete také na externích webových stránkách (mimo online nápovědu systému ABRA Gen):
-
ABRA API - E-shop: Příklady určené primárně pro implementátory modulu ABRA e-shop, ale část informací je využitelná všemi uživateli Web API. Informační zdroj pokrývá práci s číselníky, objednávkami, zálohovými listy, platbami, tisk dokladů a další oblasti.
Pokud pro práci s API používáte nástroj Postman, můžete si sbírku příkladů stáhnout ve formátu Postman Collection Format a naimportovat do své lokální instalace Postmanu. Výhodou je zejména možnost zobrazení požadavků v syntaxi odpovídající různým vývojovým nástrojům (Java, C#, Python aj.).
Aktualizováno k verzi ABRA Gen 19.2.3.9.
Zpracování požadavků v mezipaměti
Web API podporuje serializaci požadavků v mezipaměti. Více viz kap. Web API - Zpracování požadavků v mezipaměti (/serverstate).
Dávkové/transakční zpracování
Web API podporuje dávkové/transakční zpracování, tj. je možné spojit několik operací/požadavků do jedné dávky a zajistit, že všechny operace budou provedeny jako celek nebo se neprovede žádná z nich. Více viz kap. Web API - dávkové/transakční zpracování.
External ID
Externí identifikátor (external ID) je unikátní hodnota používaná k identifikaci záznamů v rámci business objektů. Slouží jako alternativa k oid na různých místech API. Více viz kap. Web API - External ID
Tip
Postup nastavení, spuštění a zprovoznění základního dotazování krok za krokem viz ABRA API Tutoriál - První kroky s Web API.
Upozornění - ochrana dat
Dotazování úzce souvisí s ochranou dat (nastavení ochrany dat ovlivňuje jejich dostupnost, i pro Web API), ve smyslu obecné funkcionality ochrany dat i používání chráněných objektů.