Перейти к основному содержимому

Методы интеграции ShopStory

ShopStory предлагает два способа интеграции live-стримов на ваш сайт или в мобильное приложение. Выберите подход в зависимости от ваших потребностей.

🔀 Два метода интеграции​

1️⃣ Web SDK — Простое решение "копипаста"​

Для кого: Клиенты, которые хотят быстро внедрить стримы без программирования.

Время внедрения: 5-15 минут

Что включает:

  • ✅ Готовый список стримов (каталог)
  • ✅ Мини-плеер в карточках товаров
  • ✅ Live-виджет (всплывающий плеер)

Что нужно сделать:

  • Скопировать 2 строчки JavaScript кода на сайт
  • Всё работает из коробки

➡️ Перейти к гайду Web SDK

2️⃣ Public API — Кастомная разработка​

Для кого: Разработчики, которым нужен полный контроль над UI и интеграцией.

Время внедрения: 1-3 дня

Что включает:

  • ✅ REST API для получения данных о стримах
  • ✅ Полный контроль над дизайном и UX
  • ✅ Интеграция в мобильные приложения (iOS/Android)
  • ✅ Гибкая аутентификация: applicationId сейчас и Bearer токены после релиза
  • ✅ Кастомная фильтрация и пагинация

Что нужно сделать:

  • Написать код для запросов к API
  • Создать свой UI для отображения стримов
  • Настроить аутентификацию

➡️ Перейти к API Quickstart

📊 Сравнительная таблица​

КритерийWeb SDKPublic API
Сложность внедрения✅ Очень просто (копипаста)⚠️ Требует программирования
Время интеграции✅ 5-15 минут⚠️ 1-3 дня
Кастомизация UI⛔️ Ограничена✅ Полный контроль
Кастомная логика⛔️ Нет✅ Да
Аутентификация⛔️ Не требуется✅ applicationId (Bearer токены в пути)
Мобильные приложения⚠️ Только WebView✅ Нативная интеграция
Фильтрация и поиск⚠️ Базовая (встроенная)✅ Гибкая (кастомная)
Пагинация✅ Автоматическая✅ Кастомная (limit/offset)
Обновления✅ Автоматические⚠️ Требуют ручного обновления
Поддержка✅ Упрощённая✅ Полная техподдержка API

🎯 Как выбрать метод?​

Выбирайте Web SDK, если:​

  • ✅ Хотите быстро запустить стримы (за 15 минут)
  • ✅ Нет своей команды разработки
  • ✅ Устраивает готовый дизайн виджетов
  • ✅ Нужны только базовые функции (список стримов, мини-плеер, live-виджет)
  • ✅ Веб-сайт — основной канал продаж (мобильное приложение не критично)

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

"Мы хотим добавить стримы на сайт за 1 день, без привлечения разработчиков. Нам подходит готовый дизайн виджетов."

Выбирайте Public API, если:​

  • ✅ Нужен полный контроль над дизайном и UX
  • ✅ Есть команда разработки
  • ✅ Планируете интеграцию в мобильное приложение (iOS/Android)
  • ✅ Нужны кастомные фильтры, сортировка, поиск
  • ✅ Хотите встроить стримы в существующий UI (не отдельный раздел)
  • ✅ Требуется интеграция с вашей аналитикой или CRM

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

"Мы хотим отображать стримы на главной странице в нашем уникальном дизайне, а также в мобильном приложении. Нужна интеграция с нашей системой аналитики."

🚀 Комбинированный подход​

Вы можете использовать оба метода одновременно:

Сценарий 1: Web SDK для веб-сайта + API для мобильного приложения​

  • На веб-сайте используйте Web SDK (быстро и просто)
  • В мобильном приложении используйте Public API (нативный опыт)

Сценарий 2: Постепенная миграция​

  1. Старт: Внедрите Web SDK за 15 минут для тестирования
  2. Развитие: Если нужна кастомизация — мигрируйте на Public API
  3. Результат: Полный контроль + опыт работы с сервисом

📋 Что общего между методами?​

Независимо от метода интеграции, вам понадобится:

  1. Товарный фид

  2. Личный кабинет

  3. Мобильное приложение ShopStory

  4. Страница для стримов

    • URL вида https://example.ru/live или https://live.example.ru/

🔄 Миграция между методами​

С Web SDK на Public API​

Когда нужно:

  • Хотите больше контроля над UI
  • Планируете нативное мобильное приложение
  • Нужны сложные фильтры или кастомная логика

Как мигрировать:

  1. Изучите API Quickstart
  2. Получите applicationId (или API токен, если участвуете в бете)
  3. Интегрируйте API параллельно с Web SDK
  4. Постепенно заменяйте виджеты на кастомные компоненты

Совместимость: Оба метода могут работать параллельно без конфликтов.

С Public API на Web SDK​

Когда нужно:

  • Хотите упростить поддержку
  • Готовый дизайн виджетов стал подходить
  • Сокращаете команду разработки

Как мигрировать:

  1. Добавьте код Web SDK на страницы
  2. Удалите кастомный код API интеграции
  3. Проверьте, что виджеты отображаются корректно

🛠️ Техническая документация​

Для Web SDK​

РазделОписание
Web SDK GuideПолное руководство по Web SDK
Feed RequirementsТребования к товарному фиду

Для Public API​

РазделОписание
API QuickstartПервые запросы к API
AuthenticationТекущий метод + план перехода на токены
Catalog StreamsПолучение списка стримов
Mini-PlayerDeep links и мини-плеер
ArchitectureФормат ответов и версионность
Rate LimitsЛимиты и retry стратегии
SecurityЛучшие практики безопасности

💬 Нужна помощь с выбором?​

Не уверены, какой метод выбрать? Свяжитесь с нами:

  • Email: support@shopstory.live
  • Telegram: Партнёрская группа (добавление по приглашению от менеджера)

Мы поможем выбрать оптимальное решение для вашего бизнеса!

✅ Чек-лист выбора метода​

Web SDK ✅​

  • Хочу запустить стримы за 1 день
  • Нет команды разработки или ограничен бюджет
  • Устраивает готовый дизайн
  • Основной канал — веб-сайт
  • Не планирую сложную кастомизацию

Результат: Если отметили 3+ пункта → используйте Web SDK

Public API ✅​

  • Нужен полный контроль над UI
  • Есть команда разработки
  • Планирую нативное мобильное приложение
  • Нужны кастомные фильтры и сортировка
  • Требуется интеграция с аналитикой/CRM

Результат: Если отметили 3+ пункта → используйте Public API

🎯 Быстрый старт​

Выбрали Web SDK?​

  1. Прочитайте Web SDK Guide
  2. Скопируйте код на сайт
  3. Отправьте ссылку на товарный фид
  4. Готово! 🎉

Выбрали Public API?​

  1. Получите API токен у менеджера
  2. Прочитайте Quickstart
  3. Изучите Authentication Guide
  4. Интегрируйте /v3/streams endpoint
  5. Готово! 🎉

Удачной интеграции! 🚀

Последнее обновление