REST API a API klíče
Dokumentace API popisuje endpointy aplikace: přihlášení, evidenci pracovní doby, docházku a reporty. Pro integraci server–server vygeneruje administrátor v panelu API klíče. Klíčem (hlavička X-Api-Key) načtete docházku, tedy pracovní relace zaměstnanců za zvolený den nebo období. Každý klíč deaktivujete jedním kliknutím, bez vlivu na ostatní.
API klíče
Název, oprávnění, volitelná doba platnosti a datum posledního použití. Celý klíč uvidíte jen jednou, v databázi ukládáme jeho hash.
Dokumentace API
Seznam endpointů s popisem na veřejné stránce dokumentace.
Webhook událostí
Zaměstnanec začal nebo skončil práci? Podal žádost o dovolenou? Pošleme POST na vaši adresu.
Exporty pro mzdovou účtárnu
Místo přepisování hodin z tabulky si stáhnete hotový soubor za měsíc a předáte ho účetní nebo ho nahrajete do mzdového programu.
Export CSV (PL i CZ)
Za každého zaměstnance: dny a hodiny práce, přesčasy, přestávky, dny dovolené a nemoci. Otevřete ho v Excelu nebo ho importujete do programu, který přijímá CSV.
Export do PREMIER (CZ)
Soubor pro mzdový program PREMIER. Kódy mzdových složek si nastavíte pro svou firmu a před stažením uvidíte náhled s upozorněními.
Reporty XLSX a PDF
Přehled za období v XLSX a měsíční PDF report s evidencí pracovní doby každého zaměstnance.
Webhook — upozornění v okamžiku události
Místo neustálého dotazování API můžete v nastavení zadat HTTPS adresu svého systému. TimeHunter na ni pošle požadavek POST s daty v JSON, když zaměstnanec začne nebo skončí práci, začne nebo ukončí přestávku, podá žádost o dovolenou nebo když je žádost vyřízena. Každou událost posíláme jednou, takže pokud váš systém nesmí žádnou ztratit, doplňte webhook pravidelným čtením přes API.
6 typů událostí
work_start, work_stop, break_start, break_end, leave_request_created, leave_request_status.
Pouze HTTPS
Adresa musí používat HTTPS a adresy interních sítí jsou blokované.
Test z panelu
V nastavení pošlete testovací událost a ověříte, že ji váš server přijímá.
Příklady použití
Docházka ve vlastním systému
Pracovní relace za zvolené období načtené API klíčem naplní váš mzdový systém nebo ERP.
Tabule docházky v kanceláři
Události začátku a konce práce z webhooku aktualizují obrazovku na recepci nebo v hale.
Reakce na události
Webhook o nové žádosti o dovolenou spustí proces ve vašem systému, bez dotazování API.
Často kladené otázky
Jsou API klíče v každém plánu?
Opakuje se webhook, když můj server neodpoví?
Mohu si udělat vlastní export pro neobvyklý mzdový program?
Vyzkoušet 14 dní zdarma
Začněte 14denní zkušební dobu. Bez karty, plná funkcionalita.