<!-- Canonical: https://docs.shopstory.live/ -->

Integration docs

# Как подключить ShopStory

Web SDK, Mobile SDK и Public API для live-эфиров, записей и действий с товаром. Здесь собраны требования к фиду, контракты интеграции и production-проверки.

[Выбрать метод](<https://docs.shopstory.live/docs/guide/integration-methods>)[Public API Quickstart](<https://docs.shopstory.live/docs/guide/quickstart>)

До установки ShopStory регистрирует проект, выдаёт `applicationId` и тестовые данные. API корзины, stock API и точные версии mobile-пакетов фиксируются в integration handoff проекта.

Public APIread only

```
curl --get \
  https://app.shopstory.live/v3/streams \
  --data-urlencode \
  "applicationId=assigned-application-id"
```

HTTP 200

`body.availableStreams[]`

[Разобрать ответ и ошибки](<https://docs.shopstory.live/docs/guide/quickstart>)

Способ подключения

Три варианта интеграции

[Готовые интерфейсы

Web SDK

Web SDK добавляет на сайт каталог эфиров, плеер и виджеты ShopStory. До установки ShopStory регистрирует домены, товарный идентификатор и конфигурацию проекта.

- Интерфейс и обновления плеера поддерживает ShopStory
- Клиент размещает скрипты и проверяет интеграцию на своём сайте](<https://docs.shopstory.live/docs/guide/web-sdk>)[Собственный интерфейс

Public API

Public API отдаёт данные об эфирах и записях для собственного UI. API работает только на чтение; клиентская команда отвечает за запросы, загрузку, ошибки и интерфейс.

- Для запросов нужен applicationId, выданный ShopStory
- Доступ из браузера требует регистрации origin](<https://docs.shopstory.live/docs/guide/quickstart>)[Приложение ритейлера

Mobile SDK

Mobile SDK добавляет product video, полный плеер и follow-me в native iOS или Flutter-приложение на iOS. PDP, навигация, авторизация и корзина остаются в приложении клиента.

- Один feedProductId связывает mobile-каталог, live и записи
- Integration handoff указывает пакет, версию и checklist приёмки](<https://docs.shopstory.live/docs/guide/mobile-sdk>)

Порядок работы

## Как проходит подключение

1. ### Выбрать метод

  Определить, где нужен готовый UI ShopStory, собственный интерфейс или native player.
2. ### Согласовать конфигурацию

  Согласовать фид или товарный API, ключ товара и целевые поверхности; для web также передать домены.
3. ### Подключить SDK или API

  Обработать документированные ответы, пустые состояния и ошибки выбранного метода.
4. ### Пройти приёмку

  Проверить тестовый товар, live и запись, покупательское действие, CSP и поведение при сбое.

Входные данные

### Что подготовить до подключения

- Точные production- и test-домены для web-интеграции
- Товарный фид или API и стабильный идентификатор товара
- Страницы, где должны работать каталог, плеер и mini-player
- Требуемое действие кнопки «Купить»
- Ответственные за web, mobile и приёмку

Фид или товарный API**feedProductId**Web SDK · Mobile SDK · Public API**product action**PDP · cart · актуальный остаток

Граница ответственности

## 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 |

Навигация

## Материалы для внедрения

Руководство

### Порядок чтения

- [Выбор метода интеграции](<https://docs.shopstory.live/docs/guide/integration-methods>)
- [Подготовка товарного фида](<https://docs.shopstory.live/docs/guide/feed-requirements>)
- [Подключение Web SDK](<https://docs.shopstory.live/docs/guide/web-sdk>)
- [Подключение Mobile SDK](<https://docs.shopstory.live/docs/guide/mobile-sdk>)
- [Public API Quickstart](<https://docs.shopstory.live/docs/guide/quickstart>)
- [Интеграция с интернет-магазином](<https://docs.shopstory.live/docs/guide/custom-commerce-integrations>)

Контракты API

### Справочные материалы

- [Формат ответов](<https://docs.shopstory.live/docs/guide/architecture>)
- [Каталог эфиров](<https://docs.shopstory.live/docs/guide/catalog-streams>)
- [Mini-player API](<https://docs.shopstory.live/docs/guide/mini-player>)
- [OpenAPI](<https://docs.shopstory.live/docs/reference/openapi>)
- [Инструменты и примеры](<https://docs.shopstory.live/docs/resources/tooling>)

Ответственность

## Что публикуется и куда писать

Поддержка интеграции

### Куда обращаться

- [Команда внедрения ShopStory](<https://shopstory.live/contact>)
- [support@shopstory.live](<mailto:support@shopstory.live>)
- [Центр помощи по работе с продуктом](<https://shopstory.live/help>)

Публичный портал

### Доступные материалы

- Контракты Web SDK, Mobile SDK и Public API, требования к фиду и примеры запросов без учётных данных.
- Доступ к mobile-пакетам, точные версии, клиентские схемы данных, SLA и API ритейлера передаются отдельно.
- Работа в кабинете и проведение эфира описаны в центре помощи.