Integrationsvejledning
Begivenheder og webhook
Valider eksamensindgangen
Du kan validere en respondent, der er ved at tage en eksamen og også tilføje metadata om denne bruger.
Når en respondentanmodning om at starte en eksamen, vil vores server fremsætte en webhook -anmodning til din server -URL om at validere, hvis respondentens legitimationsoplysning (f.eks. E -mail, adgangskode eller matric nr.).
Din server kan valgfri reagere med nogle metadata om denne respondent, såsom name, email, photo, about and data.
Nedenfor eksempel efterligner den anmodning, der blev fremsat til din server, og det forventede svar, hvis verifikationen var vellykket
Når en respondentanmodning om at starte en eksamen, vil vores server fremsætte en webhook -anmodning til din server -URL om at validere, hvis respondentens legitimationsoplysning (f.eks. E -mail, adgangskode eller matric nr.).
Din server kan valgfri reagere med nogle metadata om denne respondent, såsom name, email, photo, about and data.
Nedenfor eksempel efterligner den anmodning, der blev fremsat til din server, og det forventede svar, hvis verifikationen var vellykket
Bemærk, at du forventes at svare inden for 60 sekunder, eller at anmodningen afsluttes af vores server.
Hvis respondenten ikke kunne valideres af din server, forventes du at give errorMessage Med årsagen forventes det, at du udelader det.Du kan eventuelt give metadata Hvis valideringen var vellykket.
Også hvis du har til hensigt at udføre ansigtsdetektion på respondenten, forventes du at give metadata.photo med link til et skarpt billede af respondenten. Anbefalet billedopløsning er et billede, der er større end 1500x1500 pixels.
Hvis respondenten ikke kunne valideres af din server, forventes du at give errorMessage Med årsagen forventes det, at du udelader det.Du kan eventuelt give metadata Hvis valideringen var vellykket.
Også hvis du har til hensigt at udføre ansigtsdetektion på respondenten, forventes du at give metadata.photo med link til et skarpt billede af respondenten. Anbefalet billedopløsning er et billede, der er større end 1500x1500 pixels.
Sørg for, at du bekræfter al indgående anmodning til din server med check imod x-client-id and x-client-secret På anmodningshovedet
{
"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"
}Nedenfor eksempel efterligner den anmodning, der er fremsat til din server, og det forventede svar, hvis verifikationen mislykkedes
{
"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"
}Sørg for, at du er aktiveret validate fields via webhook På siden Oprettelse af eksamensoprettelse
Eller hvis du bruger udvikler API welcomePage.validate er sandt
Eller hvis du bruger udvikler API welcomePage.validate er sandt
Indstilling af din webhook -URL
Du kan indstille og ændre din server webhook -url, her er hvordan
Naviger til indstillinger.
Gå til udviklerafsnittet.
Edit and copy your webhook url
Indrøm respondentbegivenhed
Vores server vil underrette din server, når en respondent er blevet optaget til at tage en eksamen. Nedenfor eksempel demonstrerer dette scenarie
respondent_id at opslutte yderligere oplysninger om denne respondent
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Resultat klar begivenhed
Vores server vil underrette din server, når et respondentresultat for en eksamen er klar. Nedenfor eksempel demonstrerer dette scenarie
respondent_id at slå resultatdataene til denne respondent
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Undersøgelse Komplet begivenhed
Vores server vil underrette din server, når undersøgelsen af en respondent er afsluttet. Nedenfor eksempel demonstrerer dette scenarie
respondent_id at opslutte yderligere oplysninger om denne respondent
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Feedback Kommentarer (0)
