- 28 Jun 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Présentation de l'API Silae RH Pro
- Updated on 28 Jun 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Bienvenue dans la documentation des APIs REST Silae RH Pro. Vous trouverez ici tous les éléments nécessaires à l'utilisation des APIs REST Silae RH Pro.
Préambule et mise en contexte
Une API est une interface logicielle qui permet de « connecter » un logiciel ou un service à un autre logiciel ou service afin d’échanger et d’accéder à des données et d'interagir avec les fonctionnalités du logiciel.
Les API offrent de nombreuses possibilités, comme l’accessibilité, la portabilité ou encore la synchronisation des données dans le but de fluidifier les échanges de manière transparente pour un utilisateur ou un processus avec des applications extérieures.
Le logiciel Silae RH Pro comporte sa propre API afin de permettre d’interfacer des composants de votre système d’information, par exemple votre CRM, votre ERP ou toutes autres applications le permettant. De ce fait, vous pouvez par exemple synchroniser divers éléments comme les collaborateurs, les contrats de travail, les absences et congés, les jours de télétravail, les formations, les sessions de formation, la saisie des temps, etc.
Ces échanges peuvent se paramétrer avec des droits d’accès spécifiques permettant de gérer la création, la modification, la consultation ou la suppression d’une donnée du logiciel Silae RH Pro.
Concernant l'API RH PRO
Cette API, dont vous trouverez le détail de la documentation dans les chapitres suivant, vous permettra d'intéragir avec votre base de données Silae RH Pro via un programme informatique.
L'objectif de Silae est de mettre à disposition les données du SIRH Silae RH Pro via une API afin que vous puissiez consulter et modifier celles-ci à votre convenance par le biais de connecteurs et autres interfaces informatiques.
La mise à disposition des éléments de la base de données sera graduel et versionnée dans le but de vous permettre de réaliser toutes les interactions souhaitées pour optimiser vos processus internes.
Principes généraux
Chaque fonction API est adressée par un endpoint du type https://mon-domaine.silaerh.pro/api/V1/xxx, xxx étant le chemin (le nom) de la fonctionnalité appelée. Le paramètre Content-Type
spécifié en en-tête des appels transmis doit prendre pour valeur application/json
Les fonctions API sont protégées par un token de type JSON Web Token (JWT). Sa valeur est récupérée lors de l'appel à la fonction Login (propriété token).
Pour chaque appel effectué vers un endpoint d'API, il faut spécifier dans les en-têtes, le paramètre Authorization
contenant la valeur du token JWT récupéré lors de la phase de login.