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

1. Log into your Lucca tenant

2. Copy the base URL of your Lucca instance and input it in the linking flow

   
   

Step 2: Create an API Key

1. In the top right, under the Settings gear icon, select API Keys.

   

2. Choose Generate a new API Key.

   

3. Name your API Key.

4. Add the following permissions:

   • Consult / create / modify users (REQUIRED)

   • Consult leaves (OPTIONAL)

   • Make absence requests (OPTIONAL)

     

5. Enter in your email address as the Technical contact.

6. Select the API key usage of Third-party publisher.

7. Click Generate a new API key.

Step 3: Configure Role Permissions

1. You should now see your API key created on the API Keys page. Select role administration.

   

2. Under the Co-workers tab, add the following permissions to the pre-existing set of default permissions:

   1. See future employees

   2. See former employees

   3. View employee jobs (OPTIONAL)

   4. View employee managers (OPTIONAL)

   5. View employee qualifications (OPTIONAL)

   

3. Save your role configuration.

Step 4: Enter your API into the linking flow

1. Back on the API Keys page, copy your new API Key.

   

2. Input your API Key into the linking flow.