— See the English version below —

Prérequis

Veuillez lire attentivement ce qui suit pour vous assurer que vous remplissez toutes les conditions requises pour configurer l'intégration :

Pour configurer l'intégration avec Lucca, vos rôles d'utilisateur doivent inclure :

• Autre > Lucca > Gestion des rôles et des clés API

Pour vérifier que vous avez ce rôle :

1. Naviguez vers le coin supérieur droit de l'écran et cliquez sur l'icône d'engrenage
   
2. Cliquez sur Clés API
   
3. Assurez-vous que vous pouvez voir le bouton Générer une (nouvelle) clé d’API
   
   

Si vous ne pouvez pas suivre ces étapes, vous n'avez pas les autorisations suffisantes pour configurer cette intégration. Veuillez demander à un administrateur système d'attribuer le rôle "Gestion des rôles et des clés API" à votre compte.

Instructions

Trouver votre domaine

1. Connectez-vous à Lucca.
2. Visualisez votre domaine dans la barre d'URL sous la forme https://exemple.ilucca.net
   

Création d'une clé API

1. Connectez-vous à Lucca.

2. Naviguez vers le coin supérieur droit de l'écran et cliquez sur l'icône "engrenage".
   

3. Cliquez sur le bouton "Générer une nouvelle clé API" pour créer une clé API.
   

4. Pour générer une clé API, suivez les étapes suivantes:

   1. Entrez un nom de votre choix pour votre clé API sous "Nom de la clé".

   2. Pour créer une clé, vous devez sélectionner au moins une autorisation. Nous vous recommandons de sélectionner "Collaborateurs -> Consulter / créer / modifier les utilisateurs", et ne vous inquiétez pas, vous pourrez affiner les autorisations ultérieurement.

   3. Entrez l'adresse e-mail de quelqu'un du département IT ou RH qui est responsable de cette intégration.

   4. Sélectionnez "Usage interne" sous "Contact technique".

   5. Cliquez sur le bouton "Générer une nouvelle clé API".

    

5. Vous pouvez trouver votre clé API nouvellement créée ici. Vous pouvez passer votre curseur sur la clé pour la copier.

6. Facultatif: dans le flux de connexion consultez les champs de données optionnels et désactivez les autorisations pour ceux qui ne vous sont pas nécessaires.

   

7. Entrez le domaine de votre espace de travail Lucca et collez la clé API que vous avez copiée dans le flux de connexion, puis cliquez sur "Continuer".

   

8. Ensuite, vous devez activer les autorisations demandées à partir du flux de connexion:

   

9. Retournez à la page des clés API de Lucca et localisez la clé que vous venez de créer par le nom que vous avez saisi précédemment. Dans cet exemple, "API integration 1704395484089". Puis cliquez sur "administration des rôles"

   

10. Dans la page "Rôles", localisez votre clé API par son nom ("API integration 1704395484089" dans ce cas) dans la barre latérale à gauche de l'écran, et cliquez dessus.

    

11. Si l'autorisation demandée est "Office -> Voir le planning" par exemple, vous pouvez l'activer en trouvant l'autorisation parente ("Office") sous l'onglet "Permissions", cliquez sur l'onglet, puis cliquez sur l'icône "plus" pour l'activer.

    

12. Vous devriez pouvoir voir les sous-autorisations sur la page. Ensuite, vous pouvez activer les sous-autorisations demandées (par exemple "Voir le planning") en cliquant sur la case à cocher.

    

13. Facultatif: pour activer les autorisations de lecture des titres-restaurant:

    1. Localisez la section « Paie » et cliquez sur le bouton « Ajouter un accès » sur Paie.

       

    2. Assurez-vous que l'autorisation « Administration des titres-restaurant » est activée.

       

14. Répétez ce qui précède pour toutes les autorisations demandées dans le flux de connexion. Cliquez sur le bouton "Enregistrer" dans le coin inférieur droit de l'écran une fois que vous avez terminé.

    

15. Complétez la configuration en cliquant sur le bouton "Configurer l'intégration" dans le flux de connexion

    

Prerequisites

Please carefully read the following to make sure you fulfill all the requirements to set up the integration:

In order to set up the integration with Lucca, your user roles must include:

• Other > Lucca > Roles and API Key management

To validate that you have this role:

1. Navigate to the top right corner of the screen and click on the cog icon:
   
2. Click on API Keys
   
3. Ensure that you can see the Generate API Key button
   

If you can not follow these steps, you do not have sufficient permissions to set up this integration. Please ask a system administrator to assign the "Roles and API Key management" role to your account.

Instructions

Finding your domain

1. Log into Lucca.
2. View your domain in the URL bar in the form of https://example.ilucca.net
   
   
   

Creating API key

1. Log in to Lucca.
2. navigate to the top right corner of the screen and click on the "cog" icon:
   
   
   
3. Click on "Generate a new API Key" button to create an API key:
   
   
   
4. To generate an API key use the following steps:
   1. Enter a name of your choosing for your API key under "Key name".
   2. In order to create a key, you need to select at least one permission. We recommend you to select "Co-workers -> Consult / create / modify users", and don't worry, you can fine tune the permission later.
   3. Enter an email address of someone in the IT or HR department that's responsible for this integration.
   4. Select "Internal use" under "Technical contact"
   5. Click "Generate a new API key" button.
   
   
5. You can find your newly created API key here:
   
   • You can hover your cursor over the key to copy it.
     
6. Enter the domain of your Lucca workspace, and paste the API key you copied into the connection flow, then click "Continue":
   
7. Then you need to enable the requested permissions from the connection flow:
   
8. Go back to Lucca's API key page, and locate the key that you've just created by the name that you had entered earlier. In this example, "API integration 1704395484089". Then click on "role administrations":
   
   
   
9. In the "Roles" page, locate your API key by its name ("API integration 1704395484089" in this case) in the sidebar on the left side of the screen, and click on it.
   
   
   
10. If the requested permission is "Timmi Office -> See the schedule" for example. You can enable it by finding the parent permission ("Timmi Office") under the "Permissions" tab, click on the the tab, then click on the "plus" icon to enable it:
    
11. You should be able to see the sub permissions on the page. Then, you can toggle on the requested sub permissions ("See the schedule" for example) by clicking on the checkbox:
    
12. Repeat the above for all the requested permissions in the connection flow. Click on the "Save" button on the button right corner of the screen once you're done:
    
13. Complete the setup by clicking on the "Set up integration" button in the connection flow: