Employees
An employee in the Sailplay system is a user on whose behalf authorization occurs and various actions are performed in the system. An employee can be both a real person and a virtual user representing part of an automated system or an external application.
Each employee belongs strictly to one Department. All interaction with Sailplay is carried out on behalf of an employee.
| Who (what) can be an employee? | Examples |
|---|---|
| Person (salesperson, cashier) | Salesperson in a store |
| External IT system or website | Account of a website, mobile application, or checkout system |
Why Employees are Needed
Using employees in Sailplay helps solve the following tasks:
- Separation of access and responsibility — each employee has their own set of rights, making it easy to control who performed an action.
- Separate analytics — the ability to detail reporting and analytics down to the level of an individual employee.
- Security — all actions of an employee are signed with their personal PIN code.
- Automation of integrations — creating separate employees for external systems allows for the isolation of API requests.
Employee Access to Interface and API
There are two ways to create employees, depending on the required access level.
Creating an Employee with Access to the Dashboard
An invitation link is used to provide access to the Sailplay interface. A user with administrative rights can create it.
- In the left menu, open Settings
- Go to the Departments section
- Select the desired department
- Open the Employees tab
- Click Invite
- Select a role and copy the invitation link
Creating an Employee without Access to the Interface (for API)
Such an employee does not have access to the dashboard but is used for authorizing actions via the API using a personal PIN code. This approach is used for websites, mobile applications, and checkout systems.
How to Create an Employee for the API:
- In the left menu, open Settings
- Go to the Departments section
- Select the desired department
- Go to the Employees tab
- Click Add Employee
- Fill in the mandatory fields
- Copy the PIN code from the employee card
API for Working with Employees
| Group | Method Purpose | Method |
|---|---|---|
| Employees | Create employee | /partners/managers/create/ |
| Edit employee | /partners/managers/edit/ | |
| Delete employee | /partners/managers/delete/ | |
| Get list of employees | /partners/managers/list/ |
Employee Roles
An employee's role determines the level of access to Sailplay functionality.
- The list of standard roles is available in Settings → Roles
- You can create your own roles with a custom set of rights
- For integrations via the API, the admin role is recommended