API for customers
What a direct connection between Inallow and your own programs allows, and how to request access.
If your company wants another program to work with Inallow data (the payroll program, the ERP, your own access control system…), it can use the Inallow API: a direct connection between programs, without going through the admin panel or downloading reports. This page sums up what it allows; the connection is set up by your IT department or your software provider.
What it allows
| Data | What can be done |
|---|---|
| Employees | Look up the list of employees and each one's details: first and last name, email, language, phone, work centre and whether they receive visits. |
| Work centres | Look up the centres with their address and location. |
| Projects | Look up the projects and whether they are active. |
| Reasons | Look up the break and leave reasons. |
| Clock-ins | Look up an employee's clock-ins between two dates (up to 31 days per query), and create, change and delete clock-ins. |
Clock-ins that come in through the API follow the same rules as all the others:
- They cannot overlap with another clock-in of the same employee; if they overlap, they are rejected.
- They are only accepted for employees who can clock in from the API. By default everyone can; the General Administrator can turn it off per employee in Inallow Admin (Clocks tab, option "Enable signings made via the API"). See Where each employee can clock in from.
- They appear in the admin panel like any other clock-in. See Clock-ins.
How to get access
API access is not turned on from the admin panel. Ask Inallow for it: they will set up a special API user for you, with its access key, and give you the technical documentation for the person who is going to build the connection.
The API user only works with your company's data.