SPREEAI/डेवलपर्स/प्रलेखन

इसके साथ निर्माण करें
SPREEAI.

एकीकरण के विकल्प से लेकर सफल लॉन्च तक का एक व्यावहारिक मार्ग। एक वाणिज्य यात्रा से शुरुआत करें, जारी किए गए परीक्षण एक्सेस का उपयोग करें और क्रेडेंशियल को ब्राउज़र कोड से बाहर रखें।

सार्वजनिक मार्गदर्शिकावेब एसडीके v3.0.0अक्टूबर 2026 को अपडेट किया गया

एकीकरण पथ चुनें

पथके लिए सर्वश्रेष्ठपहली कार्रवाई
Shopify ऐपत्वरित प्रबंधित स्टोरफ्रंट सेटअपऐप इंस्टॉल करें
वेब एसडीकेकस्टम या हेडलेस वेबएसडीके गाइड पढ़ें
आईओएस / एंड्रॉइडनेटिव शॉपिंग ऐप्सएक स्थानीय गाइड चुनें
सार्वजनिक एपीआईअनुमोदित सर्वर-साइड वर्कफ़्लोस्वीकृत संदर्भ खोलें
अमेज़न पार्टनर नेटवर्कमार्केटप्लेस एकीकरणजल्द आ रहा है
प्रमाण-पत्रों की सुरक्षा। उदाहरणों में केवल प्लेसहोल्डर का उपयोग किया गया है। SPREEAI ऑनबोर्डिंग के दौरान स्वीकृत एक्सेस जारी करता है। क्लाइंट सीक्रेट, एपीआई कुंजी, टोकन, निजी होस्टनाम या ग्राहक डेटा कभी भी प्रकाशित न करें।

Shopify ऐप

जब स्टोर Shopify पर चल रहा हो और उसे कस्टम बैकएंड की आवश्यकता न हो, तो प्रबंधित ऐप का उपयोग करें। वर्तमान ऑनबोर्डिंग प्रक्रिया समझौतों और सदस्यता के बाद स्टोर को कनेक्ट करती है; इसके लिए सेटअप स्क्रीन में API कुंजी कॉपी करने की आवश्यकता नहीं होती है।

  1. आधिकारिक SPREEAI ऐप इंस्टॉल करें और प्रबंधित सहमति प्रक्रिया पूरी करें।
  2. प्रारंभिक कैटलॉग समूह को सिंक्रनाइज़ करें और उत्पाद की तत्परता स्थिति की समीक्षा करें।
  3. डुप्लिकेट थीम में प्लेसमेंट और स्टाइलिंग को कस्टमाइज़ करें।
  4. योग्य उत्पादों, वेरिएंट, मोबाइल व्यवहार और कार्ट में जोड़ने की प्रक्रिया को सत्यापित करें।
  5. ब्रांड और गुणवत्ता आश्वासन (QA) की स्वीकृति के बाद ही प्रकाशित करें।

आधिकारिक Shopify ऑनबोर्डिंग गाइड खोलें

वेब एसडीके त्वरित आरंभ

उपयोग @spreeai/web-sdk कस्टम प्लेसमेंट, स्टाइलिंग, इवेंट्स, साइजिंग और कार्ट व्यवहार के लिए।

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

एक बार आरंभ करें, केवल योग्य उत्पाद के लिए ही रेंडर करें और दस्तावेजित क्लाइंट कॉलबैक को अपने मौजूदा एनालिटिक्स से कनेक्ट करें। वर्तमान इंटरफ़ेस की पुष्टि करें। आधिकारिक वेब एसडीके एपीआई संदर्भ

एपीआई पहुंच

ऑनबोर्डिंग के दौरान स्वीकृत सर्वर-साइड वर्कफ़्लो के लिए ही सार्वजनिक स्वैगर संदर्भ का उपयोग करें। गुप्त जानकारी को अपने सर्वर पर सुरक्षित रखें, परीक्षण और उत्पादन पहुंच को अलग-अलग रखें, और क्रेडेंशियल को न्यूनतम आवश्यक वातावरण तक सीमित रखें।

