Как устроена платформа

REST API: методы сервиса авторизации

https://img.shields.io/badge/auth-required-orange.svg

GET ​/status

Метод предназначен для получения статуса сервиса авторизации.

Пример ответа:

POST ​/v1​/user

Метод предназначен для регистрации нового пользователя через сервис авторизации.

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

  • login - логин пользователя (адрес электронной почты);

  • password - пароль для доступа к аккаунту;

  • locale - выбор языка, на котором пользователю будет предоставляться информация на почту (возможные варианты: en и ru);

  • source - тип пользователя: license - владелец лицензии на использование блокчейн-платформы, voting - пользователь сервиса голосования Waves Enterprise Voting.

Если регистрация прошла успешно, в качестве ответа метод возвращает код 201. В случае иного ответа, пользователь не был зарегистрирован.

GET ​/v1​/user​/profile

Метод предназначен для получения данных пользователя.

Пример ответа:

POST ​/v1​/user​/address

Метод предназначен для получения идентификатора адреса пользователя. В запросе метода передаются следующие данные:

  • address - адрес пользователя в блокчейне;

  • name - имя пользователя.

Пример ответа:

GET /v1​/user​/address​/exists

Метод предназначен для проверки адреса электронной почты пользователя. В качестве параметра на вход метод принимает электронный адрес пользователя.

Пример ответа:

POST ​/v1​/user​/password​/restore

Метод предназначен для восстановления пароля доступа к аккаунту пользователя.

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

  • email - электроный адрес пользователя;

  • source - тип пользователя: * license - владелец лицензии на использование блокчейн-платформы; * voting - пользователь сервиса голосования Waves Enterprise Voting.

    Пример ответа:

POST ​/v1​/user​/password​/reset

Метод предназначен для сброса пароля пользователя.

В запросе указываются следующие данные:

  • token - токен авторизации пользователя;

  • password - текущий пароль пользователя.

Пример ответа:

GET ​/v1​/user​/confirm​/{code}

Метод предназначен для передачи кода подтверждения для восстановления пароля для доступа к аккаунту пользователя. В запросе передаётся значение кода подтверждения.

POST ​/v1​/user​/resendEmail

Метод предназначен для повторной отправке кода восстановления пароля на указанный электронный адрес.

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

В ответе метод возвращает электронный адрес пользователя, на который был отправлен код восстановления.

Пример ответа:

POST ​/v1​/auth​/login

Метод предназначен для получения нового токена авторизации для пользователя.

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

  • username - имя пользователя;

  • password - пароль для доступа к аккаунту;

  • locale - выбор языка, на котором пользователю будет предоставляться информация на почту (возможные варианты: en и ru);

  • source - тип пользователя: * license - владелец лицензии на использование блокчейн-платформы; * voting - пользователь сервиса голосования Waves Enterprise Voting.

Пример ответа:

POST ​/v1​/auth​/token

Метод предназначен для получения токенов авторизации для внешних сервисов и приложений. Не требует параметров запроса.

Пример ответа:

POST ​/v1​/auth​/refresh

Метод предназначен для получения нового refresh-токена. В запросе метода передается значение текущего refresh-токена.

Пример ответа:

GET​ /v1​/auth​/publicKey

Метод предназначен для получения публичного ключа сервиса авторизации. Не требует параметров запроса.

Пример ответа: