SPREEAI/sviluppatori/Documentazione

Costruisci con
SPREEAI.

Un percorso pratico dalla scelta dell'integrazione al lancio testato. Inizia con un percorso di e-commerce, utilizza l'accesso di prova fornito e mantieni le credenziali fuori dal codice del browser.

Guida pubblicaSDK Web v3.0.0Aggiornato a ottobre 2026

Scegliere il percorso di integrazione

SentieroIdeale perPrima azione
Shopify AppConfigurazione rapida e gestita del negozio onlineInstalla l'app
SDK WebSito web personalizzato o headlessLeggi la guida dell'SDK
iOS / AndroidApp di shopping nativeScegli una guida locale
API pubblicheFlussi di lavoro lato server approvatiRiferimento aperto approvato
Rete di partner AmazonIntegrazione con il marketplaceProssimamente
Sicurezza delle credenziali. Gli esempi utilizzano solo segnaposto. SPREEAI rilascia l'accesso approvato durante l'onboarding. Non pubblicare mai un segreto client, una chiave API, un token, un nome host privato o dati del cliente.

Shopify App

Utilizza l'app gestita quando il negozio è in esecuzione su Shopify e non necessita di un backend personalizzato. Il flusso di onboarding attuale connette il negozio dopo la stipula dei contratti e la sottoscrizione dell'abbonamento; non richiede la copia delle chiavi API nella schermata di configurazione.

  1. Installa l'app ufficiale SPREEAI e completa la procedura di consenso gestito.
  2. Sincronizza un gruppo di catalogo iniziale e rivedi lo stato di disponibilità del prodotto.
  3. Personalizza il posizionamento e lo stile in un tema duplicato.
  4. Convalida i prodotti idonei, le varianti, il comportamento su dispositivi mobili e l'aggiunta al carrello.
  5. Pubblicare solo dopo l'approvazione del marchio e del controllo qualità.

Apri la guida ufficiale di onboarding Shopify

Guida rapida all'SDK Web

Utilizzo @spreeai/web-sdk per posizionamento personalizzato, stile, eventi, dimensioni e comportamento del carrello.

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,
  });
}

Inizializza una volta, esegui il rendering solo per un prodotto idoneo e collega le callback client documentate alle tue analisi esistenti. Conferma l'interfaccia corrente nel Riferimento ufficiale all'API Web SDK

Accesso API

Utilizzate la documentazione pubblica di Swagger solo per i flussi di lavoro lato server approvati durante la fase di onboarding. Conservate i segreti sul vostro server, separate l'accesso agli ambienti di test e di produzione e limitate le credenziali al minimo indispensabile per l'ambiente.

Gli endpoint REST diretti, i webhook o i comportamenti di autenticazione non presenti nel riferimento pubblico approvato devono essere considerati non disponibili fino a quando il team di Partner Engineering non ne confermerà la disponibilità.

Apri il riferimento API pubblico approvato

Baseline degli asset di abbigliamento

  • JPEG o PNG; minimo 2.000 × 2.000 px, preferibilmente circa 4K.
  • Un capo per immagine, centrato con bordi netti e illuminazione neutra e uniforme.
  • È necessaria la visualizzazione frontale; la visualizzazione posteriore è consigliata quando questa opzione è abilitata.
  • Codice SKU stabile, modello o ID del capo inclusi nel nome del file e nella registrazione del catalogo.
  • Nessuna mano, gruccia, accessorio di stile, filigrana o indumento non pertinente che copra l'articolo.
  • Mappatura delle varianti verificata prima di abilitare l'esperienza.

Controllo qualità e lancio

  • Testa l'intero percorso del cliente sui browser desktop e mobile attualmente in uso.
  • Verificare la mappatura di prodotti e varianti, la predisposizione del capo e il comportamento del carrello.
  • Verifica l'accesso da tastiera, l'ordine di messa a fuoco, i nomi accessibili e il comportamento di fallback.
  • Misura le prestazioni della pagina prodotto prima e dopo l'attivazione di SPREEAI.
  • Esercizio: stati di caricamento, vuoto, non disponibile, timeout e riprova.
  • Confermare la lingua del consenso e l'autorizzazione al trattamento delle immagini dei clienti.
  • Ottenere l'approvazione da parte dei reparti di ingegneria, commercio, controllo qualità e marchio prima della produzione.

Risoluzione dei problemi

Il pulsante non appare

Conferma l'inizializzazione dell'SDK, l'identificativo del client, l'ID dell'elemento host, l'idoneità del prodotto, la predisposizione del capo e la mappatura delle varianti. Quindi controlla la console del browser e gli errori di rete senza condividere i token.

Viene visualizzato il prodotto o la variante sbagliata

Confronta gli ID prodotto e variante del negozio con i record inviati a SPREEAI. Verifica che la richiesta visualizzata cambi quando l'acquirente modifica le varianti.

L'esperienza è lenta o non disponibile

Testa un prodotto già collaudato, verifica l'ambiente attivo, ispeziona le richieste bloccate e confrontalo con una sessione del browser pulita. Acquisisci una data e ora e una sequenza riproducibile per fornire assistenza.

Ottieni supporto per sviluppatori

E-mail support@spreeai.com con l'ambiente, l'ID del prodotto o del capo, il browser o il dispositivo, la data e l'ora approssimative, il comportamento previsto e i passaggi per riprodurre il problema. Non includere segreti o immagini dei clienti.

Documentazione

Scegli la tua lingua.