Добро пожаловать в документацию ShopStory

Документация разделена на два рабочих маршрута:

1. SDK-путь — быстрый запуск без ручной API-интеграции.
2. API-путь — кастомный интерфейс и серверная логика поверх Public API.

Быстрый выбор пути

Открыть выбор методаПерейти в Web SDKПерейти в API Quickstart

Навигация по документации

Шаг 1. Выбор стратегии

• Методы интеграции — короткое сравнение SDK и API.
• Требования к фиду — обязательная база для обоих путей.

Шаг 2A. SDK-маршрут (для быстрого запуска)

• Web SDK — список стримов, mini-player, live-widget.
• Deep links — WebView URL и mobile bridge.

Шаг 2B. API-маршрут (для кастомной интеграции)

• Quickstart — первые рабочие запросы.
• Architecture — envelope и обработка ошибок.
• Catalog Streams — GET /v3/streams.
• Mini-player — /v2/mini-player/* и quick-state.

Шаг 3. Эксплуатация и reference

• Rate limits
• Caching
• Security
• OpenAPI
• Инструменты
• FAQ

Mobile/WebView контракт

Базовый URL:

https://<client-domain>/live/?wv=1#/translation/<translationId>

Для устройств с вырезом:

https://<client-domain>/live/?wv=1&safe_area=1#/translation/<translationId>

Bridge-события в нативный слой: add-product и open-product.

Поддержка

• Email: support@shopstory.live
• Статус платформы: /status

Стартовые ссылки

Web SDKAPI QuickstartSDK vs API