O produktech

Usnadněte si napojení na API ABRA Gen

8. 11. 2021
Generické API ABRA Gen

Potřebujete napojit webové CRM, rezervační či docházkový systém nebo jakoukoliv jinou aplikaci na ABRA Gen? Skvělá interaktivní dokumentace APIdoc vás velmi rychle a intuitivně provede všemi zákoutími rozhraní API ABRA Gen. Pro vašeho IT správce nebo jakéhokoliv dodavatele individuální řešení tak nebude problém seznámit se důkladně s logikou API a tvorbou dotazů.

Interaktivní dokumentace je dostupná jako webová aplikace na adrese:

apidoc.abra.eu

Webová aplikace koncentruje do jednoho místa nápovědu ABRA Gen (help.abra.eu), GenDoc.chm – technická dokumentace ABRA Gen (soubor je součástí vaší instalace systému) a kromě toho navíc i vaše definované číselníky a definovatelné položky, které můžete mít v systému vytvořeny.

Aplikaci jsme podrobně představili v rámci ABRA Tech Day 2021. Podívejte se na záznam.

Jak se přihlásit do APIdoc

Pro přístup do webové aplikace musíte zadat celou URL na vaše API a přihlásit se jménem a heslem uživatele, který má API povoleno.

Obr 01: Přihlášení do APIdoc. Použijte přistup ke svému API serveru.
Obr 01: Přihlášení do APIdoc. Použijte přistup ke svému API serveru.

Po přihlášení dojde k načtení celé struktury vašeho API. Zároveň se připojí v helpu publikované příklady na použití API.

Pozn.:

Jestliže nemáte svoje API publikováno do internetu, bude v krátké době připravena off-line verze, kterou si budete moci instalovat na váš počítač a nechat si vygenerovat popis na svůj lokální počítač. Instalační soubor off-line aplikace si můžete stáhnout pod přihlašovacím oknem na stránce apidoc.abra.eu.

Sandbox s demo daty

Pro testování lze využít také připravenou stránku apisandbox.abra.eu, kde je publikováno API pro demodata aktuální verze ABRA Gen. Sandbox však pochopitelně neobsahuje žádné zakázkové úpravy vašeho systému a nemusí se shodovat přesně s vaší verzí systému, proto zde mohou být drobné odlišnosti.

Jak s APIdoc pracovat

Po načtení struktury API můžete zadat do vyhledávače libovolný objekt (číselník/doklad), který vás zajímá:

Obr 02: Vyhledání objektu Středisko.
Obr 02: Vyhledání objektu Středisko.

Dostanete základní funkce, které API podporuje. Po kliknutí na tlačítko Zobrazit více uvidíte strukturu vašeho objektu (střediska) i včetně definovatelných položek. Navíc budete mít náhledy volání všech API funkcí, a to jak pro práci s jedním záznamem, tak i zadávání více nových záznamů současně (dávkově).

Obr 03: Detailní struktura vybraného objektu vč. definovatelných položek.
Obr 03: Detailní struktura vybraného objektu vč. definovatelných položek.

Tyto vygenerované příklady můžete překopírovat například do aplikace Postman a vyzkoušet je.

Při najetí do pravé části černého pole se nabízí možnost zkopírovat do ClipBoardu celou URL nebo obsah dotazu.

Obr 04: Kopírování dotazu do schránky.
Obr 04: Kopírování dotazu do schránky.

Velmi zajímavou záložkou je Builder, který vám umožní konkrétní dotaz sestavit:

Obr 05: Bulider pro rychlé sestavování dotazů.
Obr 05: Bulider pro rychlé sestavování dotazů.

V levém sloupci si můžete vybrat, jakou metodu (v našem případ metodu GET) chcete sestavit.

V horní liště volíte Parametry, jaké budou v sekci Select, Where apod.

Konkrétní parametry volíte v pravém sloupečku.

POZOR: Volba Spustit dotaz je dostupná pouze u metody GET, abyste si omylem nezměnili data ve své databázi.

Nicméně u všech metod si můžete nakopírovat URL i tělo dotazu tlačítkem Copy do clipboardu a vyzkoušet například pomocí Postmanu.


Související články a videa

Zajímáte se o systém ABRA Gen? Napište nám!

Zeptejte se CZ