वर्शन

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

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

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

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

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

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

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

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

बंद करने की नीति

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

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

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

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

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

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