Добро пожаловать в документацию ShopStory
ShopStory помогает брендам запускать живые и записанные стримы, встраивать мини‑плееры и использовать данные о трансляциях в собственных цифровых продуктах.
🚀 Два способа интеграции
ShopStory предлагает два метода интеграции — выберите тот, который подходит вашему проекту:
Web SDK — Простая интеграция
Быстрая интеграция за 5-15 минут без команды разработчиков. Готовый дизайн и простая настройка.
Public API — Полный контроль
Кастомная разработка с полным контролем над UI. Идеально для разработчиков с уникальными требованиями.
См. Сравнение методов интеграции для детального сравнения.
✨ Ключевые возможности
Live-трансляции
Запускайте живые стримы с интерактивной демонстрацией товаров и общением с аудиторией в реальном времени.
Записанные стримы
Создавайте библиотеку записанных видео для постоянного доступа и повторного просмотра.
Интеграция с каталогом
Привязывайте товары к стримам через XML/YML фид для удобных покупок прямо во время просмотра.
Мини-плеер
Встраивайте компактный плеер в карточки товаров для быстрого просмотра связанных стримов.
📚 Структура документации
Начало работы
- Методы интеграции — сравнение Web SDK vs Public API
- Требования к товарному фиду — XML/YML фид для отображения товаров
Web SDK (Простая интеграция)
- Web SDK Guide — полный гайд по интеграции виджетов
Public API (Кастомная интеграция)
- Quickstart — первые запросы к API с
applicationId - Аутентификация — текущий метод и план перехода на Bearer токены
- Архитектура — формат ответов, версионность, правила
- Каталог стримов —
GET /v3/streamsи модели данных - Мини‑плеер — deep links и быстрый статус
- Deep links — генерация ссылок для web и мобильных приложений
Операции и безопасность
- Rate Limits — лимиты запросов и retry стратегии
- Безопасность — лучшие практики
- Кэширование — повышение производительности
Дополнительно
- API Reference — OpenAPI спецификация, Postman коллекция
- Инструменты — утилиты и Changelog
- FAQ — частые вопросы
📦 Что общего для всех интеграций
Независимо от выбранного метода (Web SDK или API), вам понадобится:
- Товарный фид — XML/YML фид с товарами (требования)
- Личный кабинет — для создания стримов (app.shopstory.live)
- Мобильное приложение ShopStory — для проведения live-трансляций (App Store)
- Страница для стримов — URL вида
https://example.ru/live
Для Public API дополнительно:
- applicationId — уникальный идентификатор вашего магазина (Bearer токены пока в бете)
- HTTPS доступ к
https://app.shopstory.live(CORS настроен) - Обработка JSON-конверта — формат
{ status, serverTime, body }
Полезные маршруты
| Раздел | Когда обращаться |
|---|---|
GET /v3/streams | Нужен каталог трансляций с привязкой к товарам и категориям |
GET /v2/mini-player/stream | Нужна кнопка «Посмотреть стрим» в карточке товара |
GET /v3/translation/quick-state | Требуется узнать, что трансляция перешла в online/offline |
GET /v2/mini-player/online | Нужно вывести любой live стрим для виджета |
Куда писать за поддержкой
- Email: support@shopstory.live
- Telegram: партнёрская группа (добавление по приглашению от менеджера)
- Статус платформы: /status