ABRA API Tutoriál - První kroky s Web API

Příručka ABRA API Tutoriál je určena středně pokročilým uživatelům ABRA Gen, kteří chtějí využít ABRA API rozhraní, nemají ale zatím zkušenosti, jak s API rozhraním obecně pracovat a chtěli by se rychle a efektivně seznámit s tím, jak na to. Jak název napovídá, jedná se o příručku typu tutoriál Tutoriál (z ang. tutorial) je návod k použití, který na konkrétních příkladech "krok za krokem" názorně ukazuje, jak se používá určitý počítačový program či programovací jazyk. Tutoriály nemusí být samostatné dokumenty. Mohou být součástí programu nebo technické dokumentace. Tutoriály umožňují začátečníkům rychlý a efektivní úvod do nové oblasti (např. programu), a získání velkého množství zkušeností během krátké doby a bez učitele. Tutoriály nemusí být, na rozdíl od manuálu či referenční příručky, vyčerpávající. Jejich cílem je umožnit uživateli okamžitou práci s programem..

Prostudování příručky s vyhotovením všech příkladů trvá cca půl dne s ohledem na to, jak moc detailně budete chtít procházet jednotlivé pasáže a jak moc precizně budete provádět sekce TEST, viz dále.

Příručka je koncipována jako výklad krok za krokem, jak rozhraní Web API nastavit a připravit k provozu, jak je spustit a jak začít provádět dotazování.

Stručně se dotýká těchto oblastí:

• Základní informace (co je Web API, z jakých komponent se skládá, co je možné pomocí něj dělat)
• Nastavení a spouštění (co vše a jak nastavit a spustit)
• Základní dotazování (jakým způsobem získávat BO, jak manipulovat s BO)

Nepokrývá všechny aspekty a funkce ABRA API rozhraní, nicméně po jejím prostudování by uživatel, který má s touto problematikou zatím jen minimální zkušenost měl mít představu o tom, jak postupovat.

Uspořádání kapitol odpovídá sekvenci kroků, které je potřeba v praxi provést. Příručka předpokládá, že čtenář si bude paralelně se čtením jednotlivých kapitol popisované akce rovnou zkoušet. V závěru jednotlivých kapitol je sekce TEST, který si doporučujeme vždy provést a nepokračovat dál, pokud výsledek není kladný.

Příručka nepopisuje všechna možná řešení, ale většinou to nejjednodušší.