वर्ज़निंग

Partner API का संस्करण URL में होता है। वर्तमान संस्करण है:

https://partner-api.performancehub.co/partner/v1/

बदलाव नीति

Performance Hub जहाँ भी संभव हो, अतिरिक्त और पिछले संस्करणों के साथ संगत (backward-compatible) बदलाव करने का लक्ष्य रखता है।

पिछले संस्करणों के साथ संगत बदलावों के उदाहरण:

किसी अनुरोध में नया वैकल्पिक फ़ील्ड जोड़ना।
किसी रिस्पॉन्स में नया फ़ील्ड जोड़ना।
नया एंडपॉइंट जोड़ना।
ऐसा नया enum मान जोड़ना जहाँ क्लाइंट से अज्ञात मानों को संभालने की अपेक्षा की जाती है।
स्टेटस कोड अनुबंध बदले बिना सत्यापन संदेशों में सुधार करना।

access_time_windows और access_time_windows_revision अतिरिक्त Member अनुरोध फ़ील्ड हैं। जो मौजूदा क्लाइंट इन्हें छोड़ते हैं, उनका संग्रहीत Access Time Window स्नैपशॉट अपरिवर्तित रहता है। छोड़ने का यह नियम आंशिक-अपसर्ट संगतता बनाए रखता है; फ़ील्ड छोड़ना खाली ऐरे भेजने के बराबर नहीं है।

असंगत (breaking) बदलावों के उदाहरण:

किसी फ़ील्ड को हटाना या उसका नाम बदलना।
किसी फ़ील्ड का प्रकार बदलना।
किसी वैकल्पिक अनुरोध फ़ील्ड को आवश्यक बनाना।
किसी एंडपॉइंट को हटाना।
किसी मौजूदा स्टेटस कोड या डोमेन-विशिष्ट reason का अर्थ बदलना।

अप्रचलन

जब कोई असंगत बदलाव आवश्यक हो, तो Performance Hub जहाँ संभव हो, मौजूदा संस्करण को उसी जगह बदलने से बचेगा। इसके बजाय, हम एक नया संस्करण या माइग्रेशन पथ पेश करेंगे और प्रभावित पार्टनरों को बदलाव की सूचना देंगे।

अप्रचलन सूचनाओं में ये शामिल हो सकते हैं:

एक चेंजलॉग प्रविष्टि।
पार्टनर से सीधा संवाद।
Partner Console में नोट।
दस्तावेज़ों में माइग्रेशन मार्गदर्शन।

क्लाइंट के लिए अनुशंसाएँ

ऐसे क्लाइंट बनाएँ जो अतिरिक्त बदलावों को सहन कर सकें:

उन रिस्पॉन्स फ़ील्ड को अनदेखा करें जिनका आप उपयोग नहीं करते।
अज्ञात enum मानों को क्रैश होने के बजाय असमर्थित मानें।
रिस्पॉन्स की सख्त समानता जाँच से बचें।
अपरिचित मानों को लॉग करें ताकि आप अपने इंटीग्रेशन को सोच-समझकर अपडेट कर सकें।

Access Time Windows जैसे रिविज़न वाले Member विभाजनों के लिए, परिणाम ज्ञात होने तक सबमिट किए गए रिविज़न और सामान्यीकृत पेलोड को सहेजे रखें। बदली गई सामग्री के लिए किसी रिविज़न का दोबारा उपयोग करना कॉन्फ़्लिक्ट है, जबकि समान सामग्री को दोबारा भेजना आइडेम्पोटेंट है। Access Time Windows देखें।

OpenAPI विनिर्देश

क्लाइंट बनाने, अनुरोधों को सत्यापित करने और समय के साथ API के स्वरूप में बदलावों को ट्रैक करने के लिए प्रकाशित OpenAPI विनिर्देशों का उपयोग करें।

OpenAPI विनिर्देश देखें।