Les tâches manuelles sur la plateforme Awardco, telles que le téléchargement de fichiers utilisateurs ou la génération de rapports, peuvent être fastidieuses et prendre beaucoup de temps. En utilisant des clés API, vous pouvez automatiser ces processus, ce qui vous fait gagner du temps et des efforts. Cet article explique ce que sont les clés API, leurs capacités, et comment vous pouvez les utiliser au sein de votre organisation via l’outil de gestion des clés API.
Remarque : Les autorisations que vous sélectionnez pour votre clé API dépendront des produits Awardco que vous utilisez :
- Awardco Recognition : Vous pouvez avoir besoin d’un large éventail d’autorisations, incluant les flux sociaux, la publication de reconnaissances et les rapports.
- Awardco Engage : Puisqu’Engage se concentre sur les sondages auprès des employés, vos besoins en API sont probablement limités strictement à la gestion des utilisateurs pour maintenir vos audiences de sondage à jour.
- Qu’est-ce qu’une API ?
- Activation de l’autorisation de clé API
- Accéder à l’outil de gestion des clés API
- Créer une nouvelle clé API
- Gestion des clés API
- Transition depuis les clés API classiques
- Autorisations requises pour les intégrations
Qu’est-ce qu’une API ?
Une API (Interface de Programmation Applicative) est un moyen pour deux programmes de communiquer. Elle fournit un ensemble de commandes et de requêtes qu’un programme (comme Awardco) peut accepter de sources externes. La plupart des applications mobiles utilisent des API pour communiquer avec leurs systèmes principaux.
L’API d’Awardco utilise HTTP, le même protocole utilisé par les sites web, ce qui simplifie la communication et permet d’effectuer des appels API directement depuis un navigateur.
L’API d’Awardco prend en charge deux principaux types de requêtes :
- GET : Demande d’informations à la base de données, comme la récupération de rapports au format .csv ou .json.
- POST : Mise à jour des informations dans la base de données. Par exemple, elle permet de mettre à jour les utilisateurs, de publier des reconnaissances ou de gérer les récompenses.
Que peut-on faire avec une API ?
Les cas d’utilisation courants comprennent :
- Gestion des utilisateurs : Synchronisation des données des employés (essentiel pour Engage et Recognition).
- Automatisation : Automatisation des prix et reconnaissances (uniquement Recognition).
- Flux sociaux : Récupération des informations de flux pour affichages externes (uniquement Recognition).
Pour envoyer un fichier via une API, le fichier doit être accessible et correctement encodé. Il existe trois méthodes principales pour gérer cela :
- Stocker le fichier sur un serveur FTP ou un serveur accessible publiquement.
- Utiliser un service API (par exemple, Postman) pour construire la requête.
- Utiliser des langages de programmation comme C#, cURL ou JavaScript pour envoyer la requête.
Bien que l’API offre un accès puissant à la plateforme Awardco, les clients sont entièrement responsables de son utilisation.
Pour en savoir plus, consultez notre Documentation publique de l’API.
Activation de l’autorisation de clé API
Par défaut, seuls les utilisateurs Super Admin peuvent gérer les clés API. Pour permettre à d’autres rôles de gérer et créer des clés API :
- Sur la page d’accueil, sélectionnez le bouton Admin en bas du menu de navigation à gauche.
- Sélectionnez « Utilisateurs », puis « Autorisations » dans le menu de navigation à gauche.
- Cliquez sur l’icône à trois points à côté du rôle que vous souhaitez modifier et choisissez Modifier.
- Accédez aux paramètres d’autorisations et cochez la case à côté de « Clés API ».
- Cliquez sur Enregistrer & Appliquer.
Accéder à l’outil de gestion des clés API
Awardco fournit un outil dédié de gestion des clés API qui vous permet de gérer des clés API spécifiques pour diverses actions, telles que l’envoi de reconnaissances, la récupération de flux ou la création d’utilisateurs. Plutôt que d’utiliser une clé API unique et puissante, Awardco divise les clés en actions distinctes selon vos besoins.
Pour accéder à l’outil de gestion des clés API :
- Sur la page d’accueil, sélectionnez le bouton Admin en bas du menu de navigation à gauche.
- Sélectionnez « Plateforme », puis « Intégrations », puis « Paramètres API » dans le menu de navigation à gauche.
Dans l’outil de gestion des clés API, vous pouvez :
- Voir et gérer des clés API spécifiques pour différentes tâches (par exemple, envoyer des reconnaissances, extraire des rapports).
- Attribuer des rôles et des autorisations pour déterminer qui peut gérer les clés API au sein de votre organisation.
- Suivre qui a créé chaque clé API et quand elle a été créée.
- S’assurer que les clés API sont hachées et salées pour la sécurité (elles ne sont pas stockées en texte clair).
- Supprimer des clés API selon les besoins.
- Noter que les utilisateurs en mode usurpation d’identité ne peuvent pas générer de clés API.
- Envoyer les clés API en toute sécurité aux personnes de confiance.
Créer une nouvelle clé API
Pour créer une nouvelle clé API :
- Cliquez sur le bouton « + Nouvelle clé API » sur la page des clés API.
- Saisissez un nom pour la clé.
- Sélectionnez les autorisations que la clé doit posséder.
- Pour les clients Recognition : Sélectionnez les autorisations pertinentes pour votre intégration (par exemple, Flux personnalisé pour ScreenCloud).
- Pour les clients Engage uniquement : Vous avez généralement seulement besoin des autorisations liées aux transferts de données utilisateur pour maintenir vos audiences de sondage à jour. Nous recommandons de ne sélectionner que :
- activer utilisateur, archiver utilisateur, créer utilisateur, importer utilisateurs, photo de profil, réinitialiser mot de passe, utilisateur existe, et utilisateurs.
- Si vous configurez une clé API pour une intégration Awardco, consultez la section Autorisations requises pour les intégrations ci-dessous.
- Définissez la période ou la date d’expiration de la clé.
- La date d’expiration maximale est de trois ans à partir d’aujourd’hui. Il est recommandé de remplacer régulièrement les clés API.
- Cliquez sur Suivant.
- Choisissez de générer la clé immédiatement ou de l’envoyer en toute sécurité à une autre personne.
- Vérifiez les détails et complétez le processus en cliquant sur Générer la clé API ou en l’envoyant en toute sécurité.
Important : Copiez et stockez la clé API en toute sécurité immédiatement après sa génération. Pour des raisons de sécurité, elle ne sera plus affichée. Pour plus d’informations sur les bonnes pratiques et conseils concernant les clés API, consultez cet article d’assistance.
Gestion des clés API
Afficher et modifier les détails d’une clé API
Pour voir les détails d’une clé API, cliquez sur le nom de la clé pour ouvrir une fenêtre de détails affichant :
- Nom de la clé.
- Les six premiers chiffres de la clé.
- Nom du créateur.
- Statut.
- Autorisations.
- Date de création.
- Date d’expiration.
- Date de dernière utilisation.
Pour modifier le nom ou la date d’expiration d’une clé API, cliquez sur Modifier et effectuez les changements. Enregistrez vos modifications une fois terminé.
Révoquer une clé API
Révoquer une clé API la désactive définitivement, rendant toutes les intégrations associées non fonctionnelles. Cette action est irréversible.
Pour révoquer une clé API :
- Cliquez sur l’icône à trois points à côté de la clé.
- Sélectionnez « Révoquer ».
- Confirmez en cliquant sur « Révoquer la clé API ».
Les clés révoquées seront déplacées vers l’onglet Archivées.
Renvoyer une clé API
Si une clé API affiche un statut « Non acceptée » ou n’a pas été acceptée dans les 24 heures, vous pouvez la renvoyer.
- Cliquez sur l’icône à trois points à côté de la clé.
- Sélectionnez « Renvoyer ». La clé API sera renvoyée à l’adresse courriel spécifiée lors de la création de la clé.
Cloner une clé API
Pour cloner une clé API :
- Cliquez sur l’icône à trois points à côté de la clé et sélectionnez « Cloner ».
- Mettez à jour le nom, les autorisations ou la date d’expiration selon les besoins.
- Suivez le même processus pour générer ou envoyer la clé comme décrit dans « Créer une nouvelle clé API. »
Afficher les clés archivées
Pour voir les clés API révoquées ou archivées, accédez à l’onglet Archivées dans les paramètres des clés API. Les clés révoquées ne peuvent pas être restaurées, mais elles peuvent être clonées pour créer un duplicata.
Transition depuis les clés API classiques
Bien que les clés API classiques continueront de fonctionner pour l’instant, nous recommandons de migrer vers le nouveau système pour une sécurité renforcée et un meilleur contrôle de vos intégrations.
Trouver votre clé API classique
Votre clé API classique a été déplacée vers la nouvelle page de gestion des clés API. Vous pouvez maintenant la trouver en bas de la page des paramètres API.
Comment migrer depuis les clés API classiques
Pour effectuer une transition sécurisée depuis votre clé API classique :
- Créer de nouvelles clés avec autorisations : Générez des clés API distinctes pour chaque intégration en suivant les étapes de la section « Créer une nouvelle clé API » ci-dessus. Assurez-vous que chaque clé possède uniquement les autorisations spécifiques nécessaires à son intégration.
- Mettre à jour vos intégrations : Remplacez la clé API classique dans chaque intégration par la nouvelle clé avec autorisations appropriées.
- Supprimer votre clé API classique : Une fois que toutes les intégrations sont mises à jour, cliquez sur le bouton « Supprimer la clé API classique » en bas de la page des paramètres API.
Autorisations requises pour les intégrations
Voici une liste des intégrations utilisant des clés API et les autorisations requises pour chacune :
- ScreenCloud - Flux personnalisé
- Qualtrics - Reconnaissance externe
- Speakap - Flux social
- Sworkit - Récompense en masse
- Paycom - Importation d’utilisateurs
- Awardco Connect (pour tous les clients) - Un représentant Awardco vous guidera sur les autorisations spécifiques dont votre clé API a besoin. Dans la plupart des cas, seules quelques autorisations sont nécessaires.
If you have any questions, please contact Awardco Admin Support.