Документация по Работе с пользователями

Основная тема - https://teletype.in/@randomlywebban/_UBQkEIIydr

Работа с пользователями

POST api/v1/users/login-user/

Используется для аутентификации пользователей

Параметры

email* - Почта пользователя

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

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

{
    "status": 200,
    "description": "OK"
}

Если данные корректны, то пользователь аутентифицируется, и создаётся токен. Сессия становится активной

POST api/v1/users/register-user/

Используется для регистрации пользователей. Обязательный параметр - referral_code

Параметры

username* - Имя пользователя

email* - Почта пользователя

referral_code* - Реферальный код пользователя

password* - Пароль для регистрации

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

{
    "status": 200,
    "description": "OK"
}

Статус коды и их описания

{
    "status": 500,
    "description": "Email {email} already exists."
}

Такая почта уже зарегестрирована в базе данных, и повторно использоваться не может

{
    "status": 400,
    "description": "The Referral Code is invalid!"
}

Неправильный реферальный код, который является обязательным параметром при регистрации пользователя

{
    "status": 400,
    "description": "Описание ошибки"

}

Остальные ошибки выводятся в таком формате

GET api/v1/users/logout-user/

Выход из сессии = logout

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

{
    "status": 200,
    "description": "OK"
}

Выход из аккаунта прошёл успешно, токен удалён

GET api/v1/users/profile-user/

Метод возвращает данные юзера. Важный параметр - юзер должен быть авторизован. Параметр trc20 не может быть заполнен, пока kyc == False

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

{
    "username": "admin2",
    "email": "admin2@mail.ru",
    "balance": 0.0,
    "balance_in_freeze": 0.0,
    "referral_code": "7acbe0985ed",
    "is_verified": false,
    "trc20": ""
}

Параметры ответа

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

email - почта пользователя

balance - баланс пользователя

balance_in_freeze - замороженный баланс пользователя

referral_code - реферальный код пользователя

is_verified - пройдена ли KYC проверка

trc20 - кошелёк для вывода

Статус коды и их описания

{
    "status": 500,
    "description": "User not found"
}

Запрашиваемый пользователь не найден

POST api/v1/users/edit-trc20-adress-user/

Запрос по этому endpoint`у не даст результатов, если пользователь не прошёл KYC верификацию. Возвращает "OK, TRC20 Adress changed" если все требования соблюдены - пройдена верификация и адрес корректный.

Параметры

trc20_adress - адрес USDT - TRC20 для вывода крипто монет

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

{
    "status": 200,
    "description": "OK, TRC20 Adress changed"
}

Адрес сменён успешно

Статус коды и их описания

{
    "status": 403,
    "description": "You dont pass the KYC"
}

Проверка KYC не пройдена. В изменении адреса отказано

{
    "status": 500,
    "description": "описание ошибки"
}

Остальные ошибки выводятся в таком формате

POST api/v1/users/deposit-user/

Используется для пополнения счёта через USDT. Пользователь передаётся автоматически. Авторизация обязательна

Параметры

amount* - сумма пополнения

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

{
    "status": 200,
    "description": "Order created",
    "unique_id": "9d1b9a9"
}

Отстук в телеграм бота

Статус коды и их описания

{
    "status": 500,
    "description": "описание ошибки"
}

Остальные ошибки выводятся в таком формате

POST api/v1/users/withdraw-user/

Используется для создания заявки на вывод средств. Также доступна только при пройденной KYC. После успешного запроса на вывод сумма списывается с баланса, и добавляется в замороженный баланс

Параметры

amount* - сумма вывода

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

{
    "status": 200,
    "description": "OK",
    "unique_id": "8142ea2"
}

Отстук в тг бота

Статус коды и их описания

{
    "status": 400,
    "description": "not money on balance enough"
}

Недостаточно средств на балансе

{
    "status": 403,
    "description": "You dont pass the KYC verification!"
}

Верификация не была пройдена пользователем

{
    "status": 500,
    "description": "описание ошибки"
}

Остальные ошибки выводятся в таком формате