ShopStory.live: техническая документация
ShopStory Side
1. Личный кабинет.
Личный кабинет доступен по ссылке: https://app.shopstory.live/login. Он предназначен для:
2. Мобильное приложение.
Мобильное приложение предназначено для проведения эфира. В личном кабинете доступны только предстоящие эфиры. Здесь нельзя редактировать эфиры и вносить какие-либо изменения в них.
3. Список эфиров.
4. Плеер эфира.
Плеер состоит из следующих элементов:
5. Мини-плеер.
код по адресу страницы или по элементам верстки пытается определить, если текущая страница — это карточка товара и какой артикул у этого товара. Если это карточка товара, мы ищем в нашей базе видео эфиры, в которых был указан данный товар. Если такой эфир найден, то мы его отображаем в миниплеере
Важно! При изменениях на сайте клиента интеграция может сломаться, и мини-плеер перестанет отображаться в карточках товаров.
Интеграция мини-плеера в карточку товара сайта.
На HTML страницу шаблона карточки товара необходимо добавить код SDK мини-плеера ShopStory для его инициализации после загрузки страницы.
6. Live - виджет (виджет активного эфира).
7. Stories - виджет.
Виджет на главной странице. В разработке.
E-comm Side
1. Интеграция эфиров на сайт.
2. Интеграция эфиров в мобильное приложение.
1. Личный кабинет.
Личный кабинет доступен по ссылке: https://app.shopstory.live/login. Он предназначен для:
- Заведения предстоящих эфиров, для удаления эфиров или их редактирования (редактировать можно только до того момента, как эфир начался);
- Для просмотра статистики после проведения эфира.
2. Мобильное приложение.
Мобильное приложение предназначено для проведения эфира. В личном кабинете доступны только предстоящие эфиры. Здесь нельзя редактировать эфиры и вносить какие-либо изменения в них.
3. Список эфиров.
- Список эфиров на странице состоит из двух разделов:
- Скоро в эфире - это запланированные эфиры, которые еще не проводились;
- Уже в эфире - это уже прошедшие эфиры или те, которые сейчас в live.
- Прошедшие эфиры можно отфильтровать по категориями (выбрать одну или несколько категорий)
4. Плеер эфира.
Плеер состоит из следующих элементов:
- Название эфира;
- Счетчик зрителей эфира в реальном времени;
- Карточки товаров с кнопкой купить. При коротком флоу - кнопка “купить” добавляет товар сразу в корзину, после чего зрителю остается только оформить заказ. При длинном флоу - кнопка “купить” отправляет зрителя в карточку товара, откуда он может добавить товар в корзину и оформить заказ;
- Комментарии. Чтобы оставить комментарий, достаточно ввести только свое имя.
- Лайки/ шеры
5. Мини-плеер.
- Мини-плеер появляется во всех карточках товаров, которые уже ранее участвовали в эфире.
- Из мини-плеера можно перейте в эфир непосредственно в момент обзора конкретного продукта.
- Мини-плеер можно разместить в любом месте страницы, при необходимости пользователь может его закрыть.
код по адресу страницы или по элементам верстки пытается определить, если текущая страница — это карточка товара и какой артикул у этого товара. Если это карточка товара, мы ищем в нашей базе видео эфиры, в которых был указан данный товар. Если такой эфир найден, то мы его отображаем в миниплеере
Важно! При изменениях на сайте клиента интеграция может сломаться, и мини-плеер перестанет отображаться в карточках товаров.
Интеграция мини-плеера в карточку товара сайта.
На HTML страницу шаблона карточки товара необходимо добавить код SDK мини-плеера ShopStory для его инициализации после загрузки страницы.
6. Live - виджет (виджет активного эфира).
- Виджет активного эфира появляется только во время live - эфира.
- Его можно разместить на конкретные страницы или на все страницы сайта.
- Пользователь может закрыть виджет или передвинуть в любое место на странице.
- Виджет не замедляет работу сайта.
7. Stories - виджет.
Виджет на главной странице. В разработке.
E-comm Side
1. Интеграция эфиров на сайт.
- Подготовьте страницу вида https://live.example.ru, на которой будет представлен раздел с эфирами, оставьте на ней ваш header и footer. Разместите код интеграции SDK ShopStory.live;
- В мобильной версии сайта удалите все лишние элементы интерфейса, чтобы иметь возможность вставить страницу в мобильное приложение в качестве компонента webview.
2. Интеграция эфиров в мобильное приложение.
- для отрисовки списка доступных эфиров (запланированных, прошедших, активных) необходимо получить данные по API;
- необходимо встроить sdk на вебсайт клиента или согласовать с нами персональную страницу на нашем домене;
- при открытии эфира необходимо открывать Webview со ссылкой на конкретный эфир;
- кнопка закрытия Webview с мобильным плеером должна быть реализована в мобильном приложении;
- информация о действиях клиента внутри webview передаётся родительскому приложению с помощью событий.
Общее описание ShopStory.live
Сообщите, пожалуйста, когда проинтегрируете SDK. После этого нам понадобится некоторое время для финальных настроек сервиса, парсинга фида с товарами и создания аккаунта. Мы сообщим, когда всё будет готово.