Ръководство за интеграция
Събития и уебхок
Валидирайте входа на изпита
Можете да утвърдите респондент, който е на път да вземе изпит и също така да добавите метаданни за този потребител.
Когато заявка за респондент за стартиране на изпит, нашият сървър ще направи заявка за уебхока до вашия сървър URL, за да валидира, ако респондентът (напр. Имейл, парола или матричен №) са валидни.
Вашият сървър може да отговори с някои метаданни за този респондент, като например name, email, photo, about and data.
По -долу пример имитира заявката, направена на вашия сървър и очаквания отговор, ако проверката е успешна
Когато заявка за респондент за стартиране на изпит, нашият сървър ще направи заявка за уебхока до вашия сървър URL, за да валидира, ако респондентът (напр. Имейл, парола или матричен №) са валидни.
Вашият сървър може да отговори с някои метаданни за този респондент, като например name, email, photo, about and data.
По -долу пример имитира заявката, направена на вашия сървър и очаквания отговор, ако проверката е успешна
Моля, обърнете внимание, че се очаква да отговорите в рамките на 60 секунди или заявката ще бъде прекратена от нашия сървър.
Ако респондентът не може да бъде валидиран от вашия сървър, се очаква да предоставите errorMessage с причината, иначе се очаква да го пропуснете.Можете по жела ние да предоставите metadata Ако валидирането беше успешно.
Също така, ако възнамерявате да извършите откриване на лица на респондента, се очаква да предоставите metadata.photo с връзка към рязко изображение на респондента. Препоръчителната разделителна способност на изображението е изображение, по -голямо от 1500x1500 пиксела.
Ако респондентът не може да бъде валидиран от вашия сървър, се очаква да предоставите errorMessage с причината, иначе се очаква да го пропуснете.Можете по жела ние да предоставите metadata Ако валидирането беше успешно.
Също така, ако възнамерявате да извършите откриване на лица на респондента, се очаква да предоставите metadata.photo с връзка към рязко изображение на респондента. Препоръчителната разделителна способност на изображението е изображение, по -голямо от 1500x1500 пиксела.
Уверете се, че проверявате всички входящи заявки към вашия сървър, като проверка срещу x-client-id and x-client-secret на заглавката на заявката
{
"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"
}По -долу пример имитира заявката, направена на вашия сървър и очаквания отговор, ако проверката не успее
{
"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"
}Уверете се, че сте активирали validate fields via webhook В страницата за създаване на изпита
Или ако използвате API за разработчици, уверете се welcomePage.validate е вярно
Или ако използвате API за разработчици, уверете се welcomePage.validate е вярно
Настройка на вашия URL адрес на WebHook
Можете да зададете и промените вашия URL адрес на вашия сървър, ето как
Отворете Настройки.
Отидете в секцията за разработчици.
Edit and copy your webhook url
Признайте събитието на респондентите
Нашият сървър ще уведоми вашия сървър, когато респондентът е приет да вземе изпит. По -долу пример демонстрирайте този сценарий
respondent_id За да търсите допълнителна информация за този респондент
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Резултат готов събитие
Нашият сървър ще уведоми вашия сървър, когато резултатът от респондента за изпит е готов. По -долу пример демонстрирайте този сценарий
respondent_id За да търсите данните за резултатите за този респондент
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Разследване Пълно събитие
Нашият сървър ще уведоми вашия сървър при приключване на разследването на респондент. По -долу пример демонстрирайте този сценарий
respondent_id За да търсите допълнителна информация за този респондент
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Коментари за обратна връзка (0)
