Integratiegids
Evenementen en webhook
Valideer exameningang
U kunt een respondent valideren die op het punt staat een examen af te leggen en ook metadata over deze gebruiker toe te voegen.
Wanneer een respondentverzoek om een examen te starten, zal onze server een WebHook -verzoek indienen bij uw server -URL om te valideren of de respondentreferenties (bijv. E -mail, wachtwoord of matric no) geldig zijn.
Uw server kan optioneel reageren met wat metadata over deze respondent, zoals name, email, photo, about and data.
Hieronder is het voorbeeld het verzoek aan uw server en de verwachte reactie na te bootsen als de verificatie succesvol was
Wanneer een respondentverzoek om een examen te starten, zal onze server een WebHook -verzoek indienen bij uw server -URL om te valideren of de respondentreferenties (bijv. E -mail, wachtwoord of matric no) geldig zijn.
Uw server kan optioneel reageren met wat metadata over deze respondent, zoals name, email, photo, about and data.
Hieronder is het voorbeeld het verzoek aan uw server en de verwachte reactie na te bootsen als de verificatie succesvol was
Houd er rekening mee dat u verwacht dat u binnen 60 seconden reageert of dat het verzoek door onze server wordt beëindigd.
Als de respondent niet door uw server kan worden gevalideerd, wordt van u verwacht errorMessage Met de reden wordt van u verwacht dat u het weglaat.U kunt optioneel de metadata Als de validatie succesvol was.
Ook als u van plan bent om gezichtsdetectie op de respondent uit te voeren, wordt van u verwacht dat u de metadata.photo met link naar een scherp beeld van de respondent. Aanbevolen beeldresolutie is een afbeelding groter dan 1500x1500 pixels.
Als de respondent niet door uw server kan worden gevalideerd, wordt van u verwacht errorMessage Met de reden wordt van u verwacht dat u het weglaat.U kunt optioneel de metadata Als de validatie succesvol was.
Ook als u van plan bent om gezichtsdetectie op de respondent uit te voeren, wordt van u verwacht dat u de metadata.photo met link naar een scherp beeld van de respondent. Aanbevolen beeldresolutie is een afbeelding groter dan 1500x1500 pixels.
Zorg ervoor dat u alle inkomende aanvraag naar uw server verifieert bij cheque tegen x-client-id and x-client-secret Op de kopkop
{
"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"
}Hieronder is het voorbeeld het verzoek aan uw server en de verwachte reactie na de verificatie nabootst als de verificatie is mislukt
{
"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"
}Zorg ervoor dat u ingeschakeld bent validate fields via webhook op de pagina voor het maken van examens
Of als u de ontwikkelaar API gebruikt, zorg er dan voor welcomePage.validate is waar
Of als u de ontwikkelaar API gebruikt, zorg er dan voor welcomePage.validate is waar
Uw webhook -url instellen
U kunt uw server -webhook -url instellen en wijzigen, hier is hoe
Navigeer naar instellingen.
Ga naar het ontwikkelaarssectie.
Edit and copy your webhook url
Laat de respondent -gebeurtenis toe
Onze server zal uw server op de hoogte stellen wanneer een respondent is toegelaten om een examen af te leggen. Hieronder voorbeeld demonstreer dit scenario
respondent_id om aanvullende informatie over deze respondent op te zoeken
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Resultaat klaar evenement
Onze server zal uw server op de hoogte stellen wanneer een respondentresultaat voor een examen gereed is. Hieronder voorbeeld demonstreer dit scenario
respondent_id om de resultaatgegevens voor deze respondent op te zoeken
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Onderzoek compleet evenement
Onze server zal uw server op de hoogte stellen wanneer onderzoek op een respondent is voltooid. Hieronder voorbeeld demonstreer dit scenario
respondent_id om aanvullende informatie over deze respondent op te zoeken
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Feedback -opmerkingen (0)
