ВКР-СМАРТ API / Документация о сервисе

В данном разделе приведен основной перечень запросов ВКР-СМАРТ API.

Список пользователей организации

/users/get

Данный запрос возвращает список учетных записей пользователей организации.

Используйте параметр ответа total для определения количества элементов.

Формат возвращаемых данных:

{
    "success": true,
    "message": "",
    "total": 2,
    "status": 200,
    "data": [
        {
            "id": 1565,
            "fullname": "Кузьмичев Николай Валерьевич",
            "email": "user@example.com",
            "blocked": 0
        },
        {
            "id": 1566,
            "fullname": "Иванов Петр Сергеевич",
            "email": "ivanov@example.com",
            "blocked": 1
        }
    ]
}

/users/add (POST)

Запрос на добавление пользователя. Обязательно должны быть переданы следующие данные:

  • email — email-адрес пользователя, длина не более 255 символов, должен быть уникальным;
  • fullname — полное имя пользователя, длина не более 255 символов;
  • password — пароль пользователя (от 5 до 250 символов).

Опционально:

  • specialty_id — идентификатор направления подготовки пользователя из структуры организации.

Формат ответа в случае успеха:

{
    "success": true,
    "message": "",
    "status": 200,
    "data": {
        "id": 43924,
        "fullname": "Иванов Петр Сергеевич",
        "email": "ivanov@example.com",
        "blocked": 0
    }
}

Формат ответа в случае ошибки валидации:

{
    "success": false,
    "data": {
        "title": "Ошибка валидации",
        "message": "The email has already been taken. "
    }
}

/users/{user_id}/generateToken

Данный запрос создает одноразовую ссылку авторизации пользователя для автологина на портале ВКР-СМАРТ.

{
    "success": true,
    "message": "Одноразовый веб-токен успешно сгенерирован",
    "status": 200,
    "data": "https://dev.vkr-smart.ru/autologin?domain=1&uid=1565&time=1725190000&sign=--------"
}