SPREEAI/Разработчики/Документация

Стройте с
SPREEAI.

Практический путь от выбора интеграции до тестируемого запуска. Начните с одного коммерческого пути, используйте выданный тестовый доступ и не допускайте попадания учетных данных в код браузера.

Публичный гидWeb SDK v3.0.0Обновлено в октябре 2026 года.

Выберите путь интеграции

ПутьЛучшее дляПервое действие
Приложение ShopifyБыстрая управляемая настройка витриныУстановите приложение
Веб-SDKПользовательская или безголовая сетьОзнакомьтесь с руководством по SDK.
iOS / AndroidНативные приложения для покупокВыберите родного гида
Общедоступные APIУтвержденные рабочие процессы на стороне сервераОткрыть утвержденную рекомендацию
Партнерская сеть AmazonИнтеграция с маркетплейсомСкоро
Безопасность учетных данных. В примерах используются только заполнители. SPREEAI выдает одобренный доступ во время регистрации. Никогда не публикуйте секрет клиента, ключ API, токен, частное имя хоста или данные клиента.

Приложение Shopify

Используйте управляемое приложение, если магазин работает на Shopify и не требует пользовательского бэкэнда. Текущий процесс подключения подключает магазин после заключения соглашений и оформления подписки; он не требует копирования ключей API на экран настройки.

  1. Установите официальное приложение SPREEAI и завершите процесс управления согласием.
  2. Синхронизируйте начальную группу каталога и проверьте состояние готовности продукта.
  3. Настройте размещение и стиль в дублированной теме.
  4. Проверьте соответствие товаров и вариантов, историю использования мобильных устройств и добавление товара в корзину.
  5. Публиковать только после одобрения брендом и отделом контроля качества.

Откройте официальное руководство по регистрации в Shopify

Быстрый старт Web SDK

Использовать @spreeai/web-sdk для индивидуального размещения, оформления, мероприятий, размеров и поведения корзины.

npm install @spreeai/web-sdk@3.0.0

import { init } from "@spreeai/web-sdk";
import "@spreeai/web-sdk/dist/web-sdk.css";

// Add <div id="spreeai-try-on"></div> to the product page first.
const sdk = await init({ clientId: "your-client-id" });

if (sdk) {
  await sdk.renderTryOnButton({
    elementId: "spreeai-try-on",
    garments: [{ garmentId: "your-garment-id" }],
    enableAddToCart: true,
  });
}

Инициализируйте один раз, отображайте только для подходящего продукта и подключите документированные обратные вызовы клиента к вашей существующей аналитике. Подтвердите текущий интерфейс в официальный справочник API Web SDK

Доступ через API

Используйте общедоступный справочник Swagger только для серверных рабочих процессов, одобренных во время адаптации. Храните секреты на своем сервере, разделяйте доступ для тестирования и производства, а также ограничивайте учетные данные минимально необходимой средой.

Конечные точки Direct REST, веб-перехватчики или способы аутентификации, отсутствующие в утвержденной общедоступной ссылке, должны рассматриваться как недоступные до тех пор, пока их не подтвердит Partner Engineering.

Откройте утвержденную общедоступную справочную информацию по API.

Базовый уровень активов швейной промышленности

  • JPEG или PNG; минимальное разрешение 2000 × 2000 пикселей, предпочтительно около 4K.
  • На каждом изображении — один предмет одежды, расположенный по центру, с четкими краями и нейтральным, равномерным освещением.
  • Требуется вид спереди; при включении этой функции рекомендуется вид сзади.
  • В имя файла и запись в каталоге включается стабильный артикул, идентификатор модели или изделия.
  • Не допускайте попадания на вещь рук, вешалок, реквизита для укладки, водяных пятен или посторонних предметов одежды, закрывающих изображение.
  • Проверка соответствия вариантов выполняется перед включением функции.

Контроль качества и запуск

  • Протестируйте весь пользовательский опыт на современных мобильных и настольных браузерах.
  • Проверьте соответствие товаров и вариантов, готовность одежды и поведение корзины.
  • Проверьте доступ к клавиатуре, порядок фокуса, доступные имена и резервное поведение.
  • Проведите оценку производительности страницы товара до и после включения SPREEAI.
  • Состояния загрузки тренировки, пусто, недоступно, тайм-аут и повторная попытка.
  • Подтвердите формулировку согласия и одобренное обращение с изображениями клиентов.
  • Перед началом производства необходимо получить одобрение инженерных, коммерческих, контрольно-качественных и брендовых отделов.

Поиск неисправностей

Кнопка не отображается

Подтвердите инициализацию SDK, идентификатор клиента, идентификатор хост-элемента, соответствие продукта требованиям, готовность одежды и сопоставление вариантов. Затем проверьте консоль браузера и сетевые ошибки, не делясь токенами.

Отображается не тот товар или вариант.

Сравните идентификаторы продуктов и вариантов витрины с записями, отправленными на SPREEAI. Убедитесь, что отображаемый запрос меняется, когда покупатель меняет варианты.

Работает медленно или недоступно.

Протестируйте заведомо готовый продукт, проверьте активную среду, изучите заблокированные запросы и сравните с чистой сессией браузера. Зафиксируйте метку времени и воспроизводимую последовательность действий для службы поддержки.

Получите поддержку разработчиков

электронная почта support@spreeai.com Укажите среду, идентификатор продукта или одежды, браузер или устройство, приблизительную метку времени, ожидаемое поведение и этапы воспроизведения. Не включайте секретную информацию или изображения клиентов.

Документация

Выберите свой язык.