Guide d'intégration
Événements et webhook
Valider l'entrée de l'examen
Vous pouvez valider un répondant qui est sur le point de passer un examen et également d'ajouter des métadonnées à propos de cet utilisateur.
Lorsqu'une demande de répondant pour démarrer un examen, notre serveur fera une demande WebHook à l'URL de votre serveur pour valider si les informations d'identification des répondants (par exemple, le mot de passe ou le non matrique) sont valides.
Votre serveur peut répondre facultatif avec certaines métadonnées à propos de ce répondant, comme name, email, photo, about and data.
L'exemple ci-dessous imite la demande faite à votre serveur et la réponse attendue si la vérification a réussi
Lorsqu'une demande de répondant pour démarrer un examen, notre serveur fera une demande WebHook à l'URL de votre serveur pour valider si les informations d'identification des répondants (par exemple, le mot de passe ou le non matrique) sont valides.
Votre serveur peut répondre facultatif avec certaines métadonnées à propos de ce répondant, comme name, email, photo, about and data.
L'exemple ci-dessous imite la demande faite à votre serveur et la réponse attendue si la vérification a réussi
Veuillez noter que vous devez répondre dans les 60 secondes ou que la demande sera terminée par notre serveur.
Si le répondant ne pouvait pas être validé par votre serveur, vous êtes censé fournir errorMessage avec la raison, sinon vous devez l'omettre.Vous pouvez éventuellement fournir le metadata Si la validation a réussi.
De plus, si vous avez l'intention d'effectuer une détection de visage sur le répondant, vous vous attendez à fournir metadata.photo avec un lien vers une image nette du répondant. La résolution d'image recommandée est une image supérieure à 1500x1500 pixels.
Si le répondant ne pouvait pas être validé par votre serveur, vous êtes censé fournir errorMessage avec la raison, sinon vous devez l'omettre.Vous pouvez éventuellement fournir le metadata Si la validation a réussi.
De plus, si vous avez l'intention d'effectuer une détection de visage sur le répondant, vous vous attendez à fournir metadata.photo avec un lien vers une image nette du répondant. La résolution d'image recommandée est une image supérieure à 1500x1500 pixels.
Assurez-vous de vérifier toute la demande entrante à votre serveur en vérifiant contre x-client-id and x-client-secret Sur l'en-tête de demande
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some valid student id"
},
{
"position": 1,
"value": "Some valid student password"
}
],
"exam_id": "some unique exam_id",
"choosenLang": "ru"
}L'exemple ci-dessous imite la demande faite à votre serveur et la réponse attendue si la vérification a échoué
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some invalid student id"
},
{
"position": 1,
"value": "Some invalid student password"
}
],
"exam_id": "some unique exam_id..",
"choosenLang": "ru"
}Assurez-vous que vous avez activé validate fields via webhook Dans la page de création d'examen
Ou si vous utilisez l'API du développeur, assurez-vous welcomePage.validate est vrai
Ou si vous utilisez l'API du développeur, assurez-vous welcomePage.validate est vrai
Définition de votre URL Webhook
Vous pouvez définir et modifier l'URL de votre serveur Web, voici comment
Accédez aux paramètres.
Accédez à la section des développeurs.
Edit and copy your webhook url
Admettre l'événement intimé
Notre serveur informera votre serveur lorsqu'un répondant a été admis à un examen. Ci-dessous exemple démontre ce scénario
respondent_id Pour rechercher des informations supplémentaires sur ce répondant
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Événement prêt à l'emploi
Notre serveur informera votre serveur lorsqu'un résultat du répondant pour un examen est prêt. Ci-dessous exemple démontre ce scénario
respondent_id Pour rechercher les données des résultats pour ce répondant
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Événement complet de l'enquête
Notre serveur informera votre serveur lorsque l'enquête sur un répondant sera terminée. Exemple ci-dessous démontre ce scénario
respondent_id Pour rechercher des informations supplémentaires sur ce répondant
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Commentaires de commentaires (0)
