Руководство по интеграции

Основной сценарий использования сервиса

API

API сервиса в текущем состоянии имеет четыре хендлера, отвечающих за:

• Регистрацию новых пользователей (users/registration/)

• Авторизацию пользователей (users/auth)

• Операции с паролем (users/password/)

• Операции с самим пользователем (users/)

users/registration/

• users/registration/email позволяет регистрировать новых пользователей через электронную почту. Используется POST-запрос, обязательные поля: email - почта пользователя password - пароль profile - массив данных в соответствии с JSON-схемой конкретной конфигурации publicity - параметр публичности, отвечающий за видимость профиля в соответствии с конфигурацией конкретной интеграции birthDate - дата рождения firstName - имя lastName - фамилия phoneNumber - номер телефона avatar - аватар пользователя Возвращает токен, необходимый на шаге подтверждения почты

• users/registration/email/confirm позволяет подтвердить почту зарегистрированного пользователя. Используется POST-запрос, обязательные поля: email - почта пользователя token - токен, полученный пользователем на предыдущем шаге.

• users/registration/facebook позволяет регистрировать новых пользователей с использованием профиля в Facebook.

• users/registration/google позволяет регистрировать новых пользователей с использование профиля в Google.

users/password/

• users/password/change позволяет сменить пароль пользователя на платформе. Использует POST-запрос, обязательные поля: oldPassword - пароль, подлежащий замене newPassword - новый пароль

• users/password/reset позволяет направить запрос на смену пароля пользователя на платформе. Использует POST-запрос, обязательные поля: email - почтовый ящик пользователя Возвращает токен, необходимый на следующем шаге для подтверждения смены пароля.

• users/password/reset/confirm подтверждение запроса на смену пароля. Использует POST-запрос, обязательные поля: email - почтовый ящик пользователя token - токен для подтверждения, полученный на предыдущем шаге newPassword - новый пароль

users/auth/

• users/auth/email позволяет авторизоваться на платформе с использованием стандартной пары логин/пароль. Использует POST-запрос, обязательные поля: email - почта пользователя password - пароль пользователя, указанный при регистрации

• users/auth/facebook позволяет авторизоваться на сайте с использованием профиля в Facebook.

• users/auth/google позволяет авторизоваться на сайте с использованием профиля в Google.

• users/auth/refresh позволяет авторизоваться на сайте с использованием refresh-токена. Использует POST-запрос, обязательные поля: refreshToken - refresh-токен

users/

• GET users - запрос на получение списка пользователей

• GET users{id} - запрос на получение профиля одного конкретного пользователя, где id - ID пользователя

• PATCH users{id} - запрос на изменение профиля пользователя. Поля: email - почта пользователя profile - массив данных в соответствии с JSON-схемой конкретной конфигурации id - ID пользователя

• DELETE users{id} - запрос на удаление профиля одного конкретного пользователя, где id - ID пользователя

• PUT users{id}/status - запрос на смену статуса пользователя. Доступно пользователю Платформы с ролью Модератор Возможные значения статуса - [ active, deleted, blocked ]