API rozhraní
> Nápověda Aktion NEXT > Obecné
Pro použití WebAPI je nutné mít zprovozněnou webovou aplikaci Aktion a platnou servisní a systémovou podporu.
WebAPI je k dispozici od Aktion.NEXT verze 3.1.
API slouží pro komunikaci se systémy třetích stran a umožňuje vkládat, mazat, blokovat a povolovat osoby, zakládat identifikátory, získávat stav (přítomen/nepřítomen), nastavovat přístupová oprávnění na snímače, předávat data o průchodech na docházkových snímačích, získávat docházkové hodnoty, vytvářet návštěvy a další.
Aktion.NEXT
Dokumentace k API je dostupná pod vaší URL Aktion webové aplikace https://VaseURL/api/
API klíč k uživateli vygenerujete v SW Aktion.NEXT v agendě Uživatelé (Číselníky) a detailu konkrétního uživatele na záložce Web API.
Pro použití konkrétních API metod (endpointů) je nutné nejprve ověřit uživatele přes POST login
Práva uživatele
U všech případů se aplikují nastavená práva uživatele (Práva na záznamy, Aplikační práva, omezení na mzdové složky). Pokud uživatel nemá na dané záznamy nebo agendy právo, nebude možné použít ani příslušné endpointy.
Aktion.NEXT
Pro uživatele používaného pro API rozhraní je nutné nastavení minimálně práva Zobrazit osoby nebo konkrétní osobu (Uživatel – detail – Práva na záznamy). Pokud budete potřebovat také měnit údaje, mazat osoby a další, je nutné mít nastavené konkrétní právo také.
Nejpoužívanější endpointy (níže odkazy na nápovědu pro Aktion CLOUD):
POST login – získání tokenu
GET person/get – získání detailních informací k osobě
GET person/getAll – získání seznamu osob a základních informací
POST person/create – založení osoby
GET attendance/getPassAll – získání průchodů
GET attendance/getScheduledAction – získání naplánovaných akcí docházky
GET attendance/getSalaryElementsAll – získání všech mzdových složek a detailů k nim (mzdová složka musí mít zadaný Externí kód) – důležité pro získání informací ke složkám a následnému získání spočítaných dat docházky
POST attendance/getAttendanceData – spočítaná docházková data
