API для внешних систем

Обучение и тестирование

Базовый адрес API: [Основной адрес портала]/Gate
Аутентификация: JWT Bearer в заголовке Authorization: Bearer <token>.

Выдача JWT токена для пользователя сервиса

POST /Gate/Auth/token

Тело запроса

Поле	Тип	Обязательность	Описание
`username`	string	Да	Логин пользователя.
`password`	string	Да	Пароль пользователя.

{
  "username": "user1",
  "password": "secret"
}

Успешный ответ (200 OK)

{
  "accessToken": "<jwt>",
  "expiresAtUtc": "2026-05-25T10:30:00Z"
}

Коды ответа

Код	Когда возвращается
200	Токен успешно выдан.
400	Не передан `username` или `password`.
401	Неуспешная проверка логина/пароля.
403	У пользователя сервиса отсутствует требуемая роль.

Регистрация запроса на создание тестирования пользователя по курсу

POST /Gate/Lms/RegisterRequest

Метод защищен: требуется валидный JWT токен.

Структура LMSClient

Поле	Тип	Обязательность	Описание
`fio`	string	Да	ФИО пользователя
`birthday`	string	Нет	Дата рождения (строковый формат)
`sex`	string	Да	Пол: `Мужской`/`Женский`
`email`	string	Да	Email
`phone`	string	Нет	Телефон.
`snils`	string	Нет	СНИЛС
`comment`	string	Нет	Комментарий
`requestId`	string	Да	Идентификатор запроса во внешней системе
`testFormat`	string	Нет	Формат тестирования: `Очный`/`Заочный`/`Любой`
`courseList`	LMSCourse	Да	Список курсов (см. ниже)
`portalPositionName`	string	Нет	Наименование должности в портале для вновь создаваемых пользователей
`authorizationMode`	string	Да	Режим авторизации: `default`/`email`/`esia`.

Вложенная структура LMSCourse

Поле	Тип	Описание
`mnemo`	string	Мнемоника/код курса
`dateFrom`	string	Дата начала тестирования
`dateTo`	string	Дата завершения тестирования

Успешный ответ (200 OK)

"Запрос успешно выполнен"

Коды ответа

Код	Когда возвращается
200	Запрос успешно обработан.
401	Токен отсутствует или невалиден (JWT middleware).
500	Ошибка валидации/обработки внутри метода.

Пример запроса curl

curl --request POST \
  --url https://<host>/Gate/Lms/RegisterRequest \
  --header 'authorization: Bearer <jwt>' \
  --header 'content-type: application/json' \
  --data '{
  "fio": "Иванов Иван Иванович",
  "birthday": "11.11.1991",
  "sex": "Мужской",
  "email": "api_lms@default.int",
  "phone": "223322",
  "snils": "12345",
  "comment": "Комментарий к пользователю",
  "requestId": "ExternalId",
  "testFormat": "Очный",
  "courseList": [
    {
      "mnemo": "CUSTOM_UID",
      "dateFrom": "11.11.2020",
      "dateTo": "11.11.2030"
    }
  ],
  "portalPositionName": "Зарегистрированные по заявкам на тестирование",
  "authorizationMode": "default"
}'

База знаний

Базовый адрес API: [Адрес базы знаний]/eknow
Аутентификация: не требуется.

Получение информации по всем услугам

GET /eknow/GetAllServicesInfo

Параметры запроса

нет

Успешный ответ (200 OK)

{
}

Получение информации по одной услуге

GET /eknow/GetServiceInfo?value=

Параметры запроса

Поле	Тип	Описание
`value`	string	Код услуги АИС

Успешный ответ (200 OK)

{
}