Integrasjonsveiledning
Hendelser og webhook
Valider eksamensinngangen
Du kan validere en respondent som er i ferd med å ta en eksamen og også legge til metadata om denne brukeren.
Når en respondentforespørsel om å starte en eksamen, vil serveren vår komme med en webhook -forespørsel til server -URL -en din for å validere om respondentopplysning (f.eks. E -post, passord eller matrikknr) er gyldig.
Serveren din kan valgfritt svare med noen metadata om denne respondenten, for eksempel name, email, photo, about and data.
Nedenfor Eksempel etterligner forespørselen som ble fremsatt til serveren din og det forventede svaret hvis verifiseringen var vellykket
Når en respondentforespørsel om å starte en eksamen, vil serveren vår komme med en webhook -forespørsel til server -URL -en din for å validere om respondentopplysning (f.eks. E -post, passord eller matrikknr) er gyldig.
Serveren din kan valgfritt svare med noen metadata om denne respondenten, for eksempel name, email, photo, about and data.
Nedenfor Eksempel etterligner forespørselen som ble fremsatt til serveren din og det forventede svaret hvis verifiseringen var vellykket
Vær oppmerksom på at du forventes å svare innen 60 sekunder, eller at forespørselen blir avsluttet av serveren vår.
Hvis respondenten ikke kunne valideres av serveren din, forventes det at du gir errorMessage Med grunnen, ellers forventes det at du utelater det.Du kan eventuelt oppgi metadata Hvis valideringen var vellykket.
Også hvis du har tenkt å utføre ansiktsdeteksjon på respondenten, forventes det at du gir metadata.photo med lenke til et skarpt bilde av respondenten. Anbefalt bildeoppløsning er et bilde større enn 1500x1500 piksler.
Hvis respondenten ikke kunne valideres av serveren din, forventes det at du gir errorMessage Med grunnen, ellers forventes det at du utelater det.Du kan eventuelt oppgi metadata Hvis valideringen var vellykket.
Også hvis du har tenkt å utføre ansiktsdeteksjon på respondenten, forventes det at du gir metadata.photo med lenke til et skarpt bilde av respondenten. Anbefalt bildeoppløsning er et bilde større enn 1500x1500 piksler.
Forsikre deg om at du bekrefter all innkommende forespørsel til din server ved å sjekke mot x-client-id and x-client-secret på forespørselsoverskriften
{
"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 etterligner forespørselen som ble fremsatt til serveren din og forventet respons hvis bekreftelsen mislyktes
{
"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"
}Forsikre deg om at du aktiveres validate fields via webhook på eksamensopprettingsiden
Eller hvis du bruker Developer API, må du sørge for welcomePage.validate er sant
Eller hvis du bruker Developer API, må du sørge for welcomePage.validate er sant
Angi netthagen URL
Du kan stille inn og endre serveren WebHook URL, her er hvordan
Naviger til innstillinger.
Gå til utviklerseksjonen.
Edit and copy your webhook url
Innrømme respondenthendelse
Serveren vår vil varsle serveren din når en respondent er tatt opp til å ta en eksamen. Nedenfor eksempel demonstrere dette scenariet
respondent_id å slå opp ytterligere informasjon om denne respondenten
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Resultat klar hendelse
Serveren vår vil varsle serveren din når et respondentresultat for en eksamen er klar. Nedenfor eksempel demonstrere dette scenariet
respondent_id å slå opp resultatdataene for denne respondenten
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Undersøkelse fullstendig hendelse
Serveren vår vil varsle serveren din når etterforskningen på en respondent er fullført. Nedenfor eksempel demonstrere dette scenariet
respondent_id å slå opp ytterligere informasjon om denne respondenten
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Tilbakemeldingskommentarer (0)
