Dokumentace API
Dokumentace je zatím rozdělená podle části systému. Obě jsou veřejné.
Vlastní reporting a BI
Odpracovanou dobu, přesčasy a výkazy si stáhnete do Power BI, Excelu nebo vlastního reportingu. Bez ručního exportu.
Integrace · Veřejné API
API docházkového a HR systému Alveno
Alveno je docházkový a HR systém s veřejným REST API. Přes API si Vaše IT nebo dodavatel softwaru napojí data z docházky i HR na Vaše vlastní systémy. Dokumentace je otevřená, nemusíte o ni žádat. Nevíte, co si pod API představit? Vysvětlíme to níže lidsky, a Vaše IT to bude vědět.
RESTrozhraní, formát JSON
2dokumentace: docházka i HR
V ceněsoučást Alvena, nic navíc neplatíte
Co je API a proč Vás nemusí zajímat, jak funguje
API je něco jako zásuvka na boku Alvena. Jiný program se do ní zapojí a bere si z Alvena data, která potřebuje: odpracované hodiny, seznam zaměstnanců, výkazy. Vy nic nepřepisujete a neexportujete, systémy si to předají samy.
Napojení nestavíte Vy. Dělá ho Vaše IT nebo dodavatel systému, na který chcete Alveno napojit, a ti přesně vědí, co s naší dokumentací dělat. Stačí jim poslat odkaz na tuto stránku.
Jste z IT? Dokumentaci máte níže. Klíč k API si správce Alvena vygeneruje přímo v nastavení systému.
Co přes API vyřešíte
Mzdový systém, který nemáme v seznamu
Když pro Váš mzdový program nemáme hotový export, dodavatel si data vezme přes API a import si postaví sám.
Seznam zaměstnanců v dalších systémech
Kdo nastoupil, kdo skončil a kdo je na jaké pozici, si další systémy přečtou z Alvena. Jeden zdroj pravdy, žádné dvojí zadávání.
Přístupy, výkazy, odpracovaná doba, výjimky
Autentizace hlavičkou AuthorizationToken. Dokumentace obsahuje popis všech skupin endpointů i ukázkové požadavky.
Zaměstnanci, pozice, záznamy
Autentizace hlavičkou X-API-Key, limit 100 požadavků za minutu. K dispozici je i strojově čitelný popis openapi.json.
Než začnete
Co bude Vaše IT potřebovat
Klíč k API si vygenerujete sami přímo v nastavení Alvena a předáte ho svému IT. Nemusíte o nic žádat. Formát: REST, JSON. Směr dat: z Alvena ven, ostatní systémy si data čtou. Limity: HR část 100 požadavků za minutu.
API je součástí Alvena. Za jeho použití ani za klíč nic dalšího neplatíte.
Nevíte, kde začít?
Napište nám, co chcete na Alveno napojit. Probereme to s Vaším IT nebo dodavatelem a řekneme Vám, jestli to přes API půjde.
Nejčastější otázky a odpovědi
Co je API?
Rozhraní, přes které si jiný program bere data z Alvena automaticky, bez ručního exportu. Napojení stavíte Vy nebo Váš dodavatel, ne my. Dokumentaci máme veřejnou.
Potřebuju na to programátora?
Ano. API je určené pro IT nebo dodavatele systému, který napojujete. Pro běžné exporty do mezd API nepotřebujete, na to máme hotové exporty.
Dá se přes API do Alvena i zapisovat?
Zatím ne. API slouží ke čtení dat z Alvena, zápis do Alvena přes něj dnes neprobíhá.
Je API v ceně Alvena?
Ano. API je součástí Alvena, za jeho použití ani za vydání klíče nic dalšího neplatíte.
Proč jsou dokumentace dvě?
Docházková a HR část Alvena stojí každá na vlastní technologii, proto má každá vlastní dokumentaci. Pro Vás je to jeden systém a jeden dodavatel.
Jak získám přístup?
Klíč k API si vygenerujete sami v nastavení Alvena a předáte ho svému IT nebo dodavateli. O nic nežádáte, nic nečekáte.