Integrationsguide
Evenemang och webhook
Validera examensingång
Du kan validera en respondent som håller på att ta en tentamen och också lägga till metadata om den här användaren.
När en respondent begäran om att starta en tentamen kommer vår server att göra en webhook -begäran till din server -URL för att validera om respondentens referens (t.ex. e -post, lösenord eller matric nr) är giltiga.
Din server kan tillval svara med några metadata om denna respondent, till exempel name, email, photo, about and data.
Nedan efterliknar exempel på begäran till din server och det förväntade svaret om verifiering var framgångsrik
När en respondent begäran om att starta en tentamen kommer vår server att göra en webhook -begäran till din server -URL för att validera om respondentens referens (t.ex. e -post, lösenord eller matric nr) är giltiga.
Din server kan tillval svara med några metadata om denna respondent, till exempel name, email, photo, about and data.
Nedan efterliknar exempel på begäran till din server och det förväntade svaret om verifiering var framgångsrik
Observera att du förväntas svara inom 60 sekunder, annars kommer begäran att avslutas av vår server.
Om respondenten inte kunde valideras av din server förväntas du ange errorMessage Med orsaken förväntas du annars utelämna det.Du kan valfritt tillhandahålla metadata Om valideringen var framgångsrik.
Även om du tänker utföra ansiktsdetektering på svaranden förväntas du tillhandahålla metadata.photo med länk till en skarp bild av svaranden. Rekommenderad bildupplösning är en bild som är större än 1500x1500 pixlar.
Om respondenten inte kunde valideras av din server förväntas du ange errorMessage Med orsaken förväntas du annars utelämna det.Du kan valfritt tillhandahålla metadata Om valideringen var framgångsrik.
Även om du tänker utföra ansiktsdetektering på svaranden förväntas du tillhandahålla metadata.photo med länk till en skarp bild av svaranden. Rekommenderad bildupplösning är en bild som är större än 1500x1500 pixlar.
Se till att du verifierar all inkommande begäran till dig server genom att kontrollera mot x-client-id and x-client-secret på förfrågningshuvudet
{
"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"
}Nedan efterliknar exempel på begäran till din server och det förväntade svaret om verifiering misslyckades
{
"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"
}Se till att du aktiverat validate fields via webhook på examen skapande sida
Eller om du använder utvecklaren API, se till welcomePage.validate är sant
Eller om du använder utvecklaren API, se till welcomePage.validate är sant
Ställ in din webbadress
Du kan ställa in och ändra din server webhook url, här är hur
Navigera till inställningar.
Gå till utvecklaravsnittet.
Edit and copy your webhook url
Erkänna svarandevenemanget
Vår server kommer att meddela din server när en respondent har antagits att ta en tentamen. Nedan visar exempel detta scenario
respondent_id Att leta upp ytterligare information om denna respondent
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Resultatklart händelse
Vår server kommer att meddela din server när en respondentresultat för en tentamen är klar. Nedan visar exempel detta scenario
respondent_id Att leta upp resultatdata för denna respondent
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Undersökningens kompletta evenemang
Vår server kommer att meddela din server när utredningen på en respondent är klar. Nedan visar exempel detta scenario
respondent_id Att leta upp ytterligare information om denna respondent
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Feedback -kommentarer (0)
