Guia d’integració
Esdeveniments i webhook
Validar l’entrada d’exàmens
Podeu validar un enquestat que està a punt de fer un examen i també afegir metadades sobre aquest usuari.
Quan un enquestat sol·liciti un examen, el nostre servidor farà una sol·licitud WebHook al vostre URL del servidor per validar si la credencial de l'enquestat (per exemple, correu electrònic, contrasenya o matrícula no) és vàlida.
El vostre servidor pot respondre opcional amb alguns metadades sobre aquest enquestat, com ara name, email, photo, about and data.
A continuació, l'exemple imita la sol·licitud feta al vostre servidor i la resposta esperada si la verificació ha tingut èxit
Quan un enquestat sol·liciti un examen, el nostre servidor farà una sol·licitud WebHook al vostre URL del servidor per validar si la credencial de l'enquestat (per exemple, correu electrònic, contrasenya o matrícula no) és vàlida.
El vostre servidor pot respondre opcional amb alguns metadades sobre aquest enquestat, com ara name, email, photo, about and data.
A continuació, l'exemple imita la sol·licitud feta al vostre servidor i la resposta esperada si la verificació ha tingut èxit
Tingueu en compte que espereu que respongueu en un termini de 60 segons o que la sol·licitud acabarà el nostre servidor.
Si el vostre servidor no ha pogut validar l’enquestat, s’espera que proporcioneu errorMessage Amb la raó, s’espera que ho ometi.Opcionalment, podeu proporcionar el metadata Si la validació va tenir èxit.
A més, si teniu la intenció de realitzar la detecció de la cara a l'enquestat, s'espera que proporcioneu el metadata.photo amb enllaç a una imatge nítida de l’enquestat. La resolució d'imatges recomanada és una imatge superior a 1500x1500 píxels.
Si el vostre servidor no ha pogut validar l’enquestat, s’espera que proporcioneu errorMessage Amb la raó, s’espera que ho ometi.Opcionalment, podeu proporcionar el metadata Si la validació va tenir èxit.
A més, si teniu la intenció de realitzar la detecció de la cara a l'enquestat, s'espera que proporcioneu el metadata.photo amb enllaç a una imatge nítida de l’enquestat. La resolució d'imatges recomanada és una imatge superior a 1500x1500 píxels.
Assegureu -vos de verificar tota la sol·licitud entrant al servidor x-client-id and x-client-secret A la capçalera de la sol·licitud
{
"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"
}A continuació, l'exemple imita la sol·licitud feta al vostre servidor i la resposta esperada si la verificació ha fallat
{
"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"
}Assegureu -vos que ha activat validate fields via webhook A la pàgina de creació d’exàmens
O si utilitzeu l'API de desenvolupador, assegureu -vos welcomePage.validate és cert
O si utilitzeu l'API de desenvolupador, assegureu -vos welcomePage.validate és cert
Configuració de l'URL de WebHook
Podeu configurar i canviar el vostre URL de WebHook del servidor, aquí teniu com
Desplaceu -vos a la configuració.
Aneu a la secció de desenvolupadors.
Edit and copy your webhook url
Admetre esdeveniment enquestat
El nostre servidor notificarà al vostre servidor quan s'hagi admès que un enquestat faci un examen. A continuació, es demostra aquest escenari
respondent_id Per cercar informació addicional sobre aquest enquestat
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Resultat Esdeveniment llest
El nostre servidor notificarà al vostre servidor quan un resultat enquestat per a un examen estigui a punt. A continuació, es demostra aquest escenari
respondent_id Per cercar les dades del resultat d’aquest enquestat
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Esdeveniment complet de la investigació
El nostre servidor notificarà al vostre servidor quan s’acabi la investigació sobre un enquestat. A continuació, es demostra aquest escenari
respondent_id Per cercar informació addicional sobre aquest enquestat
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Comentaris de comentaris (0)
