अवलोकन
Dodo Payments चेकआउट SDK आपके वेब एप्लिकेशन में हमारे भुगतान ओवरले को एकीकृत करने का एक सहज तरीका प्रदान करता है। TypeScript और आधुनिक वेब मानकों के साथ निर्मित, यह रीयल-टाइम इवेंट हैंडलिंग और अनुकूलन योग्य थीम के साथ भुगतान को संभालने के लिए एक मजबूत समाधान प्रदान करता है।
डेमो
इंटरएक्टिव डेमो
हमारे लाइव डेमो के साथ ओवरले चेकआउट को क्रियान्वित होते हुए देखें।
त्वरित प्रारंभ
कुछ कोड की पंक्तियों में Dodo Payments चेकआउट SDK के साथ शुरू करें:चरण-दर-चरण एकीकरण गाइड
1
SDK स्थापित करें
अपने पसंदीदा पैकेज प्रबंधक का उपयोग करके Dodo Payments चेकआउट SDK स्थापित करें:
2
SDK प्रारंभ करें
अपने एप्लिकेशन में SDK को प्रारंभ करें, आमतौर पर आपके मुख्य घटक या ऐप के प्रवेश बिंदु में:
3
चेकआउट बटन घटक बनाएं
एक घटक बनाएं जो चेकआउट ओवरले को खोलता है:
4
अपने पृष्ठ पर चेकआउट जोड़ें
अपने एप्लिकेशन में चेकआउट बटन घटक का उपयोग करें:
5
सफलता और विफलता पृष्ठों को संभालें
चेकआउट रीडायरेक्ट को संभालने के लिए पृष्ठ बनाएं:
6
अपने एकीकरण का परीक्षण करें
- अपने विकास सर्वर को प्रारंभ करें:
- चेकआउट प्रवाह का परीक्षण करें:
- चेकआउट बटन पर क्लिक करें
- सत्यापित करें कि ओवरले प्रकट होता है
- परीक्षण क्रेडेंशियल्स का उपयोग करके भुगतान प्रवाह का परीक्षण करें
- पुष्टि करें कि रीडायरेक्ट सही ढंग से काम करते हैं
आपको अपने ब्राउज़र कंसोल में चेकआउट घटनाएँ लॉग होती हुई देखनी चाहिए।
7
लाइव जाएं
जब आप उत्पादन के लिए तैयार हों:
- मोड को
'live'में बदलें:
- अपने चेकआउट URLs को अपने बैकएंड से लाइव चेकआउट सत्रों का उपयोग करने के लिए अपडेट करें
- उत्पादन में पूर्ण प्रवाह का परीक्षण करें
- घटनाओं और त्रुटियों की निगरानी करें
API संदर्भ
कॉन्फ़िगरेशन
प्रारंभ विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
mode | "test" | "live" | हाँ | पर्यावरण मोड: 'test' विकास के लिए, 'live' उत्पादन के लिए |
displayType | "overlay" | "inline" | नहीं | प्रदर्शन प्रकार: 'overlay' मोडल चेकआउट के लिए (डिफ़ॉल्ट), 'inline' एम्बेडेड चेकआउट के लिए |
onEvent | function | हाँ | चेकआउट घटनाओं को संभालने के लिए कॉलबैक फ़ंक्शन |
चेकआउट विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
checkoutUrl | string | हाँ | चेकआउट सत्र URL create checkout session API से |
options.showTimer | boolean | नहीं | चेकआउट टाइमर को दिखाना या छिपाना। डिफ़ॉल्ट true है। जब अक्षम किया जाता है, तो आपको checkout.link_expired घटना प्राप्त होगी जब सत्र समाप्त हो जाता है। |
options.showSecurityBadge | boolean | नहीं | सुरक्षा बैज को दिखाना या छिपाना। डिफ़ॉल्ट true है। |
options.manualRedirect | boolean | नहीं | जब सक्षम किया जाता है, तो चेकआउट पूरा होने के बाद स्वचालित रूप से पुनर्निर्देशित नहीं होगा। इसके बजाय, आपको checkout.status और checkout.redirect_requested घटनाएँ प्राप्त होंगी ताकि आप पुनर्निर्देशन को स्वयं संभाल सकें। |
विधियाँ
चेकआउट खोलें
निर्दिष्ट चेकआउट सत्र URL के साथ चेकआउट ओवरले खोलता है।manualRedirect का उपयोग करते समय, अपने onEvent कॉलबैक में चेकआउट पूर्णता को संभालें:
चेकआउट बंद करें
प्रोग्रामेटिक रूप से चेकआउट ओवरले को बंद करता है।स्थिति जांचें
यह लौटाता है कि चेकआउट ओवरले वर्तमान में खुला है या नहीं।घटनाएँ
SDK वास्तविक समय की घटनाएँ प्रदान करता है जिन पर आपonEvent कॉलबैक के माध्यम से सुन सकते हैं:
चेकआउट स्थिति घटना डेटा
जबmanualRedirect सक्षम होता है, तो आपको निम्नलिखित डेटा के साथ checkout.status घटना प्राप्त होती है:
चेकआउट पुनर्निर्देशन अनुरोधित घटना डेटा
जबmanualRedirect सक्षम होता है, तो आपको निम्नलिखित डेटा के साथ checkout.redirect_requested घटना प्राप्त होती है:
| घटना प्रकार | विवरण |
|---|---|
checkout.opened | चेकआउट ओवरले खोला गया |
checkout.payment_page_opened | भुगतान पृष्ठ प्रदर्शित किया गया |
checkout.customer_details_submitted | ग्राहक और बिलिंग विवरण प्रस्तुत किए गए |
checkout.closed | चेकआउट ओवरले बंद किया गया |
checkout.redirect | चेकआउट पुनर्निर्देशन करेगा |
checkout.error | चेकआउट के दौरान एक त्रुटि हुई |
checkout.link_expired | जब चेकआउट सत्र समाप्त होता है तो फायर किया जाता है। केवल तब प्राप्त होता है जब showTimer को false पर सेट किया गया हो। |
checkout.status | जब manualRedirect सक्षम होता है तो फायर किया जाता है। चेकआउट स्थिति (succeeded, failed, या processing) शामिल है। |
checkout.redirect_requested | जब manualRedirect सक्षम होता है तो फायर किया जाता है। ग्राहक को पुनर्निर्देशित करने के लिए URL शामिल है। |
कार्यान्वयन विकल्प
पैकेज प्रबंधक स्थापना
npm, yarn, या pnpm के माध्यम से स्थापना करें जैसा कि चरण-दर-चरण एकीकरण गाइड में दिखाया गया है।CDN कार्यान्वयन
बिना किसी निर्माण चरण के त्वरित एकीकरण के लिए, आप हमारे CDN का उपयोग कर सकते हैं:थीम कस्टमाइजेशन
आप चेकआउट के रूप को कस्टमाइज़ कर सकते हैंthemeConfig ऑब्जेक्ट को options पैरामीटर में पास करके जब चेकआउट खोलते हैं। थीम कॉन्फ़िगरेशन लाइट और डार्क मोड दोनों का समर्थन करता है, जिससे आप रंग, बॉर्डर, टेक्स्ट, बटन और बॉर्डर रेडियस को कस्टमाइज़ कर सकते हैं।
बेसिक थीम कॉन्फ़िगरेशन
पूर्ण थीम कॉन्फ़िगरेशन
सभी उपलब्ध थीम प्रॉपर्टीज़:केवल लाइट मोड
यदि आप केवल लाइट थीम को कस्टमाइज़ करना चाहते हैं:केवल डार्क मोड
यदि आप केवल डार्क थीम को कस्टमाइज़ करना चाहते हैं:आंशिक थीम ओवरराइड
आप केवल विशिष्ट प्रॉपर्टीज़ को ओवरराइड कर सकते हैं। चेकआउट उन प्रॉपर्टीज़ के लिए डिफ़ॉल्ट मानों का उपयोग करेगा जिन्हें आप निर्दिष्ट नहीं करते:अन्य विकल्पों के साथ थीम कॉन्फ़िगरेशन
आप थीम कॉन्फ़िगरेशन को अन्य चेकआउट विकल्पों के साथ संयोजित कर सकते हैं:TypeScript प्रकार
TypeScript उपयोगकर्ताओं के लिए, सभी थीम कॉन्फ़िगरेशन प्रकार निर्यात किए गए हैं:त्रुटि प्रबंधन
SDK इवेंट सिस्टम के माध्यम से विस्तृत त्रुटि जानकारी प्रदान करता है। हमेशा अपनेonEvent कॉलबैक में उचित त्रुटि प्रबंधन लागू करें:
सर्वोत्तम प्रथाएँ
- एक बार प्रारंभ करें: अपने एप्लिकेशन के लोड होने पर SDK को एक बार प्रारंभ करें, हर चेकआउट प्रयास पर नहीं
- त्रुटि प्रबंधन: हमेशा अपने इवेंट कॉलबैक में उचित त्रुटि प्रबंधन लागू करें
- टेस्ट मोड: विकास के दौरान
testमोड का उपयोग करें और उत्पादन के लिए तैयार होने परliveपर स्विच करें - इवेंट प्रबंधन: पूर्ण उपयोगकर्ता अनुभव के लिए सभी प्रासंगिक इवेंट्स को संभालें
- मान्य URLs: हमेशा create checkout session API से मान्य चेकआउट URLs का उपयोग करें
- TypeScript: बेहतर प्रकार की सुरक्षा और डेवलपर अनुभव के लिए TypeScript का उपयोग करें
- लोडिंग स्थिति: UX में सुधार के लिए चेकआउट खुलने के दौरान लोडिंग स्थिति दिखाएँ
- मैनुअल रीडायरेक्ट्स: जब आपको पोस्ट-चेकआउट नेविगेशन पर कस्टम नियंत्रण की आवश्यकता हो तो
manualRedirectका उपयोग करें - टाइमर प्रबंधन: यदि आप सत्र समाप्ति को मैन्युअल रूप से संभालना चाहते हैं तो टाइमर (
showTimer: false) को अक्षम करें
समस्या निवारण
चेकआउट नहीं खुल रहा है
चेकआउट नहीं खुल रहा है
संभावित कारण:
- SDK को
open()कॉल करने से पहले प्रारंभ नहीं किया गया - अमान्य चेकआउट URL
- कंसोल में JavaScript त्रुटियाँ
- नेटवर्क कनेक्टिविटी समस्याएँ
- सुनिश्चित करें कि SDK प्रारंभ करना चेकआउट खोलने से पहले होता है
- कंसोल त्रुटियों की जांच करें
- सुनिश्चित करें कि चेकआउट URL मान्य है और create checkout session API से है
- नेटवर्क कनेक्टिविटी की पुष्टि करें
इवेंट्स नहीं चल रहे हैं
इवेंट्स नहीं चल रहे हैं
संभावित कारण:
- इवेंट हैंडलर सही तरीके से सेट नहीं किया गया
- JavaScript त्रुटियाँ इवेंट प्रसारण को रोक रही हैं
- SDK सही तरीके से प्रारंभ नहीं किया गया
- पुष्टि करें कि इवेंट हैंडलर
Initialize()में सही तरीके से कॉन्फ़िगर किया गया है - JavaScript त्रुटियों के लिए ब्राउज़र कंसोल की जांच करें
- सुनिश्चित करें कि SDK प्रारंभ सफलतापूर्वक पूरा हुआ
- पहले एक सरल इवेंट हैंडलर के साथ परीक्षण करें
स्टाइलिंग समस्याएँ
स्टाइलिंग समस्याएँ
संभावित कारण:
- आपकी एप्लिकेशन शैलियों के साथ CSS संघर्ष
- थीम सेटिंग्स सही तरीके से लागू नहीं की गईं
- उत्तरदायी डिज़ाइन समस्याएँ
- ब्राउज़र DevTools में CSS संघर्षों की जांच करें
- सुनिश्चित करें कि थीम सेटिंग्स सही हैं
- विभिन्न स्क्रीन आकारों पर परीक्षण करें
- ओवरले के साथ कोई z-index संघर्ष नहीं है यह सुनिश्चित करें
एप्पल पे सक्षम करना
एप्पल पे ग्राहकों को उनके सहेजे गए भुगतान विधियों का उपयोग करके तेजी से और सुरक्षित रूप से भुगतान पूरा करने की अनुमति देता है। जब सक्षम किया जाता है, तो ग्राहक समर्थित उपकरणों पर चेकआउट ओवरले से सीधे एप्पल पे मोडल लॉन्च कर सकते हैं।एप्पल पे iOS 17+, iPadOS 17+, और macOS पर Safari 17+ पर समर्थित है।
1
एप्पल पे डोमेन एसोसिएशन फ़ाइल डाउनलोड और अपलोड करें
एप्पल पे डोमेन एसोसिएशन फ़ाइल डाउनलोड करें।फ़ाइल को अपने वेब सर्वर पर
/.well-known/apple-developer-merchantid-domain-association पर अपलोड करें। उदाहरण के लिए, यदि आपकी वेबसाइट example.com है, तो फ़ाइल को https://example.com/well-known/apple-developer-merchantid-domain-association पर उपलब्ध कराएँ।2
एप्पल पे सक्रियण का अनुरोध करें
ईमेल [email protected] निम्नलिखित जानकारी के साथ भेजें:
- आपका उत्पादन डोमेन URL (जैसे,
https://example.com) - अपने डोमेन के लिए एप्पल पे सक्षम करने का अनुरोध
आपको 1-2 कार्य दिवसों के भीतर पुष्टि प्राप्त होगी जब एप्पल पे आपके डोमेन के लिए सक्षम हो जाएगा।
3
एप्पल पे उपलब्धता की पुष्टि करें
पुष्टि प्राप्त करने के बाद, अपने चेकआउट में एप्पल पे का परीक्षण करें:
- समर्थित उपकरण (iOS 17+, iPadOS 17+, या macOS पर Safari 17+) पर अपने चेकआउट को खोलें
- सत्यापित करें कि एप्पल पे बटन भुगतान विकल्प के रूप में दिखाई देता है
- पूर्ण भुगतान प्रवाह का परीक्षण करें
ब्राउज़र समर्थन
Dodo Payments Checkout SDK निम्नलिखित ब्राउज़रों का समर्थन करता है:- क्रोम (नवीनतम)
- फ़ायरफ़ॉक्स (नवीनतम)
- सफारी (नवीनतम)
- एज (नवीनतम)
- IE11+
ओवरले बनाम इनलाइन चेकआउट
अपने उपयोग के मामले के लिए सही चेकआउट प्रकार चुनें:| विशेषता | ओवरले चेकआउट | इनलाइन चेकआउट |
|---|---|---|
| एकीकरण गहराई | पृष्ठ के शीर्ष पर मोडल | पृष्ठ में पूरी तरह से एम्बेडेड |
| लेआउट नियंत्रण | सीमित | पूर्ण नियंत्रण |
| ब्रांडिंग | पृष्ठ से अलग | निर्बाध |
| कार्यान्वयन प्रयास | कम | अधिक |
| सबसे अच्छा | त्वरित एकीकरण, मौजूदा पृष्ठ | कस्टम चेकआउट पृष्ठ, उच्च-परिवर्तन प्रवाह |
संबंधित संसाधन
इनलाइन चेकआउट
अपने पृष्ठ में पूरी तरह से एकीकृत अनुभवों के लिए चेकआउट को सीधे एम्बेड करें।
चेकआउट सत्र API
अपने चेकआउट अनुभवों को शक्ति देने के लिए चेकआउट सत्र बनाएं।
वेबहुक्स
वेबहुक्स के साथ सर्वर-साइड भुगतान घटनाओं को संभालें।
एकीकरण गाइड
Dodo Payments को एकीकृत करने के लिए पूर्ण गाइड।