SPREEAI/Udviklere/Dokumentation

Byg med
SPREEAI.

En praktisk vej fra integrationsvalg til en testet lancering. Start med én handelsrejse, brug udstedt testadgang, og hold legitimationsoplysninger ude af browserkode.

Offentlig guideWeb-SDK v3.0.0Opdateret oktober 2026

Vælg integrationsstien

StiBedst tilFørste handling
Shopify AppHurtig administreret butiksopsætningInstaller appen
Web-SDKBrugerdefineret eller headless webLæs SDK-vejledningen
iOS / AndroidNative shopping-appsVælg en lokal guide
Offentlige API'erGodkendte serverside-workflowsÅbn godkendt reference
Amazon PartnernetværkMarketplace-integrationKommer snart
Sikkerhed af legitimationsoplysninger. Eksempler bruger kun pladsholdere. SPREEAI udsteder godkendt adgang under onboarding. Publicer aldrig en klienthemmelighed, API-nøgle, token, privat værtsnavn eller kundedata.

Shopify App

Brug den administrerede app, når butikken kører på Shopify og ikke behøver en brugerdefineret backend. Det nuværende onboarding-flow forbinder butikken efter aftaler og abonnement; det kræver ikke kopiering af API-nøgler til opsætningsskærmen.

  1. Installer den officielle SPREEAI-app, og fuldfør det administrerede samtykkeflow.
  2. Synkroniser en indledende kataloggruppe, og gennemgå produktets parathedstilstande.
  3. Tilpas placering og styling i et duplikeret tema.
  4. Valider berettigede produkter, varianter, mobiladfærd og tilføj til kurv.
  5. Udgiv kun efter godkendelse af brand og kvalitetssikring.

Åbn den officielle Shopify onboarding-guide

Web SDK hurtigstart

Bruge @spreeai/web-sdk til brugerdefineret placering, styling, begivenheder, størrelser og indkøbskurvsadfærd.

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, render kun for et kvalificeret produkt, og forbind dokumenterede klienttilbagekald til dine eksisterende analyser. Bekræft den aktuelle grænseflade i officiel Web SDK API-reference

API-adgang

Brug kun den offentlige Swagger-reference til server-side workflows, der er godkendt under onboarding. Behold hemmeligheder på din server, adskil test- og produktionsadgang, og omfavn legitimationsoplysninger til det minimum krævede miljø.

Direkte REST-slutpunkter, webhooks eller godkendelsesadfærd, der ikke findes i den godkendte offentlige reference, bør behandles som utilgængelige, indtil Partner Engineering bekræfter dem.

Åbn den godkendte offentlige API-reference

Basislinje for beklædningsaktiver

  • JPEG eller PNG; minimum 2.000 × 2.000 px, foretrækkes cirka 4K.
  • Ét beklædningsgenstand pr. billede, centreret med rene kanter og neutral, jævn belysning.
  • Forfravisning er påkrævet; bagfravisning anbefales, når denne funktion er aktiveret.
  • Stabilt SKU, stil eller beklædnings-ID inkluderet i filnavnet og katalogposten.
  • Ingen hænder, bøjler, stylingrekvisitter, vandmærker eller uafhængigt beklædningsgenstande, der blokerer varen.
  • Varianttilknytning blev kontrolleret før aktivering af oplevelsen.

QA og lancering

  • Test den komplette kunderejse på nuværende mobil- og desktopbrowsere.
  • Bekræft produkt- og variantkortlægning, beklædningsgenstandens parathed og indkøbskurvens adfærd.
  • Kontroller tastaturadgang, fokusrækkefølge, tilgængelige navne og alternativ funktionsmåde.
  • Mål produktsidens ydeevne før og efter aktivering af SPREEAI.
  • Øvelsesindlæsning, tom, utilgængelig, timeout og genoptagelsestilstande.
  • Bekræft samtykkeerklæring og godkendt håndtering af kundebilleder.
  • Indhent godkendelse fra ingeniører, handel, kvalitetssikring og branding før produktion.

Fejlfinding

Knappen vises ikke

Bekræft SDK-initialisering, klient-id'et, værtselement-ID'et, produktberettigelse, beklædningsgenstandsberedskab og varianttilknytning. Kontroller derefter browserkonsol- og netværksfejl uden at dele tokens.

Det forkerte produkt eller den forkerte variant vises

Sammenlign butiksprodukt- og variant-ID'erne med de poster, der er sendt til SPREEAI. Bekræft, at den gengivne anmodning ændres, når kunden ændrer varianter.

Oplevelsen er langsom eller utilgængelig

Test et kendt produkt, der er klart til brug, verificer det aktive miljø, undersøg blokerede anmodninger, og sammenlign en ren browsersession. Registrer et tidsstempel og en reproducerbar sekvens for support.

Få udviklersupport

E-mail support@spreeai.com med miljø, produkt- eller beklædnings-ID, browser eller enhed, omtrentlig tidsstempel, forventet adfærd og reproduktionstrin. Medtag ikke hemmeligheder eller kundebilleder.

Dokumentation

Vælg dit sprog.