V tejto sekcii nájdete všetko, čo sa týka dopytovania, tzn. aké sú podporované zdroje, podporované http metódy, ako prebieha autentizácia, aká je štruktúra URI. Ďalej je tu výklad dopytovacieho jazyka a rad príkladov dopytovania.
Dostupné zdroje
Popis zdrojov, ktoré je možné dopytovať, viď kap. Dostupné zdroje.
HTTP hlavičky
Prehľad vybraných hlavičiek HTTP požiadavky a ich využitie. Viac viď kap. Web API - HTTP hlavičky.
dostupné metódy
Prehľad podporovaných metód a ich využitie, viď kap. Podporované http metódy.
Autentizácia
V tejto kapitole je uvedené, akým spôsobom vykonávať autentizáciu, tzn. ako prihlásiť užívateľa k Web API. Viac viď kap. Autentizácia a autorizácia.
Štruktúra uri
Z akých častí sa skladá URL adresa pre rôzne typy dopytovania a ako ju zostavovať, je uvedené v kap. Štruktúra URI.
Dopytovací jazyk REST API ABRA Gen
Tu je uvedený rozdiel medzi základným a rozšíreným dopytovaním a popis konštrukcie výrazov. Viac viď kap. Dopytovací jazyk REST API systému ABRA Gen.
Príklady dopytovania
K dispozícii je rad príkladov REST API ABRA Gen s výkladom. Viď kap.:
- Příklady základního dotazování REST API ABRA Gen
- Príklady rozšíreného dopytovania REST API ABRA Gen
- Web API zdroje pro funkce v MS Excelu
- Tisky a exporty prostřednictvím REST API ABRA Gen
- Práce s Úkoly prostřednictvím REST API ABRA Gen
- Další příklady použití Web API v ABRA Gen
Inšpiráciu nájdete tiež na externých webových stránkach (mimo online nápovedu systému ABRA Gen):
-
ABRA API - E-shop: Príklady určené primárne pre implementátory modulu ABRA e-shop, ale časť informácií je využiteľná všetkými užívateľmi Web API. Informačný zdroj pokrýva prácu s číselníkmi, objednávkami, zálohovými listami, platbami, tlač dokladov a ďalšie oblasti.
Pokiaľ pre prácu s API používate nástroj Postman, môžete si zbierku príkladov stiahnuť vo formáte Postman Collection Format a naimportovať do svojej lokálnej inštalácie Postmana. Výhodou je hlavne možnosť zobrazenia požiadaviek v syntaxi zodpovedajúcej rôznym vývojovým nástrojom (Java, C#, Python a i.).
Aktualizované k verzii ABRA Gen 19.2.3.9.
Spracovanie požiadaviek v medzipamäti
Web API podporuje serializáciu požiadaviek v medzipamäti. Viac viď kap. Web API - Zpracování požadavků v mezipaměti (/serverstate).
Dávkové/transakčné spracovanie
Web API podporuje dávkové/transakčné spracovanie, tzn. je možné spojiť niekoľko operácií/požiadaviek do jednej dávky a zaistiť, že všetky operácie budú vykonané ako celok alebo sa nevykoná žiadna z nich. Viac viď kap. Web API - dávkové/transakční zpracování.
External ID
Externý identifikátor (external ID) je unikátna hodnota používaná na identifikáciu záznamov v rámci business objektov. Slúži ako alternatíva k oid na rôznych miestach API. Viac viď kap. Web API - External ID
Tip
Postup nastavenia, spustenia a sprevádzkovania základného dopytovania krok za krokom viď ABRA API Tutoriál - První kroky s Web API.
Upozornenie - ochrana dát
Dopytovanie úzko súvisí s ochranou dát (nastavenie ochrany dát ovplyvňuje ich dostupnosť, i pre Web API), v zmysle všeobecnej funkcionality ochrany dát i používania chránených objektov.