SPREEAI/desarrolladores/Documentación

Construido con
SPREEAI.

A practical path from integration choice to a tested launch. Start with one commerce journey, use issued test access and keep credentials out of browser code.

Guía PúblicaWeb SDK v2.1Actualizado el mes de agosto de 2026

Elegir el camino de integración

El caminoMejor paraPrimera acción
Aplicación de ShopifyGestión rápida de la configuración del StorefrontInstalar la app
SDK webWeb personalizada o sin cabezaLeer el guía SDK
iOS / AndroidAplicaciones de compras nativasElegir una guía nativa
API públicasFlujos de trabajo aprobados por el servidorReferencia abierta aprobada
Red de socios de AmazonIntegración del mercadoPróximamente
Seguridad de credencia. Examples use placeholders only. SPREEAI issues approved access during onboarding. Never publish a client secret, API key, token, private hostname or customer data.

Aplicación de Shopify

Use the managed app when the store runs on Shopify and does not need a custom backend. The current onboarding flow connects the store after agreements and subscription; it does not require copying API keys into the setup screen.

  1. Instalar el oficial SPREEAI Aplica y completa el flujo de consentimiento gestionado.
  2. Sínculo de un grupo de catálogo inicial y revisión de los estados de disponibilidad del producto.
  3. Personalizar la ubicación y el estilo en un tema duplicado.
  4. Validate eligible products, variants, mobile behavior and add-to-cart.
  5. Publicar sólo después de la marca y aprobación QA.

Abre la guía oficial de Shopify en el barco

Guía de inicio rápido del SDK web

Uso @ spreeai WEB SdK para el posicionamiento personalizado, el estilo, los eventos, el tamaño y el comportamiento de la cesta.

npm install @spreeai/web-sdk

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

const sdk = await init({
  clientId: "your-client-id",
  partnerId: "your-partner-id"
});

sdk.renderTryOnButton({
  selector: "#spreeai-try-on",
  productId: product.id,
  enableAddToCart: true
});

Initialize once, render only for an eligible product and connect documented client callbacks to your existing analytics. Confirm the current interface in the Web SDK API de referencia

Acceso a API

Use the public Swagger reference only for server-side workflows approved during onboarding. Keep secrets on your server, separate test and production access, and scope credentials to the minimum required environment.

Direct REST endpoints, webhooks or authentication behaviors not present in the approved public reference should be treated as unavailable until Partner Engineering confirms them.

Abre la referencia de API pública aprobada

El activo de la base

  • JPEG or PNG; 2,000 × 2,000 px minimum, with approximately 4K preferred.
  • One garment per image, centered with clean edges and neutral, even lighting.
  • Vista delantero requerida; vista delantero recomendada cuando se activa esa experiencia.
  • Stable SKU, style or garment ID included in the filename and catalogue record.
  • No hands, hangers, styling props, watermarks or unrelated garments blocking the item.
  • La variante de la mapeo se ha comprobado antes de permitir la experiencia.

QA y lanzamiento

  • Testar el viaje completo del cliente en los navegadores móviles y de escritorio actuales.
  • Verify product and variant mapping, garment readiness and cart behavior.
  • Verificar el acceso a la tecla, el orden de foco, los nombres accesibles y el comportamiento de fallback.
  • Medición del rendimiento de la página del producto antes y después de la SPREEAI.
  • Exercise loading, empty, unavailable, timeout and retry states.
  • Confirmar el lenguaje de consentimiento y la manipulación aprobada de la imagen del cliente.
  • Obtener ingeniería, comercio, QA y marca de firma antes de la producción.

Solución de problemas

El botón no aparece

Confirm SDK initialization, client and partner identifiers, the target selector, product eligibility, garment readiness and variant mapping. Then check browser console and network errors without sharing tokens.

El producto o variante equivocado aparece

Compare el producto de la tienda y los IDs de variante con los registros enviados a SPREEAI. Confirmar que la solicitud presentada cambia cuando el comprador cambia las variantes.

La experiencia es lenta o inaccesible

Test a known-ready product, verify the active environment, inspect blocked requests and compare a clean browser session. Capture a timestamp and reproducible sequence for support.

Obtener apoyo de desarrolladores

Correo electrónico support@spreeai.com con el entorno, producto o ID de vestido, navegador o vic e, el timestamp aproximado, el comportamiento esperado y los pasos de reproducción. No incluya secretos ni imágenes de clientes.

Elegir tu lenguaje.