Prerequisites
Please read the following carefully to ensure you meet all the requirements to set up the integration:
To set up the integration with Lucca, your user roles must include:
Other > Lucca > Roles and API Key management
To check if you have this role:
In the top right corner of the screen, click the cog icon.
Select API keys.
(the screenshots can be mistranslated as they are AI generated)
Ensure you can see the Generate a new API Key button.
If you cannot follow these steps, you do not have the necessary permissions to set up the integration. Please contact your system administrator to assign the Roles and API Key management role to your account.
Instructions
Creating API key
Log in to Lucca.
Navigate to the top right corner of the screen and click on the "cog" icon, then “Authentification, SSO ans API”, finally on “API keys”:
Click on "Generate a new API Key" button to create an API key:
To generate an API key use the following steps:
Enter a name of your choosing for your API key under "Key Name".
In order to create a key, you need to select at least one permission. We recommend you to select "Collaborator -> View/create/edit users", and don't worry, you can fine tune the permission later.
Enter an email address of someone in the IT or HR department that's responsible for this integration.
Select "Internal usage" under "API Key usage"
Click "Generate a new API Key" button.
You can find your newly created API key by the name that you had entered earlier. In this example, we just created "Integration API 1728285214671". Then click on "roles administration":
In the "Roles" page, locate your API key by its name ("Integration API 1728285214671" in this case) in the sidebar on the left side of the screen, and click on it.
Setup the right permissions
Once you clicked on your API key, click on “Permissions” then make sure the “Talent” is open, and clock on “Collaborator”
Select all the permissions below
View the directory and organisational chart - All departments
View personnel files
View Lucca data for employees
View employee positions
View employee managers
View employee qualifications
View employee contract information
⚠️This section is only applicable if you have Pagga Rem⚠️ Click on “Pagga Rémunération” under the “Pay” section, and select the following rights:
View individual situations
Access the EVP screen
View deleted remuneration
Link your Lucca account with your Figures Account
Now that your API key is properly configured, we need your specific Lucca domain and the API key
You can find your domain in the URL bar (in the form of https://example.ilucca.net)
Paste it in the Figures integration form
Go back in the “API Keys” section from the beginning of this guide, you can click on “API keys” as shown in the screenshot below:
Find your API key, and click on the icon right next to your key to copy it
Paste it in the “**Lucca API key ***” in Figures’ form, and click on the “save” button.