शतरंज रेटिंग एपीआई दस्तावेज़ीकरण

एपीआई तीन प्राथमिक गणना वर्कफ़्लो का समर्थन करता है: एकल-गेम रेटिंग परिवर्तन (दो रेटिंग, एक परिणाम और एक के-फैक्टर दिया गया), बैच प्रोसेसिंग (एक अनुरोध में कई गेम रिकॉर्ड), और प्रारंभिक रेटिंग अनुमान (औसत प्रतिद्वंद्वी रेटिंग, स्कोर और गेम गिनती)। प्रत्येक समापन बिंदु कैलकुलेटर पृष्ठों पर दिखाए गए समान विस्तृत आउटपुट देता है, जिसमें अपेक्षित स्कोर, रेटिंग डेल्टा और अनुमानित नई रेटिंग शामिल है। कार्यान्वयन और सत्यापन विवरण के लिए कार्यप्रणाली देखें पढ़ें।

टूर्नामेंट-मोड एंडपॉइंट प्रतिद्वंद्वी रेटिंग और परिणामों की एक क्रमबद्ध सरणी स्वीकार करते हैं, प्रति-राउंड ब्रेकडाउन और संचयी योग लौटाते हैं। सभी प्रतिक्रियाओं में मेटाडेटा शामिल है कि कौन सा नियम प्रोफ़ाइल लागू किया गया था ताकि डाउनस्ट्रीम उपभोक्ता गणना मान्यताओं को सत्यापित कर सकें।

एपीआई एक्सेस के लिए प्राधिकरण हेडर में बियरर टोकन के रूप में पारित एपीआई कुंजी की आवश्यकता होती है। चाबियाँ निःशुल्क और प्रीमियम स्तरों में उपलब्ध हैं। निःशुल्क टियर प्रति बैच अनुरोध पर अधिकतम 10 गेम के साथ प्रति दिन 100 अनुरोधों की अनुमति देता है। प्रीमियम कुंजियाँ उच्च थ्रूपुट, प्राथमिकता समर्थन और बल्क टूर्नामेंट प्रोसेसिंग एंडपॉइंट तक पहुंच को अनलॉक करती हैं।

दर सीमाएँ प्रति कुंजी लागू होती हैं, प्रति आईपी पते पर नहीं। सीमा से अधिक होने पर रिट्री-आफ्टर हेडर के साथ 429 स्थिति मिलती है जो यह बताती है कि अगली अनुरोध विंडो कब खुलेगी। प्रत्येक सफल अनुरोध के प्रतिक्रिया शीर्षलेखों में सभी सीमाएं दर्ज की जाती हैं।

प्रत्येक एपीआई प्रतिक्रिया में एक नियम_प्रोफ़ाइल फ़ील्ड शामिल होता है जो दर्शाता है कि गणना के लिए मान्यताओं का कौन सा सेट उपयोग किया गया था (उदाहरण के लिए, fide_2024, us_chess_current, जेनेरिक_एलो)। जब फ़ेडरेशन के नियम बदलते हैं, तो एपीआई मौजूदा प्रोफ़ाइल को संशोधित करने के बजाय एक नया प्रोफ़ाइल संस्करण जोड़ता है। इसका मतलब है कि डाउनस्ट्रीम सिस्टम एक विशिष्ट प्रोफ़ाइल संस्करण को पिन कर सकते हैं और अपने शेड्यूल पर अपग्रेड कर सकते हैं।

एपीआई चेंजलॉग और डेवलपर मेलिंग सूची के माध्यम से ब्रेकिंग परिवर्तनों को कम से कम 30 दिन पहले सूचित किया जाता है। गैर-ब्रेकिंग परिवर्धन (नए वैकल्पिक फ़ील्ड, नए प्रोफ़ाइल) मौजूदा एकीकरणों को बाधित किए बिना लगातार तैनात किए जाते हैं।

एपीआई कॉल को कम करने के लिए जब भी संभव हो स्थानीय स्तर पर बार-बार गणना को कैश करें। टूर्नामेंट वर्कफ़्लो के लिए, क्रमिक एकल-गेम अनुरोध करने के बजाय बैच एंडपॉइंट का उपयोग करें। सर्वर डिफॉल्ट पर निर्भर रहने के बजाय हमेशानियम_प्रोफ़ाइल पैरामीटर को स्पष्ट रूप से शामिल करें, ताकि एपीआई नई प्रोफ़ाइल जोड़ने पर भी आपका एकीकरण नियतात्मक बना रहे।

क्लब सॉफ़्टवेयर और कोचिंग डैशबोर्ड के लिए, गणना किए गए परिणाम और नियम_प्रोफ़ाइल संस्करण दोनों को संग्रहीत करने पर विचार करें ताकि आप बाद में फेडरेशन के नियम बदलने पर ऑडिट या पुनर्गणना कर सकें। यह आधिकारिक रिपोर्टिंग वर्कफ़्लो के लिए विशेष रूप से महत्वपूर्ण है जहां ऐतिहासिक सटीकता मायने रखती है।