Dosys:API: Porovnání verzí
Skočit na navigaci
Skočit na vyhledávání
Bez shrnutí editace |
|||
| (Není zobrazeno 9 mezilehlých verzí od stejného uživatele.) | |||
| Řádek 1: | Řádek 1: | ||
{{DISPLAYTITLE:API systému DOSYS}} | {{DISPLAYTITLE:API systému DOSYS}} | ||
{{VERSIONINFO|Dosys| | {{VERSIONINFO|Dosys|5.1.3.3}} | ||
== Přehled == | == 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. | 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. | ||
| Řádek 20: | Řádek 20: | ||
|colspan="4"| '''Přístup k datům docházkového systému''' | |colspan="4"| '''Přístup k datům docházkového systému''' | ||
|- | |- | ||
| ?doc=api/ | | ?doc=api/setup || Parametry docházky. || [[{{NAMESPACE}}:API/setup/GET|GET]] | ||
|- | |- | ||
| ?doc=api/ | | ?doc=api/employee || Přístup k datům zaměstnance. || [[{{NAMESPACE}}:API/employee/GET|GET]], [[{{NAMESPACE}}:API/employee/POST|POST]], [[{{NAMESPACE}}:API/employee/PATCH|PATCH]] | ||
|- | |- | ||
| ?doc=api/ | | ?doc=api/orderItem || Přístup k datům projektu. || [[{{NAMESPACE}}:API/orderItem/GET|GET]] | ||
|- | |- | ||
| ?doc=api/attendance | | <span style="white-space:nowrap">?doc=api/orderItemActivity</span> || Přístup k aktivitám projektu. || [[{{NAMESPACE}}:API/orderItemActivity/GET|GET]] | ||
[[{{NAMESPACE}}:API/orderItemActivity/POST|POST]] | |||
[[{{NAMESPACE}}:API/orderItemActivity/PATCH|PATCH]] | |||
|- | |||
| ?doc=api/pass || Přístup k datům průchodů. || [[{{NAMESPACE}}:API/pass/GET|GET]], [[{{NAMESPACE}}:API/pass/POST|POST]] | |||
|- | |||
| ?doc=api/attendance || Docházka jednotlivých zaměstnanců za zadané období po dnech. Údaje odpovídají sestavě [[{{NAMESPACE}}:Sestava výkaz odpracovaného času|výkaz odpracovaného času]]. || [[{{NAMESPACE}}:API/attendance/GET|GET]] | |||
|- | |- | ||
|colspan="4"| '''Export dat do systému JOBKA''' | |colspan="4"| '''Export dat do systému JOBKA''' | ||
|- | |- | ||
| ?doc=api/jobka/days | | ?doc=api/jobka/days || Denní export dat pro systém JOBKA. || [[{{NAMESPACE}}:API/jobka/days/GET|GET]] | ||
|- | |- | ||
| ?doc=api/jobka/months | | ?doc=api/jobka/months || Měsíční export dat pro systém JOBKA. || [[{{NAMESPACE}}:API/jobka/months/GET|GET]] | ||
|- | |- | ||
| ?doc=api/jobka/shifts || Export plánu směn pro systém JOBKA. || [[{{NAMESPACE}}:API/jobka/shifts/GET|GET]] | | ?doc=api/jobka/shifts || Export plánu směn pro systém JOBKA. || [[{{NAMESPACE}}:API/jobka/shifts/GET|GET]] | ||
| Řádek 42: | Řádek 48: | ||
|- | |- | ||
| string || Jakákoliv hodnota. || <pre>Centrala</pre> | | string || Jakákoliv hodnota. || <pre>Centrala</pre> | ||
|- | |||
| int || Celé číslo. || <pre>120</pre> | |||
|- | |- | ||
| date || Datum ve formátu yyyy-MM-dd. || <pre>2023-01-14</pre> | | date || Datum ve formátu yyyy-MM-dd. || <pre>2023-01-14</pre> | ||
|- | |||
| dateTime || Datum a čas ve formátu ISO-8601 || <pre>2023-01-14T16:00:10+02:00</pre> | |||
|- | |- | ||
| stringList || Seznam hodnot, oddělených čárkou. Pokud seznam není uveden a ukončen hranatou závorkou, je zpracován jako jedna hodnota. || | | stringList || Seznam hodnot, oddělených čárkou. Pokud seznam není uveden a ukončen hranatou závorkou, je zpracován jako jedna hodnota. || | ||
Aktuální verze z 2. 7. 2025, 14:36
Dosys 5.1.3.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řte speciální typ uživatele tak, aby
- neměl kromě API přístupné žádné jiné funkce aplikace,
- přístup k API měl nastaven podle toho, zda bude pouze číst data (GET) nebo data i zapisovat (POST,PATCH..).
- Vytvořte speciálního uživatele, jeho přihlašovací údaje použijte pro přihlášení k API.
- 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/setup | Parametry docházky. | GET | |
| ?doc=api/employee | Přístup k datům zaměstnance. | GET, POST, PATCH | |
| ?doc=api/orderItem | Přístup k datům projektu. | GET | |
| ?doc=api/orderItemActivity | Přístup k aktivitám projektu. | GET | |
| ?doc=api/pass | Přístup k datům průchodů. | GET, POST | |
| ?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 | |
| ?doc=api/jobka/shifts | Export plánu směn pro systém JOBKA. | GET | |
Typy parametrů
| Typ | Popis | Příklady |
|---|---|---|
| string | Jakákoliv hodnota. | Centrala |
| int | Celé číslo. | 120 |
| date | Datum ve formátu yyyy-MM-dd. | 2023-01-14 |
| dateTime | Datum a čas ve formátu ISO-8601 | 2023-01-14T16:00:10+02:00 |
| 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] |