📖 Документация StoreCRM

Полная справка по API, интеграциям и развёртыванию платформы управления товарами

Оглавление

📋 Обзор платформы

StoreCRM — это модульная, open-source CRM-платформа для управления товарами, остатками и контрагентами в e-commerce и розничной торговле. Платформа предоставляет три основных интерфейса доступа:

🚀 Быстрый старт

Начните с платформой за 5 минут

  • Установка и настройка
  • Первое подключение
  • Создание товара
Читать →

🔗 REST API

Интеграция с вашими системами

  • Эндпоинты API
  • Примеры запросов
  • Коды ошибок
Документация →

💬 Telegram

Управление через Telegram-бот

  • Команды бота
  • Сценарии использования
  • Примеры
Подробнее →

🚀 Начало работы

Требования

Установка

# Репозиторий приватный — доступ по запросу: hello@ecomdev.uz git clone git@github.com:Ecomdev-Labs/store-crm-uz.git # Установить зависимости composer install # Скопировать .env и настроить cp .env.example .env # Выполнить миграции php bootstrap.php migrate # Запустить сервер php -S localhost:8080

Первые шаги

  1. Откройте http://localhost:8080
  2. Создайте первого пользователя
  3. Добавьте товар через админ-панель
  4. Настройте Telegram-бот (опционально)

🔗 REST API

StoreCRM предоставляет полнофункциональный REST API для интеграции с внешними системами.

Базовые эндпоинты

GET /api/v1/products — Список товаров
POST /api/v1/products — Создать товар
GET /api/v1/inventory — Остатки на складах
POST /api/v1/inventory/movement — Движение товара
GET /api/v1/users — Список пользователей
GET /api/v1/reports — Отчёты и аналитика

Пример запроса

curl -X GET https://api.store-crm.uz/v1/products \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" // Ответ: { "data": [ { "id": 1, "name": "Товар 1", "sku": "SKU001", "price": 1000, "quantity": 50 } ], "meta": { "total": 1, "page": 1, "per_page": 20 } }

Аутентификация

Все запросы должны содержать заголовок авторизации:

Authorization: Bearer API_KEY_YOUR_TOKEN_HERE

💬 Telegram интеграция

Управляйте товарами и остатками прямо из Telegram

Основные команды

/start — Начать работу с ботом /product [ID] — Информация о товаре /inventory — Остатки на всех складах /add_product — Добавить новый товар /report — Дневной отчёт продаж /help — Справка по командам

Примеры использования

Добавление товара:

/add_product → Введите название: Смартфон XYZ → Введите цену: 5000 → Введите количество: 10 → ✅ Товар успешно добавлен

🏗️ Модули платформы

StoreCRM состоит из модульной архитектуры, которая позволяет использовать только необходимые компоненты:

Identity & Access

Управление пользователями, ролями и правами доступа

Catalog

Каталог товаров, артикулы, цены и классификация

Inventory

Управление остатками, складами и движением товара

Integration

Telegram-бот, REST API, webhooks и внешние системы

CRM (планируется)

Клиенты, контакты и история взаимодействий

Sales (планируется)

Сделки, задачи и воронки продаж

🚀 Развёртывание на продакшн

На собственном сервере

  1. Поднять VPS/выделенный сервер (Linux рекомендуется)
  2. Установить PHP 8.1, MySQL, Nginx
  3. Клонировать репозиторий в /var/www/store-crm
  4. Настроить .env с параметрами БД
  5. Запустить миграции: composer migrate
  6. Настроить SSL сертификат (Let's Encrypt)
  7. Настроить Telegram webhook

На Docker

docker run -e DB_HOST=mysql -e DB_USER=crm ecomdev/store-crm:latest

❓ Поддержка и помощь

Способы получить помощь

Часто задаваемые вопросы

Как интегрировать с 1С?

Через REST API используя встроенные скрипты синхронизации. Примеры кода доступны в репозитории.

Какие платежные системы поддерживаются?

Можно подключить любую систему через API. Встроенная поддержка Stripe, PayPal и Uzcard.

Могу ли я использовать платформу в production?

Да! StoreCRM используется в production и полностью готов к использованию. Лицензия MIT позволяет коммерческое использование.

Готовы начать?

Прочитайте гайд по быстрому старту или свяжитесь с нами

Полный README →