वर्शन

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

वर्शन स्कीम

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

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

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

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

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

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

सनसेट नीति

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

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

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

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

सब-एपीआई वर्शन स्थिति
खाते v1
v1alpha
चालू
चालू
कन्वर्ज़न v1 चालू है
डेटा सोर्स v1 चालू है
इन्वेंट्री v1 चालू है
समस्या का हल v1 चालू है
Local feeds partnership v1 चालू है
सूचनाएं v1 चालू है
ऑर्डर ट्रैकिंग v1 चालू है
प्रॉडक्ट v1 चालू है
Product Studio v1alpha चालू है
प्रचार v1 चालू है
कोटा v1 चालू है
रिपोर्ट v1 चालू है
समीक्षाएं v1alpha चालू है

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

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