अवलोकन
Dodo Payments चेकआउट SDK आपके वेब एप्लिकेशन में हमारे भुगतान ओवरले को एकीकृत करने का एक सहज तरीका प्रदान करता है। TypeScript और आधुनिक वेब मानकों के साथ निर्मित, यह रीयल-टाइम इवेंट हैंडलिंग और अनुकूलन योग्य थीम के साथ भुगतान को संभालने के लिए एक मजबूत समाधान प्रदान करता है।
डेमो
Interactive Demo
हमारे लाइव डेमो के साथ ओवरले चेकआउट को क्रियाशील अवस्था में देखें।
त्वरित प्रारंभ
कुछ कोड की पंक्तियों में Dodo Payments चेकआउट SDK के साथ शुरू करें:चरण-दर-चरण एकीकरण गाइड
Initialize the SDK
अपने एप्लिकेशन में SDK को प्रारंभ करें, आमतौर पर आपके मुख्य घटक या ऐप के प्रवेश बिंदु में:
Test Your Integration
- अपने विकास सर्वर को प्रारंभ करें:
- चेकआउट प्रवाह का परीक्षण करें:
- चेकआउट बटन पर क्लिक करें
- सत्यापित करें कि ओवरले प्रकट होता है
- परीक्षण क्रेडेंशियल्स का उपयोग करके भुगतान प्रवाह का परीक्षण करें
- पुष्टि करें कि रीडायरेक्ट सही ढंग से काम करते हैं
आपको अपने ब्राउज़र कंसोल में चेकआउट ईवेंट लॉग होते हुए दिखाई देने चाहिए।
API संदर्भ
कॉन्फ़िगरेशन
प्रारंभ विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
mode | "test" | "live" | हाँ | Environment mode: 'test' विकास के लिए, 'live' उत्पादन के लिए |
displayType | "overlay" | "inline" | नहीं | Display type: 'overlay' मोडल चेकआउट (डिफ़ॉल्ट) के लिए, 'inline' एम्बेडेड चेकआउट के लिए |
onEvent | function | हाँ | किस्म के ईवेंट्स को संभालने के लिए कॉलबैक फ़ंक्शन |
चेकआउट विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
checkoutUrl | string | हां | चेकआउट सेशन API से चेकआउट सेशन URL |
options.showTimer | boolean | नहीं | चेकआउट टाइमर को दिखाएं या छिपाएं। डिफ़ॉल्ट रूप से इसे true पर सेट किया गया है। जब निष्क्रिय हो, तो आपको सेशन समाप्त होने पर checkout.link_expired इवेंट प्राप्त होगा। |
options.showSecurityBadge | boolean | नहीं | सुरक्षा बैज को दिखाएं या छिपाएं। डिफ़ॉल्ट रूप से इसे true पर सेट किया गया है। |
विधियाँ
चेकआउट खोलें
निर्दिष्ट चेकआउट सत्र URL के साथ चेकआउट ओवरले खोलता है।चेकआउट बंद करें
प्रोग्रामेटिक रूप से चेकआउट ओवरले को बंद करता है।स्थिति जांचें
जांचता है कि चेकआउट ओवरले वर्तमान में खुला है या नहीं।इवेंट्स
SDK रीयल-टाइम इवेंट्स प्रदान करता है जिन्हें आपonEvent कॉलबैक के माध्यम से सुन सकते हैं:
| इवेंट प्रकार | विवरण |
|---|---|
checkout.opened | चेकआउट ओवरले खोला गया |
checkout.form_ready | चेकआउट फॉर्म उपयोगकर्ता इनपुट को प्राप्त करने के लिए तैयार है। लोडिंग स्टेट्स छिपाने के लिए उपयोगी। |
checkout.payment_page_opened | भुगतान पृष्ठ प्रदर्शित किया गया |
checkout.customer_details_submitted | ग्राहक और बिलिंग विवरण सबमिट किये गए |
checkout.closed | चेकआउट ओवरले बंद किया गया |
checkout.redirect | चेकआउट एक रीडायरेक्ट करेगा |
checkout.error | चेकआउट के दौरान एक त्रुटि आई |
checkout.link_expired | फायर तब होता है जब चेकआउट सेशन समाप्त होता है। केवल तब प्राप्त होता है जब showTimer false पर सेट हो। |
कार्यान्वयन विकल्प
पैकेज मैनेजर इंस्टॉलेशन
npm, yarn, या pnpm के माध्यम से इंस्टॉल करें जैसा कि चरण-दर-चरण एकीकरण गाइड में दिखाया गया है।CDN कार्यान्वयन
बिना किसी निर्माण चरण के त्वरित एकीकरण के लिए, आप हमारे CDN का उपयोग कर सकते हैं:थीम अनुकूलन
आप चेकआउट की उपस्थिति को अनुकूलित कर सकते हैं ताकि जब चेकआउट खोला जाए तबoptions पैरामीटर में एक themeConfig ऑब्जेक्ट पास किया जाए। थीम कॉन्फ़िगरेशन लाइट और डार्क मोड दोनों का समर्थन करता है, जिससे आप रंग, सीमाएं, पाठ, बटन और सीमा त्रिज्या को अनुकूलित कर सकते हैं।
यह खंड क्लाइंट-साइड थीम कॉन्फ़िगरेशन को कवर करता है जो चेकआउट SDK का उपयोग करके किया गया है। आप API का उपयोग करते समय चेकआउट सेशन बनाते समय सर्वर-साइड पर भी थीम्स को कॉन्फ़िगर कर सकते हैं
theme_config पैरामीटर का उपयोग करके। API-स्तरीय कॉन्फ़िगरेशन के लिए चेकआउट थीम अनुकूलन देखें, या डिज़ाइन पृष्ठ का उपयोग करके डैशबोर्ड में थिम्स को विज़ुअली कॉन्फ़िगर करें और लाइव पूर्वावलोकन प्राप्त करें।बुनियादी थीम कॉन्फ़िगरेशन
पूर्ण थीम कॉन्फ़िगरेशन
सभी उपलब्ध थीम गुण:केवल लाइट मोड
यदि आप केवल लाइट थीम को अनुकूलित करना चाहते हैं:केवल डार्क मोड
यदि आप केवल डार्क थीम को अनुकूलित करना चाहते हैं:आंशिक थीम ओवरराइड
आप केवल विशिष्ट गुणों को ओवरराइड कर सकते हैं। चेकआउट उन गुणों के लिए डिफ़ॉल्ट मान का उपयोग करेगा जिन्हें आप निर्दिष्ट नहीं करते:अन्य विकल्पों के साथ थीम कॉन्फ़िगरेशन
आप अन्य चेकआउट विकल्पों के साथ थीम कॉन्फ़िगरेशन को जोड़ सकते हैं:टाइपस्क्रिप्ट प्रकार
टाइपस्क्रिप्ट उपयोगकर्ताओं के लिए, सभी थीम कॉन्फ़िगरेशन प्रकार निर्यात किए जाते हैं:त्रुटि हैंडलिंग
SDK इवेंट सिस्टम के माध्यम से विस्तृत त्रुटि जानकारी प्रदान करता है। हमेशा अपनेonEvent कॉलबैक में उचित त्रुटि हैंडलिंग लागू करें:
सर्वोत्तम प्रथाएँ
- एक बार प्रारंभ करें: आपके एप्लिकेशन लोड होने पर SDK को एक बार प्रारंभ करें, न कि हर चेकआउट प्रयास पर
- त्रुटि हैंडलिंग: हमेशा अपने इवेंट कॉलबैक में उचित त्रुटि हैंडलिंग लागू करें
- टेस्ट मोड: विकास के दौरान
testमोड का उपयोग करें और केवल जब उत्पादन के लिए तैयार हो जाए तबliveपर स्विच करें - इवेंट हैंडलिंग: एक संपूर्ण उपयोगकर्ता अनुभव के लिए सभी प्रासंगिक इवेंट्स को हैंडल करें
- मान्य URLs: हमेशा चेकआउट URL का उपयोग करें जो चेकआउट सेशन API से मान्य हो
- टाइपस्क्रिप्ट: बेहतर प्रकार सुरक्षा और डेवलपर अनुभव के लिए टाइपस्क्रिप्ट का उपयोग करें
- लोडिंग स्टेट्स: UX को बेहतर बनाने के लिए जब चेकआउट खुल रहा हो तब लोडिंग स्टेट दिखाएं
- टाइमर मैनेजमेंट: अगर आप सेशन समाप्ति को मैनुअल रूप से हैंडल करना चाहते हैं तो टाइमर (
showTimer: false) को निष्क्रिय करें
समस्या निवारण
Checkout not opening
Checkout not opening
संभावित कारण:
open()को कॉल करने से पहले SDK प्रारंभ नहीं किया गया- अमान्य चेकआउट URL
- कंसोल में जावास्क्रिप्ट त्रुटियाँ
- नेटवर्क कनेक्टिविटी समस्याएँ
- सुनिश्चित करें कि चेकआउट खोलने से पहले SDK प्रारंभ होता है
- कंसोल त्रुटियों की जाँच करें
- सुनिश्चित करें कि चेकआउट URL मान्य है और चेकआउट सेशन API से है
- नेटवर्क कनेक्टिविटी की जाँच करें
Events not firing
Events not firing
संभावित कारण:
- इवेंट हैंडलर सही तरह से सेट नहीं किया गया
- जावास्क्रिप्ट त्रुटियाँ जो इवेंट प्रसार को रोक रही हैं
- SDK सही तरह से प्रारंभ नहीं हुआ
- सुनिश्चित करें कि इवेंट हैंडलर
Initialize()में सही तरह से कॉन्फ़िगर किया गया है - कंसोल में जावास्क्रिप्ट त्रुटियों की जाँच करें
- सुनिश्चित करें कि SDK प्रारंभ सफलतापूर्वक पूरा हुआ
- पहले एक साधारण इवेंट हैंडलर के साथ परीक्षण करें
Styling issues
Styling issues
संभावित कारण:
- आपके एप्लिकेशन के स्टाइल्स के साथ CSS संघर्ष
- थीम सेटिंग्स सही तरह से लागू नहीं हुईं
- उत्तरदायी डिज़ाइन समस्याएँ
- ब्राउज़र DevTools में CSS संघर्षों की जाँच करें
- सुनिश्चित करें कि थीम सेटिंग्स सही हैं
- विभिन्न स्क्रीन आकारों पर परीक्षण करें
- ओवरले के साथ z-index संघर्ष सुनिश्चित न हो
डिजिटल वॉलेट सक्षम करना
Google Pay और अन्य डिजिटल वॉलेट्स की सेटअप के बारे में विस्तृत जानकारी के लिए डिजिटल वॉलेट्स पृष्ठ देखें।ओवरले चेकआउट में Apple Pay अभी तक समर्थित नहीं है। Apple Pay के लिए समर्थन जल्द आ रहा है।
ब्राउज़र समर्थन
Dodo Payments Checkout SDK निम्नलिखित ब्राउज़रों का समर्थन करता है:- Chrome (नवीनतम)
- Firefox (नवीनतम)
- Safari (नवीनतम)
- Edge (नवीनतम)
- IE11+
ओवरले बनाम इनलाइन चेकआउट
अपने उपयोग के मामले के लिए सही चेकआउट प्रकार चुनें:| विशेषता | ओवरले चेकआउट | इनलाइन चेकआउट |
|---|---|---|
| एकीकरण की गहराई | पृष्ठ के ऊपर मॉड्यूल | पृष्ठ में पूरी तरह से अंतर्निहित |
| लेआउट नियंत्रण | सीमित | पूर्ण नियंत्रण |
| ब्रांडिंग | पृष्ठ से अलग | सहज |
| कार्यान्वयन प्रयास | कम | अधिक |
| सर्वश्रेष्ठ के लिए | त्वरित एकीकरण, मौजूदा पृष्ठ | कस्टम चेकआउट पृष्ठ, उच्च-रूपांतरण प्रवाह |
संबंधित संसाधन
Inline Checkout
अपने पृष्ठ पर सीधे चेकआउट एम्बेड करें पूरी तरह से एकीकृत अनुभवों के लिए।
Checkout Sessions API
चेकआउट अनुभवों को संचालित करने के लिए चेकआउट सत्र बनाएं।
Webhooks
वेबहुक्स के माध्यम से सर्वर-साइड भुगतान इवेंट्स को संभालें।
Integration Guide
Dodo Payments को एकीकृत करने के लिए पूरी गाइड।