API. Отправка нарушений киберпроктора в реальном времени
Имеется возможность получать информацию о новых нарушениях пользователя во время сдачи сессии. Каждый раз, когда нарушение детектируется при помощи искусственного интеллекта, Экзамус делает запрос к API системы заказчика, отправляя данное нарушение.
Перед активацией этой функциональности следует убедиться, что сервер готов к большому количеству запросов.
API URL:
[warning_url]
Тип запроса:
POST
Заголовки запроса:
Content-Type: application/json
Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MTI5OTQxMzF9.PRzN
Подпись JWT позволяет проверить, что запрос идет от Экзамуса и что токен сгенерирован в момент запроса. В payload токена содержится дата и время истечения токена в числовом формате Unix timestamp.
Пример JWT Payload:
{
"exp": 1612994131
}
JSON-тело запроса:
{
"accountId": "123",
"sessionId": "b3875623",
"type": "WARNING_AVERT_EYES",
"start": "2018-07-19T12:05:25+00:00",
"end": "2018-07-19T12:06:01+00:00",
"cyber": true,
"id": 1
}
|
Поле |
Тип |
Описание |
|
accountId* |
string |
Идентификатор организации в системе заказчика |
|
sessionId* |
string |
Идентификатор сеанса в системе заказчика |
|
type* |
string (enum) |
Тип нарушения |
|
start* |
string (datetime) |
Время начала нарушения в формате ISO 8601 |
|
end* |
string (datetime) |
Время окончания нарушения в формате ISO 8601 |
|
cyber* |
boolean |
true — нарушение зафиксировано только автоматикой (киберпроктором) false — нарушение зафиксировано или подтверждено человеком (в данном случае всегда true) |
|
id* |
int |
Идентификатор нарушения в Экзамусе |