Это импровизированный бэк-энд для вымышленного сервиса по краткосрочной аренде объектов недвижимости. API-сервис принимает команды в формате JSON и отдаёт информацию в соответствующем формате. Вы можете протестировать его прямо в браузере, благодаря функции “стандартного представления Django Rest Framework”. Этот-же проект может работать как реальный бэк-энд, для реального фронтенда.
Инструкция по пользованию API
Вы можете просмотреть объявления на сайте, для этого не нужна регистрация. Для этого перейдите по адресу:
- www.beautiful-code.ru/api/adverts - Просмотр объявлений на сайте, без регистрации.
Если вы хотите сами разместить объявление, вам нужно зарегистрироваться:
- www.beautiful-code.ru/registration - Регистрация в системе. Для регистрации отправьте JSON в следующем формате: {"username": "********", "email": "*********", "password": "не менее восьми знаков", "password_confirm": "не менее восьми знаков"}
После прохождения регистрации вы можете войти в систему под своим логином и паролем:
- www.beautiful-code.ru/login - Вход в систему. Для входа отправьте JSON в следующем формате: {"email": "*********","password": "*********"}
Вы можете выйти из системы:
- www.beautiful-code.ru/logout - Выход из системы. Для выхода отправьте пустой post-запрос. Ничего не пишите в post-запросе!
После того, как вы вошли в систему под своим логином и паролем, вы можете пользоваться всем её функционалом. Для размещения своего объявления перейдите:
- www.beautiful-code.ru/api/adverts - Разместить своё объявление и просмотреть чужие.
Если вы хотите просмотреть все свои объявления, перейдите:
- www.beautiful-code.ru/api/myadverts - Просмотр всех своих объявлений.
Если вы хотите отредактировать или удалить своё объявление, запомните его ID и перейдите:
- www.beautiful-code.ru/api/myadverts/ID - Редактирование или удаление своего объявления.
Если вы хотите забронировать чей-то объект недвижимости на определённые даты, запомните его ID и перейдите:
- www.beautiful-code.ru/api/booking/ID - Бронирование недвижимости. Просмотрите свободные даты и если хотите забронировать, то отправьте JSON в следующем формате: {"action": "remove", "start_date": "2024-09-10", "end_date": "2024-09-15"} . После того, как вы отправите свой запрос, эти даты исчезнут из списка доступных дат, но это ещё не значит, что вы забронировали эту недвижимость, т.е. владелец недвижимости должен подтвердить ваше бронирование или отказать вам.
Просмотрите все ваши бронирования и статусы согласования с собственником недвижимости:
- www.beautiful-code.ru/api/mybookings - Просмотр информации о ваших бронированиях. В брони есть строка “confirmation_from_the_owner” она может иметь три состояния: “none”, “confirmed”, “denied”. Ожидайте, пока владелец недвижимости согласует вашу бронь.
Вы можете удалить свою бронь на любом этапе. Запомните ID брони и перейдите:
- www.beautiful-code.ru/api/mybookings/ID - Удалить своё бронирование.
Если вы являетесь владельцем недвижимости, то вы можете просмотреть кто, когда и на какие даты забронировал ваши объекты:
- www.beautiful-code.ru/api/myconfirmations - Просмотр бронирований ваших объектов пользователями сайта.
Вы должны подтвердить или отказать человеку, который хочет забронировать вашу недвижимость. Для этого запомните ID и перейдите:
- www.beautiful-code.ru/api/myconfirmations/ID - Согласование бронирования. Чтобы подтвердить бронирование или отказать пользователю вам нужно отправить JSON в следующем формате: {"confirmation_from_the_owner": "confirmed" или "denied"}. Если вы откажите пользователю, то даты, которые он бронировал, сразу-же вернутся в доступные для бронирования других пользователей.
Вы, как пользователь сервиса, можете просматривать средние рейтинги объявлений. Это можно сделать на главной странице:
- www.beautiful-code.ru/api/adverts - Просмотр всей информации об объявлении, включая его средний рейтинг.
Вы можете просмотреть отзывы, которые оставляли пользователи:
- www.beautiful-code.ru/api/ratings - Просмотр отзывов и рейтингов об объектах недвижимости.
Вы можете сами оставить отзыв и рейтинг на объявление:
- www.beautiful-code.ru/api/ratings - Оставить отзыв и рейтинг.
Вы можете просмотреть свои отзывы, которые вы оставили ранее:
- www.beautiful-code.ru/api/myratings - Просмотр своих отзывов, которые вы оставили ранее.
Вы можете отредактировать или удалить свой отзыв, который вы оставили ранее, для этого запомните ID отзыва (Один пользователь не может оставить два разных отзыва на одно и то-же объявление!) и перейдите:
- www.beautiful-code.ru/api/myratings/ID - Редактирование или удаление своего отзыва. Для этого отправьте шаблон {"rating": 10,"review": "Великолепно!"}