Accès aux API :
Les API sont disponibles dans la "Configuration>API"
Une nouvelle documentation sera bientôt disponible sur l'application via la barre de tâche de gauche.
Les URLs :
L'URL d'une requête est formé par :
- l’URL de base de votre environnement Fitnet Manager,
- suivi de /rest/
- suivi de la requête que vous trouverez dans les onglets ci-dessus ou dans notre documentation.
Exemple : https://evaluation.fitnetmanager.com/FitnetManager/rest/contractTypes
Cette requête renvoie l'ensemble des types de contrat de travail.
Changez "evaluation" par votre nom de domaine
L'authentification :
Il est nécessaire de s'authentifier pour pouvoir faire une requête. L'authentification utilisé est Basic_Auth, c'est à dire, un login et un mot de passe cryptés en base64.
Seules les informations de connexion d'un administrateur API permettent d'exécuter une requête.
Pour donner un rôle utilisateur administrateur API il faut cocher la case Admin. API dans le tableau des rôles dans Configuration > Utilisateurs > Gérer les rôles :
(Selon votre paramétrage, 2 ergonomie de tableau existent.)
Les requêtes :
Les échanges sont basés sur des requêtes clients et serveurs : le client fait une requête HTTP, le serveur renvoie une réponse.
Les requêtes disponibles sont les différentes méthodes HTTP :
- GET
Récupérer des données d'une ressource
- POST
Ajouter des données à une ressource
- PUT
Modifier des données à une ressource
- DELETE
Supprimer des données d'une ressource
Les objets de la requête :
Sur la majorité des requêtes, il faut modifier les objets dans l'URL par vos paramètres de recherches.
Exemple :
https://evaluation.fitnetmanager.com/FitnetManager/rest/contractTypes/{companyId}
Cette requête renvoie l'ensemble des types de contrat de travail par société.
Il faut changer "{companyId}" dans l'URL pour y mettre le paramétrage que vous souhaitez. Ici l'ID d'une de vos sociétés.
Si vous voulez l'ensemble des types de contrats de travail pour la société avec un ID=2 :
https://evaluation.fitnetmanager.com/FitnetManager/rest/contractTypes/2
Les réponses :
La réponse renvoyée par l'API est une représentation de la ressource sous format JSON.
Exemple :
https://evaluation.fitnetmanager.com/FitnetManager/rest/contractTypes
