Guía de integración
Eventos y webhook
Validar la entrada del examen
Puede validar a un encuestado que está a punto de tomar un examen y también agregar metadatos sobre este usuario.
Cuando una solicitud de encuestado para iniciar un examen, nuestro servidor realizará una solicitud de webhook a la URL de su servidor para validar si la credencial de encuestado (por ejemplo, correo electrónico, contraseña o matricidad no) son válidas.
Su servidor puede responder opcional con algunos metadatos sobre este encuestado, como name, email, photo, about and data.
A continuación, el ejemplo imita la solicitud hecha a su servidor y la respuesta esperada si la verificación fue exitosa
Cuando una solicitud de encuestado para iniciar un examen, nuestro servidor realizará una solicitud de webhook a la URL de su servidor para validar si la credencial de encuestado (por ejemplo, correo electrónico, contraseña o matricidad no) son válidas.
Su servidor puede responder opcional con algunos metadatos sobre este encuestado, como name, email, photo, about and data.
A continuación, el ejemplo imita la solicitud hecha a su servidor y la respuesta esperada si la verificación fue exitosa
Tenga en cuenta que se espera que responda dentro de los 60 segundos o la solicitud finalizará nuestro servidor..
Si el encuestado no pudiera ser validado por su servidor, se espera que proporcione errorMessage con la razón, de lo contrario, se espera que lo omita.Opcionalmente puede proporcionar la metadata Si la validación fue exitosa.
Además, si tiene la intención de realizar la detección de la cara en el encuestado, se espera que proporcione el metadata.photo con enlace a una imagen nítida del encuestado. La resolución de imagen recomendada es una imagen superior a 1500x1500 píxeles.
Si el encuestado no pudiera ser validado por su servidor, se espera que proporcione errorMessage con la razón, de lo contrario, se espera que lo omita.Opcionalmente puede proporcionar la metadata Si la validación fue exitosa.
Además, si tiene la intención de realizar la detección de la cara en el encuestado, se espera que proporcione el metadata.photo con enlace a una imagen nítida del encuestado. La resolución de imagen recomendada es una imagen superior a 1500x1500 píxeles.
Asegúrese de verificar toda la solicitud entrante a su servidor al verificar contra x-client-id and x-client-secret En el encabezado de solicitud
{
"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"
}El ejemplo a continuación imita la solicitud hecha a su servidor y la respuesta esperada si la verificación falló
{
"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"
}Asegúrese de habilitar validate fields via webhook En la página de creación de exámenes
O si está utilizando la API de desarrollador, asegúrese de welcomePage.validate es cierto
O si está utilizando la API de desarrollador, asegúrese de welcomePage.validate es cierto
Configuración de su URL webhook
Puede configurar y cambiar la URL web de su servidor, así es como es cómo
Navegue a la configuración.
Vaya a la sección del desarrollador.
Edit and copy your webhook url
Admitir evento de encuestado
Nuestro servidor notificará a su servidor cuando un encuestado haya sido admitido para tomar un examen. A continuación, el ejemplo demuestra este escenario
respondent_id Para buscar información adicional sobre este encuestado
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Evento listo para el resultado
Nuestro servidor notificará a su servidor cuando un resultado de encuestado para un examen esté listo. A continuación, el ejemplo demuestra este escenario
respondent_id Para buscar los datos de los resultados para este encuestado
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Evento completo de investigación
Nuestro servidor notificará a su servidor cuando se complete la investigación sobre un encuestado. A continuación, el ejemplo demuestra este escenario
respondent_id Para buscar información adicional sobre este encuestado
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Comentarios de comentarios (0)
