API klíč: napojení docházky na mzdový nebo HR systém
Na této stránce
Rychlá odpověď
API klíč vytvoříte v Moje Společnost › API Klíče tlačítkem Vytvořit nový API klíč. Pojmenujete ho, zaškrtnete oprávnění – například read:reports pro reporty docházky – a klíč hned zkopírujete, protože se zobrazí jen jednou. Váš programátor s ním z REST API načte docházku, absence, přestávky a projekty ve formátu JSON.
Jak to zapnout
Záložka API Klíče je v každé firmě, nic se nezapíná. Klíče vytváří, odvolává a maže jen Hlavní účet a Administrátor. Role Nastavení společnosti: Čtení a úpravy seznam klíčů jen vidí.
- Moje Společnost
- API Klíče
- Kdo může zapnout
- Hlavní účet a Administrátor.
- Co se změní
- Zaměstnanců ani mobilní aplikace se nic netýká. Klíč patří firmě, ne účtu, který ho vytvořil.
- Platí pro
- Klíč vidí data celé firmy. Oprávnění omezují druh dat, ne pobočky ani zaměstnance.
#K čemu je to dobré
- Hodiny se do vašeho mzdového nebo ERP systému načtou samy, nemusíte je přepisovat z Excelu.
- Vlastní přehledy a dashboardy z aktuálních dat docházky, absencí a projektů.
- Každý klíč má jen oprávnění, která potřebuje, a kdykoli ho odvoláte.
#Pro koho se to hodí
Pro koho ano
- Firmy s vlastním programátorem nebo dodavatelem IT.
- Mzdové kanceláře a větší firmy s vlastním systémem pro import hodin.
Pro koho ne
- Většina menších firem. Jednodušší je export docházky do Excelu nebo export do mzdového programu, který zapne podpora FreshQR.
- Kdo čeká hotové napojení na konkrétní HR systém nebo okamžité zasílání změn. API data jen poskytuje, váš systém si je musí načíst sám.
#Postup krok za krokem
-
Klikněte na Vytvořit nový API klíč.
V Moje Společnost › API Klíče klikněte na Vytvořit nový API klíč, u prvního klíče na Vytvořit první API klíč. Do pole Název (volitelné) napište, k čemu klíč slouží, například „Mzdový systém – export“.
-
Vyberte oprávnění.
Oprávnění jsou ve dvou sloupcích: Čtení (jen zobrazení dat) a Zápis (vytváření, úprava a mazání). Zaškrtněte jen to, co integrace opravdu potřebuje. Pro načítání hodin do mzdového systému obvykle stačí read:reports. Volba read:* dá přístup ke všem datům pro čtení. Bez aspoň jednoho oprávnění klíč nevytvoříte.
Klíči dáte jen potřebná oprávnění -
Zkopírujte klíč.
Klikněte na Vytvořit API klíč. Okno API klíč vytvořen ukáže celý klíč s upozorněním
Důležité: Tento API klíč uvidíte pouze nyní. Uložte si ho bezpečně!
Klikněte na Kopírovat a zavřít. Později klíč zobrazit nejde.
Klíč si hned zkopírujte, podruhé se nezobrazí -
Předejte klíč a dokumentaci svému IT.
Klíč pošlete bezpečnou cestou, ne v běžném e-mailu nebo chatu. Na stejné záložce je rozbalovací panel API dokumentace se základní adresou API, způsobem přihlášení klíčem a příklady volání – ten předejte programátorovi spolu s klíčem. Pod ním jsou doporučené bezpečnostní zásady.
Dokumentace API je přímo v aplikaci -
Kontrolujte, jestli se klíč používá.
Tabulka klíčů ukazuje Název, Oprávnění, Stav, Vytvořeno a Naposledy použito. Klíč, který se dlouho nepoužívá, dostane štítek Nepoužito více než 30 dní – zatím se ukazuje i u nového klíče, který ještě nikdo nepoužil.
Přehled API klíčů a jejich použití
#Jaká data API nabízí
| Oprávnění | Data |
|---|---|
| read:reports | Reporty docházky, absencí, přestávek a projektů, denní a měsíční přehledy. |
| read:attendance | Docházka, jednotlivé skeny a kdo je právě v práci. |
| read:absences | Absence zaměstnanců. |
| read:breaks | Přestávky. |
| read:projects, read:approved-project-hours | Projekty a schválené hodiny na projektech. |
| read:employees | Seznam zaměstnanců s kontakty. |
| write:… a delete:… | Vytváření a úprava absencí, projektů, poboček, docházky a zaměstnanců, mazání docházky a poboček. |
Oprávnění pro zápis a mazání dávejte jen zkušenému integrátorovi a jen tehdy, když je opravdu potřebuje. Zápisy přes API se projeví v docházce a reportech stejně jako ruční úpravy – nezapisujte jimi do měsíců, které už máte uzavřené.
#Odvolání a smazání klíče
- OdvolatIkona přeškrtnutého kolečka u klíče otevře Potvrdit odvolání. Po kliknutí na Odvolat klíč okamžitě přestane fungovat a v seznamu zůstane se stavem Odvolaný.
Odvolaný klíč okamžitě přestane fungovat - SmazatČervený koš klíč po potvrzení smaže. Přestane fungovat a zmizí ze seznamu. Odvolání ani smazání nejde vrátit.
Odvolaný klíč zůstane v seznamu, dokud ho nesmažete
#Zvláštní případy a tipy
- Ztratili jste klíč
- Znovu ho zobrazit nejde. Vytvořte nový, předejte ho integrátorovi a starý odvolejte.
- Změna oprávnění
- Oprávnění existujícího klíče upravit nejde. Vytvořte nový klíč s jinými oprávněními a starý odvolejte.
- Odchod administrátora
- Klíč patří firmě. Když smažete účet administrátora, který klíč vytvořil, klíč funguje dál. Pokud ho už nechcete, odvolejte ho.
- Čísla nesedí s webem
- Délky v reportech API mají dvě podoby. Pole končící na _as_in_reports_minutes jsou spočítaná stejně jako ve webové aplikaci a exportech – ať je integrátor používá.
#Časté dotazy
Může klíč vytvořit manažer?
Ne. Jen Hlavní účet a Administrátor. Role Nastavení společnosti: Čtení a úpravy klíče jen vidí.
Vidí klíč jen některé pobočky?
Ne. Klíč vždy vidí data celé firmy. Oprávnění omezují jen druh dat.
Posílá API změny samo, třeba přes webhook?
Ne. Váš systém si data načítá sám, například jednou denně.
Je API v češtině?
API vrací data ve formátu JSON. Dokumentace v aplikaci má české popisky, názvy oprávnění a polí jsou anglicky.
#Související
Jste tadyAPI Klíče a REST API
Administrátor
Webová aplikace (administrátor)Mobilní aplikace (zaměstnanec)