अनुमोदित सार्वजनिक संदर्भ में मौजूद न होने वाले प्रत्यक्ष REST एंडपॉइंट, वेबहुक या प्रमाणीकरण व्यवहारों को तब तक अनुपलब्ध माना जाना चाहिए जब तक कि पार्टनर इंजीनियरिंग उनकी पुष्टि न कर दे।

स्वीकृत सार्वजनिक एपीआई संदर्भ खोलें

परिधान परिसंपत्ति आधाररेखा

  • जेपीईजी या पीएनजी; न्यूनतम आकार 2,000 × 2,000 पिक्सल, लगभग 4K रिज़ॉल्यूशन बेहतर रहेगा।
  • प्रत्येक छवि में एक ही परिधान, बीच में स्थित, साफ किनारों और तटस्थ, एकसमान प्रकाश व्यवस्था के साथ।
  • सामने से देखने की आवश्यकता है; जब वह अनुभव सक्षम हो तो पीछे से देखने की अनुशंसा की जाती है।
  • फाइलनाम और कैटलॉग रिकॉर्ड में स्थिर SKU, स्टाइल या परिधान ID शामिल होना चाहिए।
  • आइटम को ढकने के लिए कोई हाथ, हैंगर, स्टाइलिंग प्रॉप्स, वॉटरमार्क या असंबंधित वस्त्र नहीं होने चाहिए।
  • एक्सपीरियंस को सक्षम करने से पहले वेरिएंट मैपिंग की जांच की जाती है।

QA और लॉन्च

  • मौजूदा मोबाइल और डेस्कटॉप ब्राउज़रों पर संपूर्ण ग्राहक यात्रा का परीक्षण करें।
  • उत्पाद और वेरिएंट मैपिंग, परिधान की तैयारी और कार्ट के व्यवहार को सत्यापित करें।
  • कीबोर्ड एक्सेस, फोकस ऑर्डर, एक्सेस करने योग्य नाम और फॉलबैक व्यवहार की जांच करें।
  • SPREEAI को सक्षम करने से पहले और बाद में उत्पाद पृष्ठ के प्रदर्शन को मापें।
  • लोडिंग, खाली, अनुपलब्ध, टाइमआउट और पुनः प्रयास स्थितियों का अभ्यास करें।
  • सहमति की भाषा और ग्राहक की तस्वीरों के स्वीकृत प्रबंधन की पुष्टि करें।
  • उत्पादन शुरू करने से पहले इंजीनियरिंग, वाणिज्य, गुणवत्ता नियंत्रण और ब्रांड की मंजूरी प्राप्त करें।

समस्या निवारण

बटन दिखाई नहीं देता

SDK इनिशियलाइज़ेशन, क्लाइंट आइडेंटिफ़ायर, होस्ट एलिमेंट ID, प्रोडक्ट एलिजिबिलिटी, गारमेंट रेडीनेस और वेरिएंट मैपिंग की पुष्टि करें। फिर टोकन साझा किए बिना ब्राउज़र कंसोल और नेटवर्क त्रुटियों की जाँच करें।

गलत उत्पाद या प्रकार दिखाई दे रहा है

स्टोरफ्रंट उत्पाद और वेरिएंट आईडी की तुलना SPREEAI को भेजे गए रिकॉर्ड से करें। पुष्टि करें कि खरीदार द्वारा वेरिएंट बदलने पर प्रस्तुत अनुरोध में परिवर्तन होता है।

यह अनुभव धीमा है या अनुपलब्ध है।

किसी पहले से तैयार उत्पाद का परीक्षण करें, सक्रिय वातावरण को सत्यापित करें, अवरुद्ध अनुरोधों की जांच करें और एक स्वच्छ ब्राउज़र सत्र की तुलना करें। सहायता के लिए एक टाइमस्टैम्प और पुनरुत्पादित अनुक्रम कैप्चर करें।

डेवलपर सहायता प्राप्त करें

ईमेल support@spreeai.com पर्यावरण, उत्पाद या परिधान आईडी, ब्राउज़र या डिवाइस, अनुमानित समय, अपेक्षित व्यवहार और पुनरुत्पादन चरणों सहित जानकारी शामिल करें। गोपनीय जानकारी या ग्राहक की तस्वीरें शामिल न करें।

प्रलेखन

अपनी भाषा चुनें।