- 04 Apr 2024
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
Configuration d'accès API
- Mis à jour le 04 Apr 2024
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
Pour pouvoir exploiter les API REST Silae Paie, il est nécessaire d'avoir les autorisations d'accéder aux données des dossiers avec lesquels on souhaite interagir. Pour cela il faut configurer un accès API sur les dossiers concernés.
Les prérequis
L'utilisateur doit être autorisé à accéder à la fonction Configuration API
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 un 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.
Le fonctionnement décrit ci-dessous n'est valable que pour ouvrir des accès à un compte API REST. Ce n'est pas valable pour les connexions API SWS-SOAP.
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 :
- 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).
- Compte API : Le compte API pour lequel est octroyé l'accès
- Utilisateur Silae : L'utilisateur Silae auquel est rattaché l'accès API.
- Accès : option qui permet de définir le périmètre de la configuration API.
Administration colaborateurs de paie : non utilisée
Tous les dossiers du domaine : tous les dossiers seront sélectionnés y compris ceux ajoutés au domaine à posteriori.
Un ou plusieurs dossiers : une sélection de dossiers
- 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 :
- Un dossier qui possède le statut Actif est un un dossier qui est pris en compte dans la configuration d'accès API
- Un dossier qui possède le statut Inactif est un un dossier qui n'est pas pris en compte dans la configuration d'accès API
La fonction Paramétrage paie>Bouton API>Configuration API propose également de :
- Bloquer/Autoriser l'accès API permet de bloquer l'accès API pour empêcher le compte API d'accéder au dossier. Peut être une solution pour bloquer l'accès API temporairement, sans le supprimer.
- Supprimer la configuration d'accès API
- Créer une nouvelle configuration d'accès API
- Ouvrir dans un tableur la liste des configurations 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 (fichier .csv ou .xls)
- Importer les dossiers de configurations API (fichier .csv ou .xls) permet d'importer les dossiers en mode ajout. Cela signifie que, si la configuration concernée possède déjà des dossiers associés, Ils sont conservés et les nouveaux dossiers présents dans le fichier d'import viendront s'ajouter.
À la création, une configuration d'accès API est Autorisée et Désactivée. Pour pouvoir l'utiliser, le propriétaire du compte API concerné devra activer la configuration d'accès API depuis le Portail API (cf. détail dans la section dédiée au Portail API)