Guida di integrazione
Eventi e webhook
Convalida l'ingresso dell'esame
Puoi convalidare un intervistato che sta per sostenere un esame e anche aggiungere metadati su questo utente.
Quando una richiesta del rispondente di avviare un esame, il nostro server effettuerà una richiesta WebHook all'URL del server per convalidare se le credenziali del rispondente (ad es. E -mail, password o no matric) sono valide.
Il tuo server può opzionale a rispondere con alcuni metadati su questo intervistato, come ad esempio name, email, photo, about and data.
Di seguito Esempio imita la richiesta presentata al tuo server e la risposta prevista se la verifica ha avuto successo
Quando una richiesta del rispondente di avviare un esame, il nostro server effettuerà una richiesta WebHook all'URL del server per convalidare se le credenziali del rispondente (ad es. E -mail, password o no matric) sono valide.
Il tuo server può opzionale a rispondere con alcuni metadati su questo intervistato, come ad esempio name, email, photo, about and data.
Di seguito Esempio imita la richiesta presentata al tuo server e la risposta prevista se la verifica ha avuto successo
Si prega di notare che ci si aspetta che risponda entro 60 secondi o la richiesta sarà terminata dal nostro server.
Se il rispondente non poteva essere validato dal tuo server, prevedi di fornire errorMessage Con il motivo, altrimenti ci si aspetta che lo ometti.È possibile fornire facoltativamente il metadata Se la convalida ha avuto successo.
Inoltre, se si intende eseguire il rilevamento del viso sul rispondente, prevedi di fornire il metadata.photo con collegamento a un'immagine acuta del convenuto. La risoluzione dell'immagine consigliata è un'immagine maggiore di 1500x1500 pixel.
Se il rispondente non poteva essere validato dal tuo server, prevedi di fornire errorMessage Con il motivo, altrimenti ci si aspetta che lo ometti.È possibile fornire facoltativamente il metadata Se la convalida ha avuto successo.
Inoltre, se si intende eseguire il rilevamento del viso sul rispondente, prevedi di fornire il metadata.photo con collegamento a un'immagine acuta del convenuto. La risoluzione dell'immagine consigliata è un'immagine maggiore di 1500x1500 pixel.
Assicurati di verificare tutte le richieste in arrivo al tuo server tramite controllare x-client-id and x-client-secret Sull'intestazione della richiesta
{
"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"
}Di seguito Esempio imita la richiesta presentata al server e la risposta prevista se la verifica non è riuscita
{
"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"
}Assicurati di abilitare validate fields via webhook Nella pagina di creazione dell'esame
O se stai usando l'API per sviluppatore, assicurati welcomePage.validate è vero
O se stai usando l'API per sviluppatore, assicurati welcomePage.validate è vero
Impostazione del tuo URL Webhook
Puoi impostare e modificare l'URL Webhook del server, ecco come
Passare alle impostazioni.
Vai alla sezione sviluppatore.
Edit and copy your webhook url
Ammetti l'evento rispondente
Il nostro server avviserà il tuo server quando un rispondente è stato ammesso di sostenere un esame. Di seguito Esempio Dimostrare questo scenario
respondent_id Per cercare ulteriori informazioni su questo intervistato
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Evento pronto per i risultati
Il nostro server avviserà il tuo server quando un risultato rispondente per un esame è pronto. Di seguito Esempio Dimostrare questo scenario
respondent_id Per cercare i dati dei risultati per questo intervistato
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Evento completo di indagine
Il nostro server avviserà il tuo server quando le indagini su un rispondente sono completate. Di seguito Esempio Dimostrare questo scenario
respondent_id Per cercare ulteriori informazioni su questo intervistato
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Commenti di feedback (0)
