Comment activer l'API ?
Veuillez suivre les étapes suivantes pour activer et configurer l’intégration API de Key Predict, afin de connecter votre outil et automatiser le déclenchement des évaluations et la récupération des résultats.
⚠️ Important : seuls les administrateurs de compte disposent des droits nécessaires pour configurer la page Intégration.
1. Activer l’accès à l’API
Pour utiliser l’API, l’option Webservice doit être activée sur votre compte.
Vous pouvez en faire la demande depuis : Gestion du compte > Contrats > Options > “Demander l’activation”
👉 Vous pouvez également contacter votre chargé de compte ou le support Key Predict afin d'activer l'option. L’option Webservice est une fonctionnalité payante.
Une fois l’option disponible sur votre compte, vous pouvez l’activer depuis Gestion du compte > Intégration. Dans la liste des intégrations disponibles, sélectionnez Key Predict, puis cliquez sur Activer.
2. Définir vos identifiants d’intégration
Lors de la configuration, vous devez renseigner :
- Login API
- Mot de passe API (12 caractères minimum recommandés)
👉 Ces identifiants servent à sécuriser les échanges entre Key Predict et votre outil et authentifier les appels et notifications. Ils peuvent être définis librement ou fournis par votre outil.
3. Configurer les URLs de notification
Vous pouvez renseigner (champs optionnels) :
- URL Webservice - Passation débutée : URL du webhook utilisée pour envoyer une notification lorsqu’un candidat démarre une évaluation (voir section 10 de l’API – Notification on assessment started).
- URL Webservice - Passation terminée : URL du webhook utilisée pour envoyer une notification lorsqu’un candidat termine une évaluation (voir section 9 de l’API – Notification on assessment completed).
- Expiration du token : lorsque cette option est activée, le token d’authentification expire après 3 jours, afin de renforcer la sécurité.
Ces URLs correspondent aux endpoints de votre outil qui recevront automatiquement les notifications d’événements.
Elles doivent être :
- fournies par votre équipe technique ou votre outil
- capables de recevoir des requêtes HTTP (webhooks)
Si vous ne disposez pas de ces URLs, contactez votre équipe technique ou votre prestataire.
🔒Note sur l'expiration du token
Il s'agit d'une option de sécurité avancée – Si l’expiration est activée :
- le token devient temporaire
- il doit être renouvelé automatiquement par votre système
Cette option est recommandée uniquement si vous disposez des ressources techniques pour gérer le renouvellement automatique du token.
4. Fonctionnement général
Une fois l’intégration configurée :
- Votre outil peut déclencher des évaluations
- Key Predict gère l’envoi et le suivi des tests
-
Deux modes de fonctionnement sont possibles :
- avec notifications (recommandé) : votre outil est automatiquement informé des événements (démarrage, fin)
- sans notifications : votre outil peut interroger l’API pour récupérer les informations
- Les résultats peuvent être récupérés et exploités dans votre environnement
Plus d'infos sur notre documentation technique basée sur le protocole REST (Representational State Transfer).
5. Cas d’usage
Notre API permet d’intégrer les évaluations Key Predict dans un ATS, un SIRH ou toute autre application métier. Voici les scénarios d’intégration les plus fréquents.
Cas d’usage 1 : Créer un candidat depuis votre ATS
Ce scénario permet de synchroniser automatiquement un candidat créé dans votre ATS vers Key Predict.
Comment ça fonctionne :
- Lorsqu’un candidat est créé dans votre ATS, appelez la méthode create/candidate.
- Transmettez les informations du candidat (nom, prénom, email, langue, etc.).
- Key Predict crée automatiquement le participant et retourne son identifiant unique.
- Conservez cet identifiant dans votre ATS afin de l’utiliser pour les opérations suivantes.
Endpoints concernés :
- create/candidate
- update/candidate
Exemple d’utilisation :
Lorsqu’un recruteur crée un candidat dans son ATS, celui-ci est automatiquement créé dans Key Predict sans intervention manuelle.
Cas d’usage 2 : Inviter un candidat à passer une évaluation
Ce scénario permet d’envoyer une ou plusieurs évaluations directement depuis votre ATS.
Comment ça fonctionne :
- Récupérez la liste des évaluations disponibles sur votre compte.
- Sélectionnez le ou les questionnaires à envoyer.
- Appelez la méthode candidate/invite.
- Key Predict envoie automatiquement l’invitation au candidat.
- Le candidat reçoit un email lui permettant d’accéder à ses évaluations.
Endpoints concernés :
- assessment/list
- candidate/invite
Exemple d’utilisation :
Le recruteur clique sur « Inviter à passer une évaluation » depuis la fiche candidat de son ATS et sélectionne le questionnaire Profil Pro 2 dans une liste déroulante. L’invitation est immédiatement envoyée au candidat sans quitter son outil.
Cas d’usage 3 : Permettre au candidat de démarrer son évaluation depuis votre plateforme
Ce scénario permet au candidat d'accéder à son évaluation directement depuis votre ATS ou votre portail candidat.
Comment ça fonctionne :
- Le candidat a reçu une invitation à passer une évaluation.
- Votre application récupère l’URL sécurisée de passation générée par Key Predict.
- Depuis votre portail candidat ou votre ATS, l’utilisateur clique sur « Commencer l’évaluation ».
- Votre système redirige automatiquement le candidat vers la plateforme d’évaluation Key Predict.
- Une fois l’évaluation terminée, Key Predict peut notifier votre application grâce à l’URL « Assessment Completed ».
Endpoints concernés :
- URL de passation retournée lors de l’invitation
- Notification Assessment Completed
Exemple d’utilisation :
Depuis l’espace candidat de votre ATS, un bouton « Commencer l’évaluation» permet au candidat d’accéder directement à son questionnaire sans devoir rechercher l’email d’invitation.
Cas d’usage 4 : Récupérer les résultats et afficher les rapports dans votre plateforme
Ce scénario permet de consulter les résultats d’évaluation directement depuis votre ATS ou votre SIRH.
Comment ça fonctionne :
- Le candidat termine son évaluation.
- Key Predict envoie une notification vers votre URL « Assessment Completed ».
- Votre système récupère automatiquement les résultats disponibles.
- Les rapports PDF ou HTML peuvent être téléchargés ou affichés directement dans votre plateforme.
- Les recruteurs ou managers consultent les résultats sans avoir besoin de se connecter à Key Predict.
Endpoints concernés :
- assessment/completed
- assessment/result
Exemple d’utilisation :
Lorsqu’un candidat termine son Profil Pro 2, le recruteur voit automatiquement apparaître un bouton « Voir le rapport » dans sa fiche candidat et peut consulter les résultats directement depuis son ATS.
Cas d’usage 5 : Comparer les candidats grâce aux scores d’adéquation
Ce scénario permet d’automatiser le calcul des scores d’adéquation des candidats par rapport à un poste ou à un projet.
Comment ça fonctionne :
-
Créez une campagne d’évaluation via l’API en définissant :
- les évaluations à utiliser,
- le modèle prédictif associé au poste ou au projet,
- Associez la campagne à une étape de votre offre d’emploi ou de votre projet dans votre ATS.
- Lorsqu’un candidat atteint cette étape, votre ATS déclenche automatiquement son inscription à la campagne et l’envoi des évaluations.
- Une fois les évaluations complétées, Key Predict calcule automatiquement les scores d’adéquation à partir du modèle prédictif associé à la campagne.
- Votre ATS récupère les scores via l’API et peut les afficher dans la fiche candidat ou dans la liste des candidatures.
Endpoints concernés :
Exemple d’utilisation :
Vous créez une campagne « Commercial Senior » associée à un modèle prédictif. Lorsqu’un candidat atteint l’étape « Évaluation » dans votre ATS, les tests sont envoyés automatiquement. Une fois les résultats disponibles, le score d’adéquation est calculé et affiché directement dans votre pipeline de recrutement afin de faciliter la comparaison des candidats.
Cas d’usage 6 : Récupérer la fiche Insight et Talent Map
Ce scénario permet d’afficher dans votre ATS ou votre SIRH un lien sécurisé vers la fiche participant Key Predict. Depuis cette fiche, les recruteurs ou équipes RH peuvent consulter l’Insight du participant ainsi que sa Talent Map, selon les fonctionnalités activées sur le compte.
Comment ça fonctionne :
- Le candidat ou collaborateur réalise les évaluations requises.
- Une fois les résultats disponibles, votre système récupère le lien sécurisé vers la fiche participant.
- Ce lien est affiché dans votre ATS ou votre SIRH, par exemple depuis la fiche candidat ou collaborateur.
- En cliquant sur ce lien, l’utilisateur accède à la fiche participant Key Predict, qui centralise les résultats disponibles : Insight, rapports détaillés, Talent Map.
- Les recruteurs, managers ou équipes RH peuvent consulter ces informations sans devoir rechercher le participant manuellement dans Key Predict.
Endpoints concernés :
Exemple d’utilisation :
Le recruteur consulte le rapport BF5 ou Profil Pro directement depuis son ATS sans avoir besoin d’ouvrir une autre application.