Основная информация

• Текущая версия API — 2.0, в адресах запросов данный префикс обязателен.
• Все запросы к сервису выполняются с помощью HTTP-методов GET и POST.
• Взаимодействие с сервисом должно осуществляться по защищённому протоколу HTTPS.
• Каждый запрос должен сопровождаться JWT-токеном.
• В каждом запросе клиент должен передавать ключ доступа в заголовке X-APIKey. Если ключ не передан, или переданный в запросе ключ не верен, то сервис возвращает ошибку HTTP 403
• API ВКР-ВУЗ располагается и доступен только по адресу https://api.vkr-vuz.ru/2.0/{client_id}, где client_id - обязательный параметр для каждого запроса, будьте внимательны.

Аутентификация

Аутентификация пользователей производится посредством передачи токена безопасности пользователя с каждым запросом к сервису с помощью заголовка Authorizaton. Пример заголовка: Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...OjU4MTMsInRpbWUiOjE1Mjc1MTA2OTYOjU4MTM

JWT токен должен содержать следующие данные:

• client_id — идентификатор организации-клиента ВКР-ВУЗ (получается вместе с ключевой фразой для получения JWT-токена).
• time — время запроса от клиента (время фиксируется, не допуская выполнения с уже использованными ранее ключами)
• ip — ip-адрес клиента (значение может быть пустым, используется для обеспечения еще одного слоя безопасности запросов по требованию)

Описание запросов

Если указанный запрос не существует, сервис вернет ошибку HTTP 404, в ответе всегда будет содержаться сообщение.