L’interface de programmation d’applications (API) de KnowBe4, réservée aux abonnés Platine et Diamant, vous permet d’extraire des données de la console KSAT afin de créer des rapports. Cette fonctionnalité est actuellement limitée aux demandes de données portant sur l’hameçonnage, la formation, les utilisateurs et les groupes. Pour pouvoir utiliser cette API, vous devez vous authentifier auprès de celle-ci à l’aide d’une clé spécifique à votre compte.
Pour en savoir plus sur l’API de rapports et accéder à des exemples de requêtes, consultez notre documentation destinée aux développeurs d’API de rapports. L’API de KnowBe4 est une API de type REST. En utilisant l’API de KnowBe4, vous acceptez nos Conditions générales d’utilisation.
Créer un jeton d’API de rapports
Pour créer un jeton d’API de rapports, procédez comme suit :
- Dans votre console KSAT, cliquez sur votre adresse e-mail dans l’angle supérieur droit de la page, puis sélectionnez Paramètres du compte.
- Accédez à Intégrations du compte > API.
- Sous API de rapports, activez le commutateur Activer l’accès à l’API de rapports.
- Cliquez sur API de rapports. Le sous-onglet API de rapports s’ouvrira alors.
- Dans l’angle supérieur droit du sous-onglet API de rapports, cliquez sur + Créer un nouveau jeton d’API.
- Renseignez les champs de la page Créer un nouveau jeton d’API. Pour en savoir plus, consultez la capture d’écran et la liste ci-dessous :
- Nom : saisissez dans ce champ un nom descriptif pour ce jeton d’API.
- Statut : activez ou désactivez le jeton d’API.
- Cliquez sur Créer un jeton. La fenêtre contextuelle Jeton d’API de rapports s’ouvrira alors.
- Cliquez sur le jeton d’API de rapports pour le copier. Assurez-vous de copier votre jeton d’API à un endroit auquel vous pourrez accéder facilement. Une fois cette fenêtre fermée, vous ne pourrez plus accéder à nouveau à ce jeton.
- Cliquez sur OK.
Une fois le jeton copié, vous pouvez l’utiliser pour extraire des données de la console KSAT afin de générer des rapports.
Gérer les jetons d’API de rapports
Une fois que vous avez créé un jeton d’API de rapports, vous pouvez gérer ce jeton depuis le sous-onglet API de rapports. Ce sous-onglet est accessible depuis la section Intégrations du compte de la page Paramètres du compte.
Pour en savoir plus sur les options disponibles dans ce sous-onglet, consultez la section ci-dessous :
- Clé : cette colonne affiche un identifiant unique utilisé pour authentifier une demande d’API associée à votre console KSAT.
- Nom : cette colonne affiche le nom personnalisé que vous avez attribué à votre jeton d’API lors de sa création.
- Généré par : cette colonne affiche l’adresse e-mail associée à l’utilisateur qui a généré le jeton d’API.
- Généré le : cette colonne affiche la date à laquelle le jeton d’API a été généré.
- Statut : cette colonne affiche le statut du jeton d’API (Activé ou Désactivé).
-
Actions : cliquez sur la flèche du menu déroulant située dans la colonne la plus à droite pour consulter les actions disponibles pour un jeton d’API de rapports. Parmi les actions proposées :
- Modifier : cliquez sur Modifier pour ouvrir la page Modifier le jeton d’API de rapports, qui ressemble beaucoup à la page Créer un jeton d’API de rapports. Modifiez les options selon vos besoins, puis cliquez sur Mettre à jour le jeton pour enregistrer vos modifications.
- Supprimer : cliquez sur Supprimer pour supprimer définitivement un jeton d’API de rapports.