init(options)
보고 Promise<SpreeAISDK | null>. 성공하면 개체가 노출됩니다. renderTryOnButton(options): Promise<void>. 렌더링하기 전에 null을 확인하세요.
| 옵션 | 유형 | 기본 | 목적 |
|---|---|---|---|
clientId | string | 필수 | 발급된 브라우저 클라이언트 식별자입니다. |
baseApiURL | string | https://api.spreeai.com | 승인된 API 출처. 발행된 환경에 대해서만 변경하십시오. |
baseURL | string | https://vton.spreeai.com | 승인된 호스팅 피팅룸 출처. |
partnerId v3의 초기화 옵션이 아닙니다. 파트너는 인증된 클라이언트에서 확인됩니다. 독립형 크기 조정 렌더링 메서드가 반환되지 않습니다.
renderTryOnButton(options)
| 옵션 | 유형 | 기본/요구사항 | 목적 |
|---|---|---|---|
elementId | string | 필수 | 기존 호스트 요소의 ID입니다. |
garments | GarmentInput[] | 필수 선택 | 권장 의류 입력. 비어 있지 않은 배열을 사용하십시오. |
garmentId | string | 더 이상 사용되지 않는 대안 | 레거시 단일 의류 입력. 의류를 선호합니다. |
variant | VariantOptions | 더 이상 사용되지 않음 | garmentId가 포함된 레거시 필터; 항목별 변형을 선호합니다. |
className | string | 선택 과목 | 추가 버튼 클래스. |
button | { text?: string } | 선택 과목 | 버튼 라벨; features.tryOnButton.text에 의해 재정의되었습니다. |
features | TryOnFeatures | 선택 과목 | 버튼 스타일 구성. |
events | TryOnButtonEvents | 선택 과목 | 클릭하여 장바구니에 추가하세요. |
enableAddToCart | boolean | false | 장바구니에 추가 기능을 표시합니다. 핸들러를 구현합니다. |
enableSizingRecommendation | boolean | false | 입어볼 때 사이즈 추천을 요청하세요. |
showSizes | boolean | false | 제공된 availableSizes를 표시합니다. |
showPrices | boolean | false | 공급 가격을 표시합니다. |
defaultUnits | "metric" | "imperial" | 선택 과목 | 프로파일 측정을 위한 시작 단위 시스템. |
GarmentInput
| 필드 | 유형 | 목적 |
|---|---|---|
garmentId | string | 필수 SPREEAI 의류 식별자입니다. |
variant | VariantOptions | 선택적인 색상, 핏, 성별 또는 스타일 필터. |
availableSizes | string[] | 선택적인 현재 디스플레이 크기 라벨. |
price | string | 옵션 표시 가격(제공된 대로 표시됨) |
검증 및 대체
단일 의류의 경우 렌더링하기 전에 적합성과 고정된 변형을 확인합니다. 여러 의류 요청에서는 사용 가능한 어울리는 의상을 찾습니다. 아무것도 발견되지 않으면 SDK는 대신 첫 번째 의류를 검증하고 렌더링합니다. 유효성 검사에 실패하면 버튼이 렌더링되지 않고 이유가 콘솔에 기록됩니다.
콜백
| 콜백 | 페이로드 |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", 의류, setIsLoading, closePopUp, onError |
카트 의류에는 필수 품목이 포함되어 있습니다. id, partner_id, available 그리고 name, 플러스 선택 사항 description 및 기타 데이터. 장바구니에 매핑하기 전에 확인하세요. 참조 카트 구현 그리고 버튼 스타일링 예를 들어.
이 표면의 일부가 아닙니다
반환된 v3.0.0 SDK에는 문서화된 보기별 스위치, 독립 실행형 비교 실행기 또는 독립 실행형 크기 조정 방법이 노출되지 않습니다. features.loadingScreen 제거되었습니다. 내보낸 남은 유형이나 오래된 주석에서 호출 가능한 메서드를 추론하지 마세요.