Обзор интеграции ShopStory

ShopStory подключается через Web SDK, Public API или Mobile SDK. Перед разработкой команда ShopStory выдаёт applicationId, проверяет товарный фид и подтверждает компоненты проекта. Для Web SDK и browser-side Public API команда также регистрирует домены и origins.

Точные версии mobile-пакетов, клиентские схемы корзины и остатков и релизные параметры доступны участникам конкретного проекта. Договорные условия фиксируются отдельно.

1. Выберите метод​

Задача	Метод
Встроить готовые каталог, плеер и виджеты на сайт	Web SDK
Построить собственный интерфейс списка эфиров и записей	Public API
Встроить live, записи и product video в нативное приложение	Mobile SDK
Использовать разные методы на разных поверхностях	Согласованная комбинация SDK и API
Подключить прямую корзину через callback сайта	Добавление в корзину
Подключить отдельный stock API или нестандартный merchant API	Кастомная commerce-интеграция

Подробное сравнение: Методы интеграции.

2. Подготовьте конфигурацию​

До разработки передайте команде ShopStory:

• production- и test-домены для web-интеграции;
• ссылку на товарный фид и способ доступа к нему;
• одно строковое значение feedProductId, которое без преобразований связывает фид, сайт, приложение и действия с товаром;
• страницы для каталога, плеера и mini-player;
• требуемое поведение кнопки «Купить»;
• ответственных за техническую интеграцию и приёмку.

Начните с требований к товарному фиду. Точные applicationId, origins и тестовые данные ShopStory передаёт в integration handoff проекта.

3. Подключите выбранный метод​

Web SDK​

1. Получите подтверждение конфигурации доменов и проекта.
2. Создайте страницу каталога и подключите SDK.
3. При необходимости подключите mini-player к согласованным товарным страницам.
4. Настройте CSP и проверьте тестовый товар, live и запись.

Инструкция: Web SDK.

Public API​

1. Получите applicationId.
2. Выполните первый запрос из терминала или с сервера клиента.
3. Реализуйте проверку HTTP-кода и status в JSON-конверте.
4. Добавьте состояния загрузки, отсутствия данных и ошибок.

После Quickstart проверьте формат ответов, каталог эфиров и Mini-player API.

Mobile SDK​

1. Подтвердите mobile stack и получите точную версию пакета в integration handoff.
2. Передавайте на native PDP тот же строковый feedProductId, что и в товарном фиде.
3. Подключите product action к существующему native router. Если проекту нужна прямая корзина, отдельно подключите cart-команду приложения.
4. Проверьте live, VOD, отсутствие контента, lifecycle, сетевую ошибку и откат версии.

Инструкция: Mobile SDK.

4. Зафиксируйте commerce-поведение​

• Стандартный сценарий на web открывает URL товара, а в Mobile SDK — native PDP.
• На web прямое добавление использует callback сайта и сообщает об успехе после фактического изменения корзины. Mobile SDK передаёт типизированное действие приложению; native host открывает PDP или выполняет свою cart-команду по выбранному контракту.
• Cart-команда ритейлера проверяет остаток перед изменением корзины. Отдельный stock API, вызываемый ShopStory до cart-команды, относится к кастомной интеграции.

Разделы: Добавление в корзину и Кастомные commerce-интеграции.

5. Проверьте запуск​

Перед production проверьте web-интеграцию на домене клиента и Mobile SDK в принятой Release-сборке приложения:

• контент относится к правильному проекту;
• один и тот же строковый feedProductId используется в фиде, на PDP и в product action;
• live и запись открываются в целевых браузерах и принятых mobile-сборках;
• пустое состояние не ломает страницу;
• web callback показывает результат, полученный от commerce-системы;
• в mobile-приложении product action передаётся native router или cart handler, а успех показывает интерфейс приложения после ответа commerce-системы;
• CSP разрешает необходимые ресурсы ShopStory;
• ошибки ShopStory не блокируют каталог, карточку товара или checkout клиента.

После этого используйте разделы Эксплуатация, OpenAPI и FAQ.

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

Передайте URL страницы, applicationId, время возникновения проблемы, браузер или платформу и фрагмент ответа без cookies, токенов и персональных данных на support@shopstory.live. Не отправляйте пароли, session cookies и production-токены.