API systému DOSYS

Z Astea wiki
Skočit na navigaci Skočit na vyhledávání

Dosys 4.3.4.3

Přehled

Docházkový systém DOSYS obsahuje kanály API, umožňující přístup k datům docházky a to jak pro čtení, tak i v některých případech pro zápis dat do docházkového systému. Data jsou až na výjimky předávána ve formátu JSON se znakovou sadou UTF8.

Ověření, zabezpečení

Ověření všech API kanálů je pomocí Basic authentication, jako přihlašovací jméno a heslo lze použít heslo uživatele systému DOSYS který má povolena přístupová práva k API.

Doporučené nastavení zabezpečení

  • Pro přístup k API vytvořit speciální typ uživatele
    • Nebude mít kromě API přístupné žádné jiné funkce aplikace.
    • Přístup k API bude nastaven podle toho, zda je potřeba pouze číst data (GET) nebo data i zapisovat (POST,PATCH..).
  • Vytvořit speciálního uživatele, typ uživatele mu nastavit na výše uvedený typ.
  • Pokud nelze v aktuální verzi DOSYS vytvořit uživatele bez vazby na zaměstnance, vytvořte speciálního zaměstnance.

Seznam přístupových bodů

URL api Popis Metody
Přístup k datům docházkového systému
?doc=api/employee Přístup k datům zaměstnance. GET, POST, PATCH
?doc=api/attendance Docházka jednotlivých zaměstnanců za zadané období po dnech. Údaje odpovídají sestavě výkaz odpracovaného času. GET
Export dat do systému JOBKA
?doc=api/jobka/days Denní export dat pro systém JOBKA. GET
?doc=api/jobka/months Měsíční export dat pro systém JOBKA. GET

Typy parametrů

Typ Popis Příklady
string Jakákoliv hodnota.
Centrala
date Datum ve formátu yyyy-MM-dd.
2023-01-14
stringList Seznam hodnot, oddělených čárkou. Pokud seznam není uveden a ukončen hranatou závorkou, je zpracován jako jedna hodnota.
745
[Centrala,Vyroba]

Odkazy

Domovská stránka