API платформы «Сетевые ЭОР вузов» / Документация о сервисе
В данном разделе приведен основной перечень запросов API платформы «Сетевые ЭОР вузов».
Основная информация
- Текущая версия API — 2.0, в адресах запросов данный префикс обязателен.
- Все запросы к сервису выполняются с помощью HTTP-метода GET.
- Взаимодействие с сервисом должно осуществляться по защищённому протоколу HTTPS.
- Каждый запрос должен сопровождаться JWT-токеном.
- Каждый запрос должен содержать идентификатор клиента в GET-массиве (client_id)
- В каждом запросе клиент должен передавать ключ доступа в заголовке X-APIKey. Если ключ не передан, или переданный в запросе ключ не верен, то сервис возвращает ошибку HTTP 403
- API «Сетевые ЭОР вузов» располагается и доступен только по адресу https://eorapi.iprbooks.ru/, будьте внимательны.
Аутентификация
Аутентификация пользователей производится посредством передачи токена безопасности пользователя с каждым запросом к сервису с помощью заголовка Authorizaton. Пример заголовка: Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...OjU4MTMsInRpbWUiOjE1Mjc1MTA2OTYOjU4MTM
JWT токен должен содержать следующие данные:
- client_id — идентификатор организации-клиента «Сетевые ЭОР вузов» (получается вместе с ключевой фразой для получения JWT-токена).
- time — время запроса от клиента (время фиксируется, не допуская выполнения с уже использованными ранее ключами)
- ip — ip-адрес клиента (значение может быть пустым, используется для обеспечения еще одного слоя безопасности запросов по требованию)
- exp — дата в формате UNIXTIME, значение которой равно дате окончания срока действия сформированного токена
Описание запросов
Если указанный запрос не существует, сервис вернет ошибку HTTP 404, в ответе всегда будет содержаться сообщение.