What the API can do (overview)
A non-technical tour of the data and actions available through the Shyfter API: departments, schedule, clocking, employees, turnover and exports.
The Shyfter API is organised by main areas, which mirror the modules you already know in the application. Depending on your token's permissions, you can view this data (read) and, if the token is not read-only, act on it (create, modify). Here is what each area offers, without going into the technical detail.
Where to start
First of all, the API offers an entry point that lists your token's permissions and the features active on the account. This is the right starting reflex: you immediately know what your token is allowed to do and whether it is read-only.
Since most data is tied to a department, you first retrieve the list of departments your token has access to, then you specify the relevant department in each call.
The available areas
- Departments: the list of your establishments and accessible departments. This is the basis for then targeting the right data.
- Schedule: your shifts and your hours. View the published schedule and, depending on the rights, create or modify shifts.
- Clocking: work time tracking. You can retrieve clockings, clock an employee in or out, and cancel an ongoing clocking.
- Employees: your employees' information, with their contracts, their skills and their absence management.
- Sections: the sections of your establishments (bar, kitchen, dining room, aisle, etc.), useful for organising the schedule.
- Attributes: the custom attributes you have defined to enrich your data.
- Turnover: pushing in and viewing your turnover, to compare with your worked hours and your costs.
- Exports: retrieving your data as an export, handy for feeding reporting or another software.
The socialSecretary codes are also aligned between shifts and clockings, for a consistent feed to payroll.
Where to find the detail
The full documentation (each area, each field) and an implementation guide are available directly on the Open API platform, for your technical teams or your integrator. This article gives the overview; the online documentation gives the precise instructions.
What your token can actually see or modify depends on the permissions you have granted it and on whether or not it is read-only. If in doubt, check its permissions first.