API docs by Redocly

Develug API (0.3.0)

Download OpenAPI specification:

Auth

Авторизация

Авторизация

Авторизует пользователя в системе

Request Body schema: application/json
login
required
string [ 6 .. 100 ] characters

Email или телефон пользователя

password
required
string <password> [ 6 .. 100 ] characters

Пароль пользователя

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string"
}

Запрос на обновление refresh токена

Обновляет токены

Request Body schema: application/json
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string"
}

Восстановление пароля

Запрос письма на восстановление пароля

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "message": "Письмо отправлено на адрес: example@mail.com",
  • "email": "example@mail.com"
}

Сброс пароля

Установка нового пароля пользователя с токеном из письма

Request Body schema: application/json
token
required
string <= 255 characters
new_password
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "token": "token",
  • "new_password": "password"
}

Response samples

Content type
application/json
{
  • "message": "Пароль успешно сброшен"
}

User

API Пользователя

Получение пользователя по токену

Возвращает информацию о пользователе, если токен валиден

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "active": true,
  • "email": "user@example.com",
  • "first_name": "Имя",
  • "last_name": "Фамилия",
  • "second_name": "Отчество",
  • "phone": "+79123456789",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "birth_date": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "settings": "{\"key1\": \"value1\"}"
}

Регистрация

Регистрация пользователя

Request Body schema: application/json
email
required
string <email>
password
required
string [ 6 .. 100 ] characters
phone
required
string = 12 characters
first_name
required
string <= 100 characters
last_name
string <= 100 characters
second_name
string <= 100 characters
birth_date
string <date-time>

Дата рождения

region
string <uuid>

Id региона (reference-service)

roles
Array of strings
Items Enum: "ROLE_REALTOR" "ROLE_MANAGER" "ROLE_SALES_HEAD" "ROLE_READ_ONLY"
settings
object

Ключ - значение (любой JSON: строка, число, bool, массив, объект)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string",
  • "phone": "+79123456789",
  • "first_name": "Имя",
  • "last_name": "Фамилия",
  • "second_name": "Отчество",
  • "birth_date": "2019-08-24T14:15:22Z",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "roles": [
    ],
  • "settings": "{\"key1\": \"value1\"}"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Обновление профиля

Обновление текущего пользователя

Request Body schema: application/json
first_name
string <= 100 characters
last_name
string <= 100 characters
second_name
string <= 100 characters
phone
string <= 20 characters
region
string <uuid>

Id региона (reference-service)

birth_date
string <date-time>

Дата рождения

settings
object

Ключ - значение (любой JSON: строка, число, bool, массив, объект)

Responses

Request samples

Content type
application/json
{
  • "first_name": "Имя",
  • "last_name": "Фамилия",
  • "second_name": "Отчество",
  • "phone": "+79123456789",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "birth_date": "2019-08-24T14:15:22Z",
  • "settings": "{\"key1\": \"value1\"}"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Подтверждение email

Подтверждение адреса почты

Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "message": "Успешно"
}

Roles

API ролей пользователей

Получить список ролей

Authorizations:
None
Request Body schema: application/json
required
required
object (FilterRolesDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}