API авторизации OAuth2

Для отправки запросов на Платформу, вам необходим токен авторизации.

Для его получения вам необходимо пройти регистрацию на Платформе.

На основном рабочем окружении для получения токена используется следующая конечная точка:

https://cdb.neurop.org/connect/token

Для получения токена, необходимо отправить POST-запрос со следующими параметрами.

У запроса должен быть заголовок «Content-Type: application/x-www-form-urlencoded».

В качестве типа содержимого в теле сообщения используется x-www-form-urlencoded. Это явно следует из заголовка, но, тем не менее, это важно указать, например, при отправке через Postman, где этот параметр нужно указать отдельно в разделе Body.

В теле запроса используются следующие параметры:

  • grant_type: password
  • client_id: 3
  • client_secret: Secret123
  • acr_values: idp:PWD
  • username: {ваш email}
  • email: {ваш email}
  • password: {ваш пароль}

Важно! Обратите внимание, что в качестве username нужно указывать не имя и фамилию, которые вы указывали при регистрации, а именно почту, так как именно она является логином в систему.

В ответ вам вернется JSON следующего вида:

{
    "access_token": "{строка токена доступа}",
    "expires_in": 1296000,
    "token_type": "Bearer",
    "refresh_token": "{строка токена обновления}",
    "scope": "api offline_access"
}

Всё! access_token и refresh_token можно использовать для отправки запросов в API системы.

Важно! Пользователь, который используется для получения токена, должен иметь необходимые права доступа к тем пользователям, по которым он будет запрашивать данные.

При тестировании функций Платформы и отладке это не так важно, поскольку вы обычно используете свои собственные данные, но при реальной работе вам нужны будут данные всех пользователей вашего приложения. По этому вопросу вам необходимо связаться с администраторами Платформы и запросить соответствующий уровень доступа для своего аккаунта.