Как подключить ShopStory
Web SDK, Mobile SDK и Public API для live-эфиров, записей и действий с товаром. Здесь собраны требования к фиду, контракты интеграции и production-проверки.
До установки ShopStory регистрирует проект, выдаёт applicationId и тестовые данные. API корзины, stock API и точные версии mobile-пакетов фиксируются в integration handoff проекта.
curl --get \
https://app.shopstory.live/v3/streams \
--data-urlencode \
"applicationId=assigned-application-id"body.availableStreams[]Три варианта интеграции
Web SDK
Web SDK добавляет на сайт каталог эфиров, плеер и виджеты ShopStory. До установки ShopStory регистрирует домены, товарный идентификатор и конфигурацию проекта.
- Интерфейс и обновления плеера поддерживает ShopStory
- Клиент размещает скрипты и проверяет интеграцию на своём сайте
Public API
Public API отдаёт данные об эфирах и записях для собственного UI. API работает только на чтение; клиентская команда отвечает за запросы, загрузку, ошибки и интерфейс.
- Для запросов нужен applicationId, выданный ShopStory
- Доступ из браузера требует регистрации origin
Mobile SDK
Mobile SDK добавляет product video, полный плеер и follow-me в native iOS или Flutter-приложение на iOS. PDP, навигация, авторизация и корзина остаются в приложении клиента.
- Один feedProductId связывает mobile-каталог, live и записи
- Integration handoff указывает пакет, версию и checklist приёмки
Как проходит подключение
Выбрать метод
Определить, где нужен готовый UI ShopStory, собственный интерфейс или native player.
Согласовать конфигурацию
Согласовать фид или товарный API, ключ товара и целевые поверхности; для web также передать домены.
Подключить SDK или API
Обработать документированные ответы, пустые состояния и ошибки выбранного метода.
Пройти приёмку
Проверить тестовый товар, live и запись, покупательское действие, CSP и поведение при сбое.
Web SDK, Public API и Mobile SDK
| Критерий | Web SDK | Public API | Mobile SDK |
|---|---|---|---|
| Интерфейс | Готовые компоненты ShopStory | Проектирует и поддерживает клиент | SDK-компоненты внутри native host app |
| Настройка ShopStory | Домены, тема, источник товаров и mini-player | applicationId и согласованные origins | applicationId, package access и runtime policy |
| Обработка ошибок | Ошибки плеера и виджетов обрабатывает SDK | Реализуется клиентом по API-контракту | SDK скрывает свои компоненты при сбое; host app продолжает работать |
| Commerce-действия | Переход к товару или согласованный callback | Реализует клиент | Native product route или cart handler клиента |
| Поставка | Production script URL | Публичный read-only HTTP contract | Точная версия пакета из integration handoff |
Материалы для внедрения
Порядок чтения
Справочные материалы
Что публикуется и куда писать
Куда обращаться
Доступные материалы
- Контракты Web SDK, Mobile SDK и Public API, требования к фиду и примеры запросов без учётных данных.
- Доступ к mobile-пакетам, точные версии, клиентские схемы данных, SLA и API ритейлера передаются отдельно.
- Работа в кабинете и проведение эфира описаны в центре помощи.