Методы интеграции ShopStory
ShopStory поддерживает два рабочих сценария:
- SDK-путь: быстрый запуск виджетов без ручной API-интеграции.
- API-путь: кастомный UI и собственная бизнес-логика поверх Public API.
1) SDK-путь (копипаст, основной для новых клиентов)
Когда выбирать:
- нужен быстрый запуск без долгой разработки;
- достаточно готовых виджетов;
- приоритет — time-to-market.
Что происходит технически:
- список стримов подключается через
shopstory-sdk; - mini-player и live-widget подключаются скриптом
shopstory-pip; - отдельная ручная интеграция
/v2/mini-player/*для базового SDK-сценария не обязательна.
Ключевой факт:
- один скрипт
shopstory-pipподнимает сразу два виджета; - live-widget показывается только во время live;
- mini-player показывается в карточке товара, если для товара есть стрим/запись;
- скрипт можно размещать на большинстве страниц сайта (рекомендация: исключать cart/checkout);
- один из виджетов можно отключить через менеджера/поддержку.
Маршрут: Web SDK.
2) API-путь (кастомная интеграция)
Когда выбирать:
- нужен полный контроль над UI/UX;
- есть собственные требования к фильтрации, выдаче, аналитике;
- нужен единый нативный опыт в мобильном приложении.
Что реализует команда:
- запросы к
/v3/streamsдля каталога; - сценарии mini-player/live на своей стороне через
/v2/mini-player/*и/илиquick-state; - обработку конверта ответа
{ status, serverTime, body }; - безопасную серверную прокладку для
applicationId.
Маршрут: Quickstart → Architecture → Catalog Streams.
Сравнение
| Критерий | SDK-путь | API-путь |
|---|---|---|
| Срок запуска | 5-15 минут | 1-3 дня и более |
| Ручные API-запросы на старте | Не обязательны | Обязательны |
| Контроль над UI | Ограниченный | Полный |
| Mobile WebView сценарий | Готовый URL + bridge | Реализуете логику сами |
| Поддержка mini-player/live-widget | Из коробки | Через ваш код |
| Риск внедрения | Ниже | Выше |
Общие зависимости для обоих путей
- товарный фид XML/YML: Feed Requirements;
- рабочий кабинет ShopStory: app.shopstory.live;
- мобильное приложение для запуска live.
Мобильное приложение
Плеер стрима всегда работает через WebView — нативного SDK для плеера нет. Для мобильного приложения есть два варианта:
| Вариант A: Всё через WebView | Вариант B: Нативный список + WebView плеер | |
|---|---|---|
| Список стримов | WebView (ShopStory рисует) | Нативный UI (ваш код + API) |
| Плеер стрима | WebView | WebView |
| Контроль над UI | Минимальный | Полный |
| Объём работы | Минимальный | Средний |
Подробная инструкция по настройке WebView, bridge-событий и обработке покупок: Мобильное приложение (WebView).
Порядок принятия решения
- Если цель — запуститься быстро и без кастомной верстки: SDK-путь.
- Если цель — собственный интерфейс и сложная логика: API-путь.
- Если веб и mobile требуют разной глубины: комбинируйте (SDK для web, API/bridge для mobile).