Potrebujete napojiť webové CRM, rezervačný alebo dochádzkový systém alebo akúkoľvek inú aplikáciu na ABRA Gen? Skvelá interaktívna dokumentácia APIdoc vás veľmi rýchlo a intuitívne prevedie každým zákutím rozhrania API ABRA Gen. Pre vášho IT správcu alebo akéhokoľvek dodávateľa individuálneho riešenia tak nebude problém sa dôkladne zoznámiť s logikou API a tvorbou dotazov.
Interaktívna dokumentácia (v ČJ) je dostupná ako webová aplikácia na adrese:
Webová aplikácia koncentruje do jedného miesta nápovedu ABRA Gen (help.abra.eu), GenDoc.chm – technická dokumentácia ABRA Gen (súbor je súčasťou vašej inštalácie systému) a okrem toho naviac i vaše definované číselníky a definovateľné položky, ktoré môžete mať v systéme vytvorené.
Aplikáciu sme podrobne predstavili v rámci ABRA Tech Day 2021. Pozrite sa na záznam.
Ako sa prihlásiť do APIdoc
Pre prístup do webovej aplikácie musíte zadať celú URL na vaše API a prihlásiť sa menom a heslom používateľa, ktorý má API povolené.
Obr 01: Prihlásenie do APIdoc. Použite prístup ku svojemu API serveru.
Po prihlásení dôjde k načítaniu celej štruktúry vašich API. Zároveň sa pripoja v helpe publikované príklady na použitie API.
Pozn.:
Ak nemáte svoje API publikované do internetu, bude v krátkej dobe pripravená off-line verzia, ktorú si budete môcť inštalovať na váš počítač a nechať si vygenerovať popis na svoj lokálny počítač. Inštalačný soubor off-line aplikácie si môžete stiahnuť pod prihlasovacím oknom na stránke apidoc.abra.eu.
Sandbox s demo dátami
Pre testovanie sa dá využiť pripravená stránka apisandbox.abra.eu, kde je publikované API pre demodáta aktuálnej verzie ABRA Gen. Sandbox však pochopiteľne neobsahuje žiadne zákazkové úpravy vášho systému a nemusí sa zhodovať presne s vašou verziou systému, preto tu môžu byť drobné odlišnosti.
Ako s APIdoc pracovať
Po načítaní štruktúry API môžete zadať do vyhľadávača ľubovoľný objekt (číselník/doklad), ktorý vás zaujíma:
Obr 02: Vyhľadávanie objektu Stredisko.
Dostanete základné funkcie, ktoré API podporuje. Po kliknutí na tlačidlo Zobraziť viac uvidíte štruktúru vášho objektu (strediska) i vrátane definovateľných položiek. Naviac budete mať náhľady volaní všetkých API funkcií, a to ako pre prácu s jedným záznamom, tak i pri zadávaní viac nových záznamov súčasne (dávkovo).
Obr 03: Detailná štruktúra vybraného objektu vrátane definovateľných položiek.
Tieto vygenerované príklady môžete prekopírovať napríklad do aplikácie Postman a vyskúšať ich.
Ak myškou pôjdete do pravej časti čierneho poľa ponúkne sa možnosť skopírovať do ClipBoardu celú URL alebo obsah dotazu.
Obr 04: Kopírovanie dotazu do schránky.
Veľmi zaujímavou záložkou je Builder, ktorý vám umožní konkrétny dotaz zostaviť:
Obr 05: Bulider pre rýchle zostavovanie dotazov.
V ľavom stĺpci si môžete vybrať, akú metódu (v našom prípade metódu GET) chcete zostaviť.
V hornej lište volíte Parametre, aké budú v sekcii Select, Where a pod.
Konkrétne parametre volíte v pravom stĺpčeku.
POZOR: Voľba Spustiť dotaz je dostupná len pri metóde GET, aby ste si omylom nezmenili dáta vo svojej databáze.
Pri všetkých metódach si môžete nakopírovať URL i telo dotazu tlačidlom Copy do clipboardu a vyskúšať napríklad pomocou Postmanu.
