Télécharger au format PDF
Concept : API Peakon
Utilisez l’API Peakon pour extraire les données d’engagement de Peakon. Authentification avec un jeton d’accès, puis adressez des demandes GET aux points de terminaison pour accéder aux scores d’engagement et aux indicateurs clés.
Authentification
Une fois qu’une application personnalisée est créée, un jeton d’accès généré vous est présenté. Ce jeton est un secret et unique à votre application. Effectuez une demande POST à l’aide du point de terminaison/v1/auth/application pour échanger votre jeton d’accès contre un jeton d’autorisation.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
Le corps de la réponse d’une demande d’authentification réussie contiendra un jeton d’autorisation JWT qui sera utilisé dans toutes les demandes API ultérieures. Notez que même si une application peut avoir plusieurs jetons d’autorisation, les limites de taux sont appliquées par application.
Après l’authentification avec un jeton d’accès pour obtenir une JWT, vous pouvez l’utiliser pour envoyer des demandes GET aux points de terminaison afin d’accéder aux scores d’engagement et à d’autres indicateurs clés. Visite Étapes : créer des applications personnalisées avec l’API REST pour plus d’informations sur la façon de la définir.
Filtrage
En plus des routages contextuels, un filtrage supplémentaire est pris en charge pour de nombreux routages grâce au paramètre d’interrogation pour filtre. Si une route prend en charge le filtrage, elle sera répertoriée comme paramètre d’interrogation dans la spécification de routage ci-dessous. Les filtres sont organisés en fonction de leur modèle logique. Pour filtrer en fonction du pilote de question, vous devez préfixer le filtre par
question
. Exemple :GET /v1/engagement/drivers?filter[question.driver]=autonomy
Plusieurs opérateurs sont pris en charge pour les champs de correspondance. Exemple : pour obtenir les scores uniquement pour les déplacements autonomes et les récompenses, vous pouvez fournir le filtre suivant :
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Pour obtenir la liste des opérateurs de filtrage pris en charge, consultez la page Référence : valeurs de filtrage de l’API Peakon.
Format JSON
Tous les objets sont rendus à l’aide de l’API JSON, une méthode de modélisation d’un graphique d’objets à l’aide de JSON.
Routage
Certaines demandes peuvent être limitées à un segment arbitraire de la société. Vous souhaiterez peut-être analyser les données sur l’engagement de tous les subordonnés directs d’un gestionnaire donné ou de l’eNPS d’un service donné.
Exemple : l’identifiant de segment pour le service des ventes est 149. L’aperçu des engagements pour ce service peut être obtenu à l’aide de la demande suivante :
GET v1/engagement/context/149/overview
Pour obtenir l’identifiant du segment, utilisez le sélecteur de contexte pour modifier le contexte de la société au segment lui-même. Le sélecteur de contexte se trouve dans le coin supérieur gauche de la page. Recherchez le nom du segment et sélectionnez-le pour y accéder. L'identifiant du segment s'affiche dans l'adresse URL après
segment/
paramètre. Pour en savoir plus sur le sélecteur de contexte, consultez la page Concept : contextes du tableau de bord.Limitation de taux
Peakon est un service multi locataire. Des limites de taux sont en place pour empêcher les clients individuels de consommer un montant démesuré de ressources. Chaque application enregistrée est par défaut soumise aux limites de taux suivantes :
- Jusqu’à 5 000 demandes par heure.
- Jusqu’à 12 minutes de temps de traitement par tranche de 5 minutes d’horloge de pointage.
Si votre application dépasse l’une ou l’autre des limites, l’API renverra un
429 Too Many Requests
réponse. Les limites de taux par défaut sont périodiquement révisées et mises à jour.