SPREEAI/Ontwikkelaars/Documentatie

Bouw mee
SPREEAI.

Een praktisch traject van integratiekeuze tot een beproefde lancering. Begin met één handelstraject, gebruik verleende testtoegang en houd inloggegevens buiten de browsercode.

Openbare gidsWeb SDK v3.0.0Bijgewerkt in oktober 2026

Kies het integratiepad

PadBeste voorEerste actie
Shopify AppSnelle beheerde configuratie van de winkelpuiInstalleer de app
Web SDKOp maat gemaakt of headless webLees de SDK-handleiding
iOS / AndroidNative shopping-appsKies een native gids
Openbare API'sGoedgekeurde workflows aan de serverzijdeOpen goedgekeurde referentie
Amazon-partnernetwerkMarktplaatsintegratieBinnenkort beschikbaar
Veiligheid van legitimatie. In voorbeelden worden alleen tijdelijke aanduidingen gebruikt. SPREEAI verleent goedgekeurde toegang tijdens onboarding. Publiceer nooit een klantgeheim, API-sleutel, token, privéhostnaam of klantgegevens.

Shopify App

Gebruik de beheerde app wanneer de winkel op Shopify draait en geen aangepaste backend nodig heeft. De huidige onboarding-flow verbindt de winkel na overeenkomsten en abonnementen; het is niet nodig om API-sleutels naar het instelscherm te kopiëren.

  1. Installeer de officiële SPREEAI-app en voltooi de beheerde toestemmingsstroom.
  2. Synchroniseer een initiële catalogusgroep en controleer de gereedheidsstatus van de producten.
  3. Pas de plaatsing en stijl in een gedupliceerd thema aan.
  4. Valideer in aanmerking komende producten, varianten, mobiel gedrag en het toevoegen aan de winkelwagen.
  5. Publiceer alleen na goedkeuring van het merk en de QA.

Open de officiële Shopify introductiegids

Snelstartgids voor de Web SDK

Gebruik @spreeai/web-sdk voor aangepaste plaatsing, styling, evenementen, afmetingen en winkelwagengedrag.

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

Initialiseer één keer, geef alleen weer voor een in aanmerking komend product en koppel gedocumenteerde klantcallbacks aan uw bestaande analyses. Bevestig de huidige interface in het officiële Web SDK API-referentie

API-toegang

Gebruik de openbare Swagger-referentie alleen voor serverworkflows die tijdens de onboarding zijn goedgekeurd. Houd geheimen op uw server, scheid de toegang voor test- en productieomgevingen en beperk de inloggegevens tot de minimaal vereiste omgeving.

Directe REST-eindpunten, webhooks of authenticatiegedragingen die niet aanwezig zijn in de goedgekeurde openbare referentie moeten als niet beschikbaar worden beschouwd totdat Partner Engineering deze bevestigt.

Open de goedgekeurde openbare API-referentie

Basislijn kledingitem

  • JPEG of PNG; Minimaal 2.000 × 2.000 px, waarbij ongeveer 4K de voorkeur heeft.
  • Eén kledingstuk per afbeelding, gecentreerd met strakke randen en neutrale, gelijkmatige verlichting.
  • Vooraanzicht vereist; achteraanzicht aanbevolen wanneer die ervaring is ingeschakeld.
  • Stabiele SKU, stijl of kleding-ID opgenomen in de bestandsnaam en catalogusrecord.
  • Er mogen geen handen, hangers, stylingaccessoires, watermerken of niet-gerelateerde kledingstukken het item blokkeren.
  • Variantenmapping is gecontroleerd voordat de functionaliteit werd ingeschakeld.

QA en lancering

  • Test het volledige klanttraject op de huidige mobiele en desktopbrowsers.
  • Controleer de product- en varianttoewijzing, de gereedheid van de kledingstukken en het gedrag in het winkelmandje.
  • Controleer toetsenbordtoegang, focusvolgorde, toegankelijke namen en terugvalgedrag.
  • Meet de prestaties van de productpagina voor en na het inschakelen van SPREEAI.
  • Oefeningstatussen voor laden, leeg, niet beschikbaar, time-out en opnieuw proberen.
  • Bevestig de toestemmingstaal en goedgekeurde verwerking van klantbeelden.
  • Verkrijg engineering, commercie, kwaliteitscontrole en merkaftekening vóór productie.

Probleemoplossing

De knop verschijnt niet.

Bevestig de SDK-initialisatie, de client-ID, de ID van het hostelement, de geschiktheid van het product, de gereedheid van het kledingstuk en de toewijzing van varianten. Controleer vervolgens de browserconsole en netwerkfouten zonder tokens te delen.

Het verkeerde product of de verkeerde variant wordt weergegeven.

Vergelijk de product- en variant-ID's van de winkel met de records die zijn verzonden naar SPREEAI. Bevestig dat het weergegeven verzoek verandert wanneer de klant van variant verandert.

De ervaring is traag of niet beschikbaar.

Test een werkend product, verifieer de actieve omgeving, inspecteer geblokkeerde verzoeken en vergelijk deze met een schone browsersessie. Leg een tijdstempel en een reproduceerbare reeks vast voor ondersteuning.

Krijg ondersteuning voor ontwikkelaars

E-mail support@spreeai.com Vermeld de omgeving, product- of kleding-ID, browser of apparaat, geschatte tijdstempel, verwacht gedrag en reproductiestappen. Voeg geen bedrijfsgeheimen of klantafbeeldingen toe.

Documentatie

Kies uw taal.