Ghid de integrare
Evenimente și Webhook
Validați intrarea la examen
Puteți valida un respondent care urmează să susțină un examen și să adăugați, de asemenea, metadate despre acest utilizator.
Atunci când o solicitare a unui respondent să înceapă un examen, serverul nostru va face o solicitare Webhook către URL -ul serverului dvs. pentru a valida dacă acreditarea respondentului (de exemplu, e -mail, parolă sau matricea) sunt valabile.
Serverul dvs. poate răspunde opțional cu unele metadate despre acest respondent, cum ar fi name, email, photo, about and data.
Mai jos exemplu imită cererea făcută către serverul dvs. și răspunsul așteptat dacă verificarea a avut succes
Atunci când o solicitare a unui respondent să înceapă un examen, serverul nostru va face o solicitare Webhook către URL -ul serverului dvs. pentru a valida dacă acreditarea respondentului (de exemplu, e -mail, parolă sau matricea) sunt valabile.
Serverul dvs. poate răspunde opțional cu unele metadate despre acest respondent, cum ar fi name, email, photo, about and data.
Mai jos exemplu imită cererea făcută către serverul dvs. și răspunsul așteptat dacă verificarea a avut succes
Vă rugăm să rețineți că sunteți de așteptat să răspundeți în 60 de secunde sau cererea va fi încetată de serverul nostru.
Dacă respondentul nu ar putea fi validat de serverul dvs., sunteți de așteptat să furnizați errorMessage Cu motivul, altfel trebuie să o omiteți.Opțional puteți furniza metadata Dacă validarea a avut succes.
De asemenea, dacă intenționați să efectuați detectarea feței pe respondent, sunteți de așteptat să furnizați metadata.photo cu legătura cu o imagine ascuțită a respondentului. Rezoluția de imagine recomandată este o imagine mai mare de 1500x1500 pixeli.
Dacă respondentul nu ar putea fi validat de serverul dvs., sunteți de așteptat să furnizați errorMessage Cu motivul, altfel trebuie să o omiteți.Opțional puteți furniza metadata Dacă validarea a avut succes.
De asemenea, dacă intenționați să efectuați detectarea feței pe respondent, sunteți de așteptat să furnizați metadata.photo cu legătura cu o imagine ascuțită a respondentului. Rezoluția de imagine recomandată este o imagine mai mare de 1500x1500 pixeli.
Asigurați -vă că verificați toate cererile primite către serverul dvs. prin verificare împotriva x-client-id and x-client-secret pe antetul cererii
{
"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"
}Mai jos exemplu imită cererea făcută către serverul dvs. și răspunsul așteptat dacă verificarea a eșuat
{
"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"
}Asigurați -vă că v -ați activat validate fields via webhook În pagina de creare a examenelor
Sau dacă utilizați API -ul pentru dezvoltatori, asigurați -vă welcomePage.validate este adevărat
Sau dacă utilizați API -ul pentru dezvoltatori, asigurați -vă welcomePage.validate este adevărat
Setarea adresei URL WebHook
Puteți seta și schimba adresa URL a serverului dvs., iată cum
Navigați la setări.
Accesați secțiunea pentru dezvoltatori.
Edit and copy your webhook url
Admiteți evenimentul respondent
Serverul nostru va anunța serverul dvs. atunci când un respondent a fost admis să susțină un examen. Mai jos, exemplu demonstrează acest scenariu
respondent_id Pentru a căuta informații suplimentare despre acest respondent
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Eveniment gata de rezultat
Serverul nostru va anunța serverul dvs. atunci când un rezultat al respondentului pentru un examen este gata. Mai jos, exemplu demonstrează acest scenariu
respondent_id Pentru a căuta datele de rezultat pentru acest respondent
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Eveniment complet de investigare
Serverul nostru va anunța serverul dvs. atunci când investigația pe un respondent este finalizată. Mai jos, exemplu demonstrează acest scenariu
respondent_id Pentru a căuta informații suplimentare despre acest respondent
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Comentarii de feedback (0)
