Dokümantasyon

SDK 2.0 · REFERANS

Web SDK API referansı

Genel entegrasyon yüzeyi v3.0.0 npm paketine göre doğrulandı.

init(options)

iadeler Promise<SpreeAISDK | null>. Başarı durumunda nesne ortaya çıkar renderTryOnButton(options): Promise<void>. Oluşturmadan önce null olup olmadığını kontrol edin.

SeçenekTürVarsayılanAmaç
clientIdstringGerekliVerilen tarayıcı istemci tanımlayıcısı.
baseApiURLstringhttps://api.spreeai.comOnaylanmış API kaynağı. Yalnızca yayınlanmış bir ortam için değiştirin.
baseURLstringhttps://vton.spreeai.comOnaylı barındırılan soyunma odası menşei.

partnerId v3'te bir başlatma seçeneği değildir. İş ortağı, kimliği doğrulanmış istemciden çözümlenir. Hiçbir bağımsız boyutlandırma oluşturma yöntemi döndürülmez.

renderTryOnButton(options)

SeçenekTürVarsayılan / gereksinimAmaç
elementIdstringGerekliMevcut ana bilgisayar öğesinin kimliği.
garmentsGarmentInput[]Gerekli seçimÖnerilen giysi girişi. Boş olmayan bir dizi kullanın.
garmentIdstringKullanımdan kaldırılan alternatifEski tek giysi girişi. Giysileri tercih edin.
variantVariantOptionsKullanımdan kaldırıldıgarmentId ile eski filtre; ürün başına varyantı tercih edin.
classNamestringİsteğe bağlıEk düğme sınıfı.
button{ text?: string }İsteğe bağlıDüğme etiketi; features.tryOnButton.text tarafından geçersiz kılındı.
featuresTryOnFeaturesİsteğe bağlıDüğme stili yapılandırması.
eventsTryOnButtonEventsİsteğe bağlıTıklama ve sepete ekleme işleyicileri.
enableAddToCartbooleanfalseSepete ekleme işlevini görüntüleyin. İşleyiciyi uygulayın.
enableSizingRecommendationbooleanfalseDeneme bölümünde boyut önerileri isteyin.
showSizesbooleanfalseVerilen availableSizes'yi gösterin.
showPricesbooleanfalseTedarik edilen fiyatı göster.
defaultUnits"metric" | "imperial"İsteğe bağlıProfil ölçümleri için başlangıç ünitesi sistemi.

GarmentInput

AlanTürAmaç
garmentIdstringGerekli SPREEAI giysi tanımlayıcısı.
variantVariantOptionsİsteğe bağlı renk, uyum, cinsiyet veya stil filtresi.
availableSizesstring[]İsteğe bağlı mevcut ekran boyutu etiketleri.
pricestringSağlandığı şekilde gösterilen isteğe bağlı ekran fiyatı.

Doğrulama ve geri dönüş

Tek bir giysi için uygunluk ve herhangi bir sabitlenmiş varyant, işleme öncesinde kontrol edilir. Çoklu giysi talepleri, uygun bir eşleşen kıyafet arar. Hiçbiri bulunamazsa SDK bunun yerine ilk giysiyi doğrular ve işler. Doğrulama başarısız olursa hiçbir düğme oluşturulmaz ve bunun nedeni konsola kaydedilir.

Geri aramalar

Geri aramaYük
onTryOnButtonClickname: "spreeai-try-on-button-clicked"
onAddToCartClickedname: "spreeai-add-to-cart-clicked", giysiler, setIsLoading, closePopUp, onError

Sepetteki giysiler gerekli içeriği içerir id, partner_id, available Ve nameartı isteğe bağlı description ve diğer veriler. Sepetinize eşlemeden önce doğrulayın. Bkz. sepeti uygulaması Ve düğme stili örnekler için.

Bu yüzeyin bir parçası değil

Döndürülen v3.0.0 SDK'sında belgelenmiş hiçbir görüntüleme başına anahtar, bağımsız Karşılaştırma başlatıcısı veya bağımsız boyutlandırma yöntemi gösterilmiyor. features.loadingScreen kaldırıldı. Geriye kalan dışa aktarılan türlerden veya eski yorumlardan çağrılabilir yöntemleri çıkarmayın.

Kaynak referansları

Sayfa başlıklarını ve içeriğini arayın. Kaçış aramayı kapatır.

Dilinizi seçin.