Configuration d'accès API

Introduction

Pour pouvoir exploiter les API REST Silae Paie, il est obligatoire de posséder les autorisations d'accès afin de pouvoir interagir avec les données de la paie.

Pour cela il est nécessaire de configurer un accès API sur le ou les dossiers de paie concernés.

Les prérequis

L'utilisateur doit être autorisé à accéder à la fonction Configuration API

A noter : ce droit doit être affecté à des comptes collaborateurs qui ont un accès sur tous les dossiers de paie du domaine.

Pour définir une configuration API, nous avons besoin de :

• Un compte API REST (cf. la fiche concernant la contractualisation et la facturation).
• Un utilisateur Silae qui peut correspondre à une fiche Collaborateur ou une fiche Contact et qui doit posséder les droits nécessaires pour exécuter les fonctions API REST.
  Exemples :
  • Un compte utilisateur Silae qui ne possède pas le droit de modifier une fiche Salarié, dans ce cas, un message d'erreur sera renvoyé si le compte API tente de modifier la fiche salarié
  • Un compte utilisateur Silae qui n'a pas accès au dossier de paie, aucune fonction API pourra s'exécuter.

Composition d'une configuration d'accès API

La fonction Paramétrage paie>Bouton API>Configuration API permet d'accéder à la liste des configurations d'accès API.

Elle permet de :

• Afficher tous les accès API octroyés dans le domaine.
• Modifier leur contenu
• Mettre en place un nouvel accès API.

Chaque configuration d'accès contient les informations suivantes :

1. ID unique de configuration d'accès API : ID unique qui permet d'identifier la configuration d'accès API. Cet identifiant peut être copié dans le presse-papier (clic droit).
2. Compte API : Le compte API pour lequel est octroyé l'accès
3. Utilisateur Silae : L'utilisateur Silae auquel est rattaché l'accès API.
4. Accès : option qui permet de définir le périmètre de la configuration API.

L'option Accès

3 choix sont proposés :

- Administration collaborateurs de paie : non utilisée
- Accès à tous les dossiers du domaine : tous les dossiers seront sélectionnés y compris ceux ajoutés au domaine à posteriori.
- Accès à un ou plusieurs dossiers : à partir de la liste des dossiers de paie du domaine, une sélection de dossiers peut être réalisée.

Le bouton Filtrer permet de filtrer la liste des dossiers selon les colonnes proposées.

La sélection peut s'effectuer de manière globale par ou individuel par
Les actions située dans le menu de droite permettent d'Activer le(s) dossiers(s) à la sélection ou Désactiver le(s) dossiers(s) à la sélection

La colonne Statut

Un dossier qui possède le statut Actif est un dossier qui est pris en compte dans la configuration d'accès API
Un dossier qui possède le statut Inactif est un dossier qui n'est pas pris en compte dans la configuration d'accès API

La colonne Dossier obsolète

Elle permet d'indiquer si le dossier a été déclaré inactif en production (fiche Société)

Remarque : Cette même colonne peut être utilisée comme filtre pour exclure les dossiers inactifs de la liste depuis le bouton

A noter : Un dossier de paie actif dans une configuration d'accès API qui a été déclaré obsolète par la suite (inactif en production depuis la fiche Société), est automatiquement exclu de la liste des dossiers au niveau du portail API.

La sauvegarde d'une configuration API

La sauvegarde de la configuration API fait apparaitre le message suivant :

Il est important de bien sélectionner l'accès pour ne pas être facturé sur des dossiers de paie qui ne sont pas concernés par un usage API REST.

• Un compte API de production modèle 1A (ex : CABINET FRANCE - 1A) est inclus dans l'offre Silae Paie : aucune facturation ne sera générée.
• Un compte API de production modèle 1B (ex : CABINET FRANCE - 1B) ou modèle 2 (ex: CABINET FRANCE - CLIENT SARL) : une facturation sera générée en fonction des dossiers sélectionnés.
• Un compte API de production modèle 4 ou modèle Lucca : une facturation sera générée à l'éditeur en fonction des dossiers sélectionnés.

A noter : La mise à jour d'une configuration d'accès API nécessite quelques minutes de traitement avant que la liste définitive des dossiers de paie affectés soit prise en compte.

Les autres actions de la fonction

Bloquer/Autoriser l'accès API permet de bloquer l'accès API pour empêcher le compte API d'accéder au dossier. Solution qui permet de bloquer l'accès API temporairement, sans le supprimer.

Supprimer la configuration permet de supprimer la configuration d'accès API sélectionnée

Créer une configuration permet de mettre en place une nouvelle configuration d'accès API

Ouvrir dans un tableur permet d'exporter et d'ouvrir dans un tableur la liste des configurations d'accès API

Exporter toutes les configurations API permet d'exporter la liste des dossiers par ID unique de configuration au statut Activé et un Accès à un ou plusieurs dossiers du domaine.

Importer des configurations API permet d'importer des configuration d'accès API depuis un fichier au format Excel ou CSV

Importer les dossiers de configurations API (fichier .csv ou .xls) permet d'importer et ajouter des dossiers de paie à une ou plusieurs configurations d'accès API

Une configuration API qui possède déjà des dossiers associés, ces derniers sont conservés et les nouveaux dossiers présents dans le fichier d'import viendront s'ajouter.