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.
Qu’est-ce qu’une API ?
API (Interface de programmation d’applications) 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 parent.
L’API d’Awardco utilise HTTP, le même protocole que 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, cela permet de mettre à jour les utilisateurs, de publier des reconnaissances ou de gérer des récompenses.
Que permet l’API ?
Les cas d’utilisation courants de l’API Awardco incluent :
- Le téléchargement de fichiers utilisateurs vers Awardco.
- La récupération de rapports au format .csv ou .json.
- L’automatisation des récompenses et reconnaissances.
- La récupération des informations du fil social pour affichage.
- L’interaction avec la plateforme pour créer des applications.
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, visitez notre Documentation publique de l’API.
Activation de la permission 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 :
- Cliquez sur le bouton Admin en haut à droite de la page d’accueil.
- Allez à l’onglet Paramètres.
- Sélectionnez Permissions dans le menu de 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 Permissions 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 :
- Sélectionnez le bouton « Admin » en haut à droite de la page d’accueil.
- Cliquez sur l’onglet « Paramètres ».
- Cliquez sur « Clés API » dans le menu de 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, récupérer des rapports).
- Assigner des rôles et permissions 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 les clés API selon les besoins.
- Noter que les utilisateurs en mode usurpation ne peuvent pas générer de clés API.
- Envoyer les clés API de manière sécurisée 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.
- Entrez un nom pour la clé.
- Sélectionnez les permissions que la clé doit avoir.
- Si vous configurez une clé API pour une intégration Awardco, consultez la section Permissions requises pour l’intégration 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 renouveler régulièrement les clés API.
- Cliquez sur Suivant.
- Choisissez de générer la clé immédiatement ou de l’envoyer de manière sécurisée à 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 de manière sécurisée.
Important : Copiez et conservez la clé API en lieu sûr 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 relatifs aux clés API, consultez cet article d’assistance.
Gestion des clés API
Afficher et modifier les détails d’une clé API
Pour afficher les détails d’une clé API :
- Cliquez sur le nom de la clé API pour ouvrir une fenêtre de détails affichant :
- Le nom de la clé.
- Les six premiers chiffres de la clé.
- Le nom du créateur.
- Le statut.
- Les permissions.
- La date de création.
- La date d’expiration.
- La dernière date d’utilisation.
Pour modifier le nom ou la date d’expiration d’une clé API, cliquez sur Modifier et apportez les changements. Enregistrez vos modifications une fois terminées.
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 permissions ou la date d’expiration si nécessaire.
- 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 continuent 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 de Admin > Paramètres > Paramètres avancés vers la nouvelle page de gestion des clés API. Vous pouvez maintenant la trouver en bas de la page des paramètres API (Admin > Paramètres > Clés 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 permissions : Générez des clés API distinctes pour chaque intégration en suivant les étapes dans « Créer une nouvelle clé API » ci-dessus. Assurez-vous que chaque clé possède uniquement les permissions 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 permissions appropriées.
- Supprimer votre clé API classique : Une fois toutes les intégrations mises à jour, cliquez sur le bouton « Supprimer la clé API classique » en bas de la page des paramètres API.
Permissions requises pour l’intégration
Liste des intégrations utilisant des clés API et les permissions requises pour chacune :
- ScreenCloud - Fil personnalisé
- Qualtrics - Reconnaissance externe
- Speakap - Fil social
- Sworkit - Récompense en masse
- Paycom - Importation d’utilisateurs
- Awardco Connect (pour tous les clients) - Un représentant Awardco vous guidera sur les permissions spécifiques requises pour votre clé API. Dans la plupart des cas, seules quelques permissions sont nécessaires.
If you have any questions, please contact Awardco Admin Support.