वर्शन

इस गाइड में बताया गया है कि Merchant API, वर्शनिंग, रिलीज़, और इसके अलग-अलग वर्शन के लाइफ़साइकल को कैसे मैनेज करता है.

वर्शनिंग स्कीम

Merchant API, सब-एपीआई लेवल पर वर्शनिंग की रणनीति का इस्तेमाल करता है. इसका मतलब है कि हर Merchant API, जैसे कि Merchant API में मौजूद प्रॉडक्ट का अपना वर्शन लाइफ़साइकल होगा.

वर्शनिंग का फ़ॉर्मैट और प्रज़ेंटेशन

• सब-एपीआई के स्टेबल वर्शन: अगर कोई सब-एपीआई स्टेबल वर्शन में है, तो उसके सभी तरीके भी स्टेबल वर्शन में होंगे. एपीआई के स्टेबल सब-एपीआई वर्शन को vX के तौर पर दिखाया जाता है. उदाहरण के लिए, v1, v2. ये प्रोडक्शन के लिए तैयार किए गए मुख्य वर्शन हैं.

• ऐल्फ़ा सब-एपीआई वर्शन: अगर कोई सब-एपीआई ऐल्फ़ा वर्शन में है, तो उसके सभी तरीके ऐल्फ़ा वर्शन में होंगे. ऐल्फ़ा सब-एपीआई वर्शन को vXalpha के तौर पर दिखाया जाता है. उदाहरण के लिए, v1alpha, v2alpha. इनमें एक्सपेरिमेंट के तौर पर उपलब्ध ऐसी सुविधाएं होती हैं जिन्हें टेस्ट करने और तेज़ी से दोहराने के लिए बनाया गया है. अल्फ़ा वर्शन के स्टेबल होने की कोई गारंटी नहीं होती. साथ ही, इनकी कोई तय समयसीमा नहीं होती. इन्हें 30 दिनों के नोटिस के साथ बदला या बंद किया जा सकता है.

वर्शन के परिवर्तन

• मेजर वर्शन में बढ़ोतरी (उदाहरण के लिए, v1 से v2): ये सिग्नल, पुराने सिस्टम के साथ काम न करने वाले और बड़े बदलावों के बारे में बताते हैं. इसके लिए, डेवलपर को कार्रवाई करनी होती है. सिर्फ़ स्टेबल सब-एपीआई में हुए बड़े बदलावों के लिए, नया वर्शन नंबर होगा. उदाहरण के लिए, v1 से v2.
• मामूली बदलाव: पुराने सिस्टम के साथ काम करने वाले नए वर्शन में जोड़े गए फ़ंक्शन या ठीक की गई गड़बड़ियों को मौजूदा मेजर वर्शन में हुए बदलावों के तौर पर दिखाया जाता है. इस तरह के बदलावों के बारे में, उस मुख्य वर्शन के रिलीज़ नोट में जानकारी दी जाएगी. सब-एपीआई में किए गए ऐसे बदलाव जो मौजूदा एपीआई को नहीं तोड़ते हैं उन्हें नए स्टेबल वर्शन के ऐल्फ़ा चैनल में रिलीज़ किया जाएगा या सीधे तौर पर नए स्टेबल वर्शन में रिलीज़ किया जाएगा.

सेवा बंद करने से जुड़ी नीति

हम समय-समय पर, Merchant sub-API के पुराने वर्शन बंद करते रहते हैं. हम स्टेबल मेजर वर्शन (vX) के लिए, 12 महीने की अवधि में बंद करने की प्रोसेस को पूरा करने का वादा करते हैं. यह प्रोसेस, आधिकारिक तौर पर बंद करने का एलान होने के बाद शुरू होती है.

उदाहरण के लिए, अगर हम 15 जनवरी, 2026 को Products sub-API के v1 को बंद कर देते हैं, तो यह 15 जनवरी, 2027 से पहले बंद नहीं होगा. इस तारीख के बाद, सब-एपीआई का पुराना वर्शन इस्तेमाल नहीं किया जा सकेगा.

सब-एपीआई का वर्शन और लाइफ़साइकल स्टेटस

यहां दी गई टेबल में, Merchant API के हर सब-एपीआई के सबसे नए वर्शन दिए गए हैं:

सबसे सही तरीके

• नए वर्शन, बड़े अपडेट, सुधारों, और सब-एपीआई लॉन्च और बंद होने के बारे में सूचनाएं पाने के लिए, रिलीज़ नोट और नए अपडेट समय-समय पर देखें.
• अगर किसी सब-एपीआई के दो या इससे ज़्यादा स्टेबल वर्शन हैं, तो हमारा सुझाव है कि हमेशा सबसे नए वर्शन का इस्तेमाल करें.
• अपने ऐप्लिकेशन को इस तरह से डिज़ाइन करें कि वह सब-एपीआई से जुड़ी अलग-अलग गड़बड़ियों को आसानी से ठीक कर सके. जैसे, नेटवर्क से जुड़ी समस्याएं, दर की सीमाएं, और गड़बड़ी के नए कोड या मैसेज. ये गड़बड़ियां, सब-एपीआई के नए वर्शन के साथ आ सकती हैं.
• अपग्रेड करने की योजना बनाने के लिए, किसी सब-एपीआई वर्शन के बंद होने का इंतज़ार न करें. नए वर्शन उपलब्ध होते ही, उनका आकलन और टेस्टिंग शुरू करें.
• अगर आपको किसी सुविधा का अनुरोध करना है या सब-एपीआई के रोडमैप के बारे में कोई समस्या है, तो हमसे संपर्क करें और अपने सवाल पूछें या सुझाव/राय/शिकायत दें. तकनीकी सहायता पाने के लिए, Merchant API की टीम से संपर्क करने के तरीके के बारे में जानने के लिए, Merchant API से जुड़ी सहायता पाना लेख पढ़ें.