РКИ API / Документация о сервисе
В данном разделе приведен основной перечень запросов РКИ API.
Бесшовная интеграция
[GET] /security/generateToken/{$id}
Данный запрос создает уже существующему пользователю платформы уникальный одноразовый ключ, в ответе вы получите ссылку на активацию ключа и авторизации данного пользователя.
{ "success": true, "message": "Одноразовый веб-токен успешно сгенерирован", "status": 200, "data": "https://ros-edu.ru/api-auth?u=****&t=******************************** }
Данный запрос принимает параметры, передаваемые ему в GET-массиве:
- publication_id - если передано, проверяется существует ли данная публикация, если да, произойдет автопереход на страницу публикации
Формат ошибок:
{ "success": false, "message": "Пользователь не найден в БД платформы РКИ", "status": 404, "data": null }
[GET] /security/generateAutoAuthUrl
Данный запрос создает ссылку для прохождения автоматической регистрации/аутентификации пользователя. Если пользователь был создан ранее, то по данной ссылке произойдет его автовход на платформу, если пользователя нет на платформе, автоматически будет создана его учетная запись и произведен вход.
{ "success": true, "message": "Ссылка успешно сгенерирована", "status": 200, "data": "https://ros-edu.ru/auto-api-auth?&client_id=****&token=********************************&time=**********&email=**********&fullname=***********&user_type=[1-4]&publication_id=*****&open_method=****** }
Данный запрос принимает параметры, передаваемые ему в GET-массиве:
- email — email пользователя, если он уже зарегистрирован, произойдет автоматическая авторизация данного пользователя
- fullname - полное имя пользователя
- user_type - тип пользователя:
- 3 - студенты
- 2 - преподаватели
- publication_id - если передано, проверяется существует ли данная публикация, если да, произойдет автопереход на страницу публикации
- open_method - работает, если передан publication_id, может иметь только 1 значение «iframe», либо не существовать в принципе. Если передан open_method=iframe, проверит доступность издания, проверит возможность загрузки в iframe, если все проверки успешно пройдены, откроет ридер с загруженной публикацией
Формат ошибок:
{ "success": false, "message": "Ссылка не может быть сгенерирована, проверьте правильность переданных параметров", "status": 404, "data": null }