L’API de flux personnalisé vous permet de filtrer les flux de reconnaissance des employés par métadonnées, d’ajouter des étiquettes pour les destinataires et de personnaliser l’affichage des reconnaissances. Elle est souvent utilisée avec ScreenCloud, mais peut être configurée indépendamment. Pour l’intégration avec ScreenCloud, voir cet article.
Pour les clients qui configurent directement l’API de flux personnalisé, voici un guide étape par étape pour vous aider à la configurer.
- Accéder aux paramètres de l’API
- Configurer le champ de filtrage (dans la plateforme)
- Sélectionner les étiquettes de métadonnées (optionnel)
- Activer les notifications d’erreur
- Configurer l’API (filtre de métadonnées)
- Tester et dépanner
- Ressources utiles
Accéder aux paramètres de l’API
Pour commencer avec l’API de flux personnalisé, connectez-vous à votre portail d’administration Awardco et accédez aux paramètres de configuration nécessaires.
- Connectez-vous à votre compte Awardco.
- Sélectionnez le bouton « Admin » en bas du menu de navigation à gauche.
- Sélectionnez « Plateforme », puis « Intégrations », puis « Paramètres de l’API » dans le menu de navigation à gauche.
- Cliquez sur l’onglet « Configuration de l’API ».
Cela ouvrira la page où vous pouvez configurer à la fois les paramètres dans la plateforme et la configuration de l’API nécessaires pour votre flux personnalisé.
Configurer le champ de filtrage (dans la plateforme)
Le champ de filtrage vous permet de contrôler comment les reconnaissances sont filtrées selon les champs de métadonnées, tels que l’emplacement, le département ou toute autre catégorie pertinente pour votre organisation. Ce filtre garantit que seules les reconnaissances correspondant à certains critères sont affichées. Pour configurer le champ de filtrage :
- Choisissez un champ de métadonnées qui servira de filtre. Par exemple, si votre entreprise a plusieurs emplacements de bureau, vous pouvez utiliser le champ de métadonnées Emplacement.
- Cliquez sur « Enregistrer les modifications ».
Exemple :
Pour une entreprise avec des bureaux dans différentes villes, sélectionner Emplacement comme filtre vous permet d’afficher les reconnaissances basées sur des emplacements spécifiques, comme « Londres » ou « New York ».
Note : Le champ de filtrage spécifie le champ de métadonnées (par exemple, « Emplacement »), et vous définirez plus tard les valeurs à filtrer dans l’API elle-même.
Sélectionner les étiquettes de métadonnées (optionnel)
Vous pouvez améliorer le flux de reconnaissance en affichant des métadonnées supplémentaires, telles que le département ou le titre de poste pour chaque employé recevant une reconnaissance. Pour configurer les étiquettes de métadonnées :
- Sous Sous-étiquette 1 et Sous-étiquette 2, sélectionnez les champs de métadonnées que vous souhaitez afficher. Des exemples courants incluent Département et Titre de poste.
- Par exemple, sélectionner Département et Titre de poste pourrait afficher des détails comme « Ventes » et « Représentant commercial ».
Cette étape est optionnelle, mais elle peut fournir un contexte supplémentaire pour votre flux de reconnaissance.
Activer les notifications d’erreur
Pour assurer le bon fonctionnement de votre configuration, nous recommandons d’activer les courriels d’erreur. Cette fonctionnalité vous avertira s’il y a des problèmes avec le flux personnalisé, comme des configurations invalides ou des métadonnées manquantes.
- Trouvez l’option Envoyer des courriels d’erreur dans les paramètres.
- Activez cette fonctionnalité pour recevoir les notifications d’erreur.
Vous pouvez temporairement désactiver les courriels d’erreur si vous êtes au courant de problèmes connus qui sont en cours de résolution.
Configurer l’API (filtre de métadonnées)
Une fois les paramètres dans la plateforme configurés, vous devrez définir les valeurs spécifiques pour le filtrage en utilisant le paramètre de requête metadataFilter dans les appels API.
- Le paramètre de filtre de métadonnées dans la plateforme détermine quel champ est utilisé pour le filtrage (par exemple, Emplacement).
- Le paramètre API metadataFilter spécifie quelle valeur dans ce champ doit être utilisée comme critère de filtrage (par exemple, afficher uniquement les reconnaissances où « Emplacement » = « Las Vegas » sur cet écran).
Pour configurer l’API :
- Dans la configuration de l’API, utilisez le paramètre de requête metadataFilter pour spécifier les valeurs de filtrage.
- Assurez-vous que la valeur correspond aux valeurs de métadonnées stockées dans vos données utilisateur.
Exemple d’appel API :
https://api.awardco.com/api/feed?metadataFilter=Location:London
Cela garantit que seules les reconnaissances étiquetées avec la métadonnée d’emplacement Londres sont affichées. Si des champs de métadonnées sont modifiés ou supprimés, vous devez mettre à jour la configuration du filtre en conséquence.
Tester et dépanner
Une fois la configuration terminée, il est important de tester le flux pour s’assurer que tout s’affiche correctement.
- Vérifiez que le filtre est correctement appliqué et que les bonnes reconnaissances sont affichées selon vos paramètres configurés.
- Si vous rencontrez des problèmes, consultez vos notifications de courriels d’erreur pour plus de détails.
Ressources utiles
Pour vous aider dans la configuration et fournir des conseils plus détaillés, voici quelques ressources utiles :
- Documentation de l’API : Guide complet sur l’utilisation de l’API de flux personnalisé, avec paramètres et exemples.
- Ressources API Awardco : Documentation et support API.
If you have any questions, please contact Awardco Admin Support.