SPREEAI/Mga Developer/Dokumentasyon

Gumawa gamit ang
SPREEAI.

Isang praktikal na landas mula sa pagpili ng integrasyon patungo sa isang nasubukang paglulunsad. Magsimula sa isang paglalakbay sa komersyo, gamitin ang inisyu na test access at ilayo ang mga kredensyal sa browser code.

Pampublikong gabayWeb SDK bersyon 3.0.0Na-update noong Oktubre 2026

Piliin ang landas ng pagsasama

LandasPinakamahusay para saUnang aksyon
Shopify AppMabilis na pinamamahalaang pag-setup ng storefrontI-install ang app
Web SDKPasadyang o walang ulong webBasahin ang gabay sa SDK
iOS / AndroidMga katutubong app sa pamimiliPumili ng katutubong gabay
Mga Pampublikong APIMga inaprubahang workflow sa server-sideBuksan ang naaprubahang sanggunian
Network ng Kasosyo sa AmazonPagsasama ng pamilihanMalapit na
Kaligtasan ng kredensyal. Mga placeholder lamang ang ginagamit sa mga halimbawa. Ang SPREEAI ay nag-iisyu ng inaprubahang access habang onboarding. Huwag kailanman mag-publish ng client secret, API key, token, pribadong hostname o data ng customer.

Shopify App

Gamitin ang pinamamahalaang app kapag ang tindahan ay tumatakbo sa Shopify at hindi nangangailangan ng custom backend. Ang kasalukuyang daloy ng onboarding ay nagkokonekta sa tindahan pagkatapos ng mga kasunduan at subscription; hindi nito kailangan ng pagkopya ng mga API key sa setup screen.

  1. I-install ang opisyal na SPREEAI app at kumpletuhin ang daloy ng pinamamahalaang pahintulot.
  2. I-sync ang isang paunang grupo ng katalogo at suriin ang mga estado ng kahandaan ng produkto.
  3. I-customize ang pagkakalagay at estilo sa isang nadobleng tema.
  4. Patunayan ang mga kwalipikadong produkto, variant, gawi sa mobile, at add-to-cart.
  5. I-publish lamang pagkatapos ng pag-apruba ng brand at QA.

Buksan ang opisyal na gabay sa onboarding na Shopify

Mabilisang pagsisimula ng Web SDK

Gamitin @spreeai/web-sdk para sa pasadyang paglalagay, estilo, mga kaganapan, laki at gawi sa cart.

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

Mag-initialize nang isang beses, mag-render lamang para sa isang kwalipikadong produkto at ikonekta ang mga dokumentadong callback ng kliyente sa iyong kasalukuyang analytics. Kumpirmahin ang kasalukuyang interface sa opisyal na sanggunian ng Web SDK API

Pag-access sa API

Gamitin lamang ang pampublikong sanggunian ng Swagger para sa mga workflow sa server-side na naaprubahan habang onboarding. Panatilihing lihim ang iyong server, hiwalay na access sa pagsubok at produksyon, at mga kredensyal sa saklaw sa minimum na kinakailangang kapaligiran.

Ang mga direktang REST endpoint, webhook, o authentication behavior na wala sa inaprubahang pampublikong sanggunian ay dapat ituring na hindi magagamit hanggang sa kumpirmahin ng Partner Engineering ang mga ito.

Buksan ang naaprubahang pampublikong sanggunian ng API

Baseline ng asset ng damit

  • JPEG o PNG; minimum na 2,000 × 2,000 px, na may mas mainam na humigit-kumulang 4K.
  • Isang damit bawat larawan, nasa gitna na may malinis na mga gilid at neutral, pantay na ilaw.
  • Kinakailangan ang harapan; inirerekomenda ang likuran kapag naka-enable ang karanasang iyon.
  • Matatag na SKU, estilo o ID ng damit na kasama sa filename at talaan ng katalogo.
  • Walang mga kamay, hanger, styling props, watermark, o mga damit na hindi nauugnay dito na nakaharang sa item.
  • Sinuri ang variant mapping bago i-enable ang karanasan.

QA at paglulunsad

  • Subukan ang kumpletong karanasan ng customer sa mga kasalukuyang mobile at desktop browser.
  • I-verify ang pagmamapa ng produkto at variant, kahandaan ng damit, at gawi sa cart.
  • Suriin ang access sa keyboard, pagkakasunud-sunod ng focus, mga pangalan ng accessible, at fallback na gawi.
  • Sukatin ang performance ng pahina ng produkto bago at pagkatapos i-enable ang SPREEAI.
  • Mga estado ng paglo-load ng ehersisyo, walang laman, hindi magagamit, timeout at muling subukan.
  • Kumpirmahin ang lengguwahe ng pahintulot at ang inaprubahang paghawak ng mga imahe ng customer.
  • Kumuha ng pirma mula sa engineering, commerce, QA, at brand bago ang produksyon.

Pag-troubleshoot

Hindi lumalabas ang buton

Kumpirmahin ang pagsisimula ng SDK, ang client identifier, ang host element ID, pagiging karapat-dapat ng produkto, kahandaan ng damit, at variant mapping. Pagkatapos, suriin ang mga error sa browser console at network nang hindi nagbabahagi ng mga token.

Lumilitaw ang maling produkto o variant

Ihambing ang mga ID ng produkto at variant ng storefront sa mga talaang ipinadala kay SPREEAI. Kumpirmahin na nagbabago ang na-render na kahilingan kapag binago ng mamimili ang mga variant.

Mabagal o hindi available ang karanasan

Subukan ang isang kilalang-handa nang produkto, beripikahin ang aktibong kapaligiran, siyasatin ang mga naharang na kahilingan at ihambing ang isang malinis na sesyon ng browser. Kumuha ng timestamp at maaaring kopyahing pagkakasunod-sunod para sa suporta.

Kumuha ng suporta para sa developer

I-email support@spreeai.com kasama ang kapaligiran, ID ng produkto o damit, browser o device, tinatayang timestamp, inaasahang pag-uugali at mga hakbang sa pagpaparami. Huwag magsama ng mga sikreto o imahe ng customer.

Dokumentasyon

Piliin ang iyong wika.