Avant de commencer
Vous pouvez créer des clés d'API pour des collaborateurs ou des utilisateurs robots. Il s'agit d'un code d'identification d'un utilisateur (ou développeur) utilisé pour accéder à nos APIs. Les clés d'API sont utilisées pour suivre et contrôler l'utilisation de l'API. La clé API sert à la fois d'identifiant unique et de jeton secret pour l'authentification et un ensemble de droits d'accès lui est associé.
Attention aux permissions que vous donnez à la clé et à qui vous transférez le token. La personne possédant ce token peut obtenir des informations qui peuvent être confidentielles.
Créer une nouvelle clé API
Pour créer une nouvelle clé API, vous devez vous rendre dans la roue crantée > Authentification, SSO et API > Clés API. Si vous n'avez pas les droits d'accès, veuillez contacter votre administrateur pour qu'il vous génère une clé API et si vous êtes administrateur sans accès aux rôles, veuillez, contactez le support.
Cliquez sur Générer une nouvelle clé d'API pour créer une clé.
Dans la fenêtre de création :
- Personnalisez éventuellement le nom que vous souhaitez associer à cette clé
- Sélectionnez les droits que vous souhaitez associer à cette clé (il est obligatoire de cocher une permission ici, mais vous pourrez ensuite modifier l'ensemble des permissions de la clé dans les rôles comme précisé plus bas).
- Renseignez un contact technique en cas de question relative à l'utilisation de la clé API (il est obligatoire de renseigner un contact).
- Sélectionnez l'usage que vous souhaitez faire de cette clé (il est obligatoire de cocher un des choix, soit celui de connecter un éditeur tiers via cette clé, soit celui d'utiliser cette clé en interne).
- Options avancées : vous avez la possibilité de personnaliser la clé. Vous devez cependant respecter le format GUID (globally unique identifier), un identifiant unique d’une taille de 16 octets (exemple : [3F2504E0-4F89-11D3-9A0C-0305E82C3301]).
Une fois la clé générée, vous pouvez copier cette clé à son survol :
Modifier les droits associés à une clé existante
Suivant l'utilisation que vous souhaitez faire de votre clé, il vous faudra lui donner les droits associés.
Par exemple, si vous souhaitez récupérer les données collaborateurs d'une section spécifique du dossier RH d'un collaborateur, vous devrez donner le droit à votre clé de consulter cette section.
Si vous souhaitez modifier les droits associés à une clé, rendez-vous dans l’administration des rôles en cliquant sur le lien bleu « administration des rôles » :
Astuce : Si vous avez Poplee Socle RH et que vous avez besoin de restreindre l'accès de la clé à seulement quelques données du dossier RH, il est possible de créer une section dédiée dans Poplee Socle RH et de donner les droits de visibilité à cette section uniquement. Ainsi, les personnes possédant le token de la clé API pourront accéder uniquement à ces données là.
Une fois la clé créée, vous pouvez utiliser nos APIs. Pour en savoir plus sur nos différentes APIs, nous vous invitons à consulter la documentation API.