Home - rubyhat/fastyshop-backend GitHub Wiki
📘 Добро пожаловать в Kagi Wiki
Это документация проекта Kagi — SaaS-платформы для создания интернет-магазинов.
📚 API Документация
Ниже представлены все доступные страницы API-документации, отсортированные по разделам и контроллерам:
🧾 Чек-лист ручного тестирования
🔐 Аутентификация и пользователи
🧑💼 Продавцы и магазины
🗂️ Категории и товары
⚙️ Характеристики товаров
🛒 Корзина и заказы
Общее описание SaaS-платформы KAGI
Назначение системы
KAGI — это SaaS-платформа для создания интернет-магазинов с уклоном в mobile-first и минимальным порогом входа. Платформа позволяет продавцам в несколько кликов запустить собственный онлайн-магазин и управлять товарами, услугами, заявками, а также принимать заказы от покупателей. Покупатели, в свою очередь, могут использовать единую учетную запись, чтобы взаимодействовать с разными магазинами на платформе.
Целевая аудитория
1. Продавцы (B2B)
- Индивидуальные предприниматели
- Малый и средний бизнес
- Салоны красоты, частные клиники, цветочные магазины, локальные сервисы
- Продавцы физических и цифровых товаров, услуг
2. Покупатели (B2C)
- Частные лица, которые ищут товары или услуги в одном или нескольких магазинах платформы
Основные бизнес-фичи
🎯 Главные цели:
- Упростить запуск интернет-магазина для продавцов без технических навыков
- Предоставить единый аккаунт покупателя для кросс-магазинной авторизации
- Предоставить защищённую и масштабируемую инфраструктуру
Архитектура и роли
Пользовательские роли:
Роль | Возможности |
---|---|
user |
Пользователь. Покупка товаров и услуг, регистрация, просмотр каталогов |
seller |
Продавец. Создание магазинов, управление товарами и услугами, просмотр заказов + все то же, что и user |
superadmin |
Супер-админ. Администрирование всей системы |
supermanager |
Супер-менеджер. Модерация продавцов, магазинов, правка данных |
Бизнес-процессы
👥 Регистрация и авторизация
- Покупатели и продавцы используют единую точку входа
- Продавец должен указать роль
seller
и создатьSellerProfile
и минимум одинLegalProfile
, чтобы открыть магазин
SellerProfile
- Профиль продавца, он создается при смене роли user
-> seller
LegalProfile
- Юридический профиль, он создается Продавцом и используется для работы магазина
🏬 Создание магазина
Ограничения:
- Один продавец может создать до 2 магазинов (в будущем — зависит от тарифа)
- Для создания магазина обязательно наличие
SellerProfile
иLegalProfile
Магазин содержит:
- Название, слаг, контакты, тип (онлайн/офлайн/гибрид)
- Категорию (
ShopCategory
) - Пользовательские настройки (цвета, логотип и пр.)
📦 Товары и услуги
- Единая модель
Product
- Может относиться к
ProductCategory
- Поддерживает свойства (
ProductProperty
,ProductPropertyValue
) - Связь с магазином
Shop
🧾 Свойства и значения
- Продавец может задавать свойства вручную
- Типы значений: строка, число, дата и пр.
- Поддержка массового применения по категориям
📚 Категории товаров
- Иерархическая структура до 3 уровней вложенности
- Ограничение на 20 подкатегорий на уровень
🛒 Покупатели
- Могут покупать в любом магазине
- При первом взаимодействии с магазином — подтверждают доступ
- Аккаунт покупателя кросс-магазинный, но доступ к данным магазинам выдается вручную
- Продавцы не могут просматривать ВСЕХ пользователей системы, а только тех, кто сделал хотя бы один заказ в их магазине
Планируемое расширение
- Тарифные планы для продавцов
- Расширенные шаблоны оформления магазинов
- Аналитика продаж и заказов
- Поддержка кастомных доменов для магазинов
- Интеграции с платёжными системами
Начните с 👉 📦 Бизнес-процессов