Overview
To authenticate Lucca using an API Key, you will need to provide the following information:
Tenant URL
API key
This guide will walk you through finding or creating those credentials within Lucca.
Prerequisites
You must be an Administrator in your company's Lucca instance, or someone has shared their access with you.
Instructions
Step 1: Locate your Lucca tenant URL
Log into your Lucca tenant
Copy the base URL of your Lucca instance and input it in the linking flow
Step 2: Create an API Key
In the top right, under the Settings gear icon, select API Keys.
Choose Generate a new API Key.
Name your API Key.
Add the following permissions:
Consult / create / modify users (REQUIRED)
Consult leaves (OPTIONAL)
Make absence requests (OPTIONAL)
Enter in your email address as the Technical contact.
Select the API key usage of Third-party publisher.
Click Generate a new API key.
Step 3: Configure Role Permissions
You should now see your API key created on the API Keys page. Select role administration.
Under the Co-workers tab, add the following permissions to the pre-existing set of default permissions:
See future employees
See former employees
View employee jobs (OPTIONAL)
View employee managers (OPTIONAL)
View employee qualifications (OPTIONAL)
Save your role configuration.
Step 4: Enter your API into the linking flow
Back on the API Keys page, copy your new API Key.
Input your API Key into the linking flow.
