This guide will quickly show you how to set up the Lucca integration.
In the first part, we will walk you through the generation of an API key, in the administration section of Lucca.
In the second part, we will explain how to add it and install the application in Semana. The purpose of the Lucca integration is to synchronize with Semana your days off and remote working days. This way, all remote working days booked in Semana will be reported in Lucca, and absences reported in Lucca will be reported in Semana, all automatically.
- 1. Generate an API Key in Lucca
- 2. Add the API key to Semana and install the integration
- 3. Common Questions.
1. Generate an API Key in Lucca
1.1 Create the API key
- Go to your Lucca account settings at the top right of the page, and click on "API Keys".
- Click on "Generate new API key".
- Give a name to your API key, and make sure that the checkboxes "View absences", "Make absence requests" and "View / create / modify users" are active.
Then click on the button: "Generate a new API key" at the bottom right of the page.
1.2 Manage the rights associated to your API key.
Once the API key is generated, you will find it in your main page. In order to verify that the rights are those required for Semana integration, click on the "role administration" button of your new API key.
Under "Collaborators", verify that 1 operation has been selected:
- View Lucca data of collaborators.
Under "Figgo", check that 5 operations have been selected:
- Make and cancel a request.
- Consult the absences.
- Display the details of the absences.
- Delete an absence.
- Set up.
Once these rights have been updated, click "Save" at the bottom of the page.
2. Add the API key to Semana and install the integration
The API with the correct permissions has been generated. Now you can go to your Semana account and install the Lucca integration.
Go to the "Settings" menu and go to the "Integration" tab. Click on the "Login" button below the Lucca icon. A submenu will open asking you for several pieces of information in order to link your Semana account to your Lucca account.
You will need to fill in:
- your API key
- your base URL (This is your own URL https://xxx.ilucca.net)
You also need to check the boxes corresponding to the type of integration you want.
We currently offer three types of integrations:
- User synchronization.
- Leave synchronization
- Remote working synchronization
2.1 User synchronization.
User synchronization allows Semana to use Lucca as a source of truth. Thus, if enabled, users added in Lucca will be automatically transferred to Semana. Only collaborators with a Semana account will be transferred.
When employee synchronization is enabled, employees are added one week before the start of their contract (contract start in Lucca). For this to work, it must be added to the API key.
2.2 Synchronization of vacations.
For days off, the direction of the sync is from Lucca to Semana. This will mean that collaborators will keep adding their days off in Lucca, and these will appear on Semana.
All leaves entered in Lucca will appear in Semana as Absence, this will keep confidentiality about the reason of the absence.
2.3 Synchronization of remote working days.
For remote working, the direction of the sync is from Semana to Lucca. This means collaborators add their days of remote working on Semana, and they will be added on Lucca.
We advice our clients to activate this option only after the launch of the account. In fact, this risks to delete some data of remote working days that collaborators added in Lucca and not on Semana.
Once everything is entered, click save and Semana will activate the integration with Lucca.
Currently, the synchronization of booking is done with 6 weeks in the past and 6 weeks in the future.
3. Common Questions.
When is the sync done between Lucca and Semana?
The sync works once a day, every night all days off, remote working days will be synced between Semana and Lucca.
Do Semana work with half days as well ?
Currently, Semana does not support half-day absences, but this feature should be available later this year.