API-संदर्भ

यह संदर्भ केवल वास्तविक, सार्वजनिक रूप से उपयोग योग्य JSON एंडपॉइंट का वर्णन करता है -- हर एंडपॉइंट के लिए मेथड, पाथ, प्रमाणीकरण का प्रकार, अनिवार्य पैरामीटर, उदाहरण रिक्वेस्ट और रिस्पॉन्स, तथा दस्तावेज़ित एरर कोड। Zentor में डेवलपर्स के लिए कोई सामान्य API-की सिस्टम नहीं है; रूट के अनुसार एक्सेस या तो बिना प्रमाणीकरण के होता है या Origin जाँच के साथ विजेट एम्बेड टोकन के ज़रिए। आंतरिक डैशबोर्ड रूट और Master Admin एंडपॉइंट जानबूझकर इस सार्वजनिक संदर्भ का हिस्सा नहीं हैं, क्योंकि वे केवल सामान्य लॉग-इन सत्र के ज़रिए ही उपलब्ध हैं।

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

सुरक्षा संबंधित समूह पर निर्भर करती है। सार्वजनिक कानूनी, मार्केटिंग और फ़ॉर्म एंडपॉइंट के लिए डैशबोर्ड सत्र की आवश्यकता नहीं होती। वहीं चैट विजेट हेडर `X-Widget-Token` और एक Origin अनुमति सूची का उपयोग करता है। डैशबोर्ड लॉगिन बारह घंटे की वैधता वाला सत्र JWT और सात दिनों तक वैध रिफ़्रेश टोकन देते हैं। SSO एंडपॉइंट अपने स्वयं के वन-टाइम कोड और कॉलबैक प्रक्रियाओं के साथ काम करते हैं।

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

पुष्टि की गई प्लेटफ़ॉर्म-व्यापी रेट लिमिट 15 मिनट में 2,000 रिक्वेस्ट है। प्रत्येक एंडपॉइंट की अलग-अलग सीमाएँ हर जगह दस्तावेज़ित नहीं हैं। इसलिए क्लाइंट्स को अनावश्यक रूप से तंग पोलिंग लूप का उपयोग नहीं करना चाहिए। गैर-आइडेम्पोटेंट ऑपरेशनों में स्वचालित पुनःप्रयास डुप्लिकेट रिकॉर्ड या संदेश बना सकते हैं।

संवेदनशील मान लॉग में नहीं होने चाहिए। इनमें पासवर्ड, रीसेट टोकन, सत्यापन कोड, विजेट टोकन, सत्र ID और वास्तविक व्यक्तिगत उदाहरण डेटा शामिल हैं। दस्तावेज़ीकरण और टेस्ट में अनाम मानों का उपयोग करें। लाइव-टेस्ट टिप्पणियों को वास्तविक प्रमाण को सही ढंग से दर्शाना चाहिए।