SPREEAI/Utviklere/Dokumentasjon

Bygg med
SPREEAI.

En praktisk vei fra valg av integrasjon til en testet lansering. Start med én handelsreise, bruk utstedt testtilgang og hold påloggingsinformasjon unna nettleserkoden.

Offentlig guideNett-SDK v3.0.0Oppdatert oktober 2026

Velg integrasjonsstien

StiBest forFørste handling
Shopify AppRaskt oppsett av administrert butikkfrontInstaller appen
Nett-SDKTilpasset eller headless webLes SDK-veiledningen
iOS / AndroidNative shoppingapperVelg en lokal guide
Offentlige API-erGodkjente arbeidsflyter på serversidenÅpne godkjent referanse
Amazon Partner NetworkMarketplace-integrasjonKommer snart
Sikkerhet for legitimasjon. Eksempler bruker kun plassholdere. SPREEAI utsteder godkjent tilgang under onboarding. Publiser aldri en klienthemmelighet, API-nøkkel, token, privat vertsnavn eller kundedata.

Shopify App

Bruk den administrerte appen når butikken kjører på Shopify og ikke trenger en tilpasset backend. Den nåværende onboarding-flyten kobler til butikken etter avtaler og abonnement; den krever ikke kopiering av API-nøkler til oppsettskjermen.

  1. Installer den offisielle SPREEAI-appen og fullfør den administrerte samtykkeprosessen.
  2. Synkroniser en innledende kataloggruppe og gjennomgå produktets klarhetstilstander.
  3. Tilpass plassering og styling i et duplisert tema.
  4. Valider kvalifiserte produkter, varianter, mobilatferd og legg til i handlekurven.
  5. Publiser kun etter godkjenning av merkevare og kvalitetssikring.

Åpne den offisielle Shopify introduksjonsveiledningen

Hurtigstart for nett-SDK

Bruk @spreeai/web-sdk for tilpasset plassering, styling, arrangementer, størrelser og handlekurvoppførsel.

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

Initialiser én gang, gjengi kun for et kvalifisert produkt og koble dokumenterte klienttilbakekallinger til din eksisterende analyse. Bekreft gjeldende grensesnitt i offisiell referanse for Web SDK API

API-tilgang

Bruk den offentlige Swagger-referansen kun for arbeidsflyter på serversiden som er godkjent under onboarding. Behold hemmeligheter på serveren din, separer test- og produksjonstilgang, og omfang legitimasjonsinformasjonen til det minste nødvendige miljøet.

Direkte REST-endepunkter, webhooks eller autentiseringsatferd som ikke finnes i den godkjente offentlige referansen, bør behandles som utilgjengelige inntil Partner Engineering bekrefter dem.

Åpne den godkjente offentlige API-referansen

Basislinje for klesressurser

  • JPEG eller PNG; minimum 2000 × 2000 piksler, foretrukket er omtrent 4K.
  • Ett plagg per bilde, sentrert med rene kanter og nøytral, jevn belysning.
  • Forfravisning kreves; bakfravisning anbefales når denne opplevelsen er aktivert.
  • Stabil SKU, stil eller plagg-ID inkludert i filnavnet og katalogposten.
  • Ingen hender, kleshengere, stylingrekvisitter, vannmerker eller urelaterte plagg som blokkerer varen.
  • Varianttilordningen ble kontrollert før aktivering av opplevelsen.

QA og lansering

  • Test hele kundereisen på nåværende mobil- og datamaskinnettlesere.
  • Bekreft produkt- og variantkartlegging, plaggklarhet og handlekurvatferd.
  • Sjekk tastaturtilgang, fokusrekkefølge, tilgjengelige navn og alternativ oppførsel.
  • Mål ytelsen på produktsiden før og etter aktivering av SPREEAI.
  • Øvelse laster inn, er tom, utilgjengelig, er tidsavbrutt og har fått status for nye forsøk.
  • Bekreft samtykkeformulering og godkjent håndtering av kundebilder.
  • Innhent godkjenning fra ingeniører, handel, kvalitetssikring og merkevarebygging før produksjon.

Feilsøking

Knappen vises ikke

Bekreft SDK-initialisering, klientidentifikator, vertselement-ID, produktkvalifisering, plaggklarhet og varianttilordning. Sjekk deretter nettleserkonsoll- og nettverksfeil uten å dele tokener.

Feil produkt eller variant vises

Sammenlign ID-ene for butikkens produkt og varianter med postene som er sendt til SPREEAI. Bekreft at den gjengitte forespørselen endres når kunden endrer varianter.

Opplevelsen er treg eller utilgjengelig

Test et kjent produkt som er klart for bruk, bekreft det aktive miljøet, inspiser blokkerte forespørsler og sammenlign en ren nettleserøkt. Registrer et tidsstempel og en reproduserbar sekvens for støtte.

Få utviklerstøtte

E-post support@spreeai.com med miljø, produkt- eller plagg-ID, nettleser eller enhet, omtrentlig tidsstempel, forventet atferd og reproduksjonstrinn. Ikke inkluder hemmeligheter eller kundebilder.

Dokumentasjon

Velg språket ditt.