Руководство по интеграции
События и веб -крюк
Проверить вход в экзамен
Вы можете проверить респондента, который собирается сдать экзамен, а также добавить метаданные об этом пользователе.
Когда запрос респондента запустить экзамен, наш сервер сделает запрос на веб -крючок на 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 своего сервера Webhook, вот как
Перейдите к настройкам.
Перейдите в раздел разработчика.
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)
