Concept : API Peakon
Utilisez l'API Peakon pour récupérer les données d'engagement de Peakon. S'authentifier avec un jeton d'accès, puis effectuer des demandes GET aux points de terminaison pour accéder aux scores d'engagement et aux indicateurs clés.
Authentification
Une fois une application personnalisée créée, un jeton d’accès vous est accordé. Ce jeton est un secret unique pour votre application. Effectuer une demande POST en utilisant le 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 à une demande d'authentification réussie contient un jeton d'autorisation JWT à utiliser dans toutes les demandes API suivantes. Notez que même si une application peut avoir plusieurs jetons d'autorisation, les limites de taux sont appliquées par application.
Après vous être authentifié avec un jeton d'accès pour obtenir un JWT, vous pouvez l'utiliser pour effectuer 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 configuration de ces éléments.
Filtre
En plus des routages contextuels, un filtrage supplémentaire est pris en charge pour de nombreux routages via le paramètre de requête de filtre. Si une route prend en charge le filtrage, elle sera répertoriée comme paramètre de requête dans la spécification de route ci-dessous. Les filtres sont organisés en fonction de leur modèle logique. Pour filtrer avec le pilote de question, vous devez préfixer le filtre avec
question
. Exemple :GET /v1/engagement/drivers?filter[question.driver]=autonomy
Un certain nombre d'opérateurs est pris en charge pour les champs de rapprochement. Exemple : pour obtenir des scores uniquement pour les facteurs d' apparaît et de rémunération globale, vous pouvez utiliser 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 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 utilisée pour modéliser un graphique d'objets à l'aide de JSON.
Routage
Certaines demandes peuvent être limitées à un segment arbitraire de l'unité légale. Vous pourriez être intéressé(e) par l'analyse des données d'engagement de tous les subordonnés directs d'un responsable donné ou de l'option eNEP d'un service donné.
Exemple : l'identifiant de segment du service commercial est 149. L'aperçu de l'engagement pour ce service peut être obtenu via la demande suivante :
GET v1/engagement/context/149/overview
Pour obtenir l'identifiant du segment, utilisez le changement de contexte afin de remplacer le contexte de l'Unité légale par le segment lui-même. Le changement de contexte est situé 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 apparaît dans l'URL après le
segment/
paramètre. Pour plus d'informations sur le changement de contexte, consultez Concept : contextes des tableaux de bord.Limite de taux
Peakon est un service multi-environnement client. Des limites de taux sont en place pour éviter que les clients ne consomment une quantité de ressources disproportionnée. Chaque candidature enregistrée est assujettie par défaut aux taux limites suivants :
- Jusqu'à 5 000 demandes par heure.
- Jusqu'à 12 minutes de traitement par 5 minutes d'heure de travail.
Si votre application dépasse l'une ou l'autre de ces limites, l'API renverra
429 Too Many Requests
Réponse. Les taux limites par défaut sont révisés et mis à jour régulièrement.