API सन्दर्भ

सार्वजनिक API विकासकर्ताहरूको लागि अन्तःफार्महरू, विजेटहरू, उत्पादन कन्फिगररहरू र अधिक।

यो सन्दर्भले केवल वास्तविक, सार्वजनिक रूपमा प्रयोग गर्न सकिने JSON एन्डपोइन्टहरूको मात्र विवरण दिन्छ -- प्रत्येक एन्डपोइन्टको मेथड, पथ, प्रमाणीकरणको प्रकार, अनिवार्य प्यारामिटरहरू, उदाहरण request र response तथा दस्तावेजीकृत त्रुटि कोडहरू। Zentor मा डेभलपरहरूका लागि कुनै सामान्य API कुञ्जी प्रणाली छैन; रुटअनुसार पहुँच या त प्रमाणीकरणबिना हुन्छ, या origin जाँचसहितको विजेट एम्बेड टोकनमार्फत हुन्छ। आन्तरिक ड्यासबोर्ड रुटहरू र Master Admin एन्डपोइन्टहरू जानाजानी यो सार्वजनिक सन्दर्भमा समावेश गरिएका छैनन्, किनभने तिनीहरू नियमित लगइन सत्रमार्फत मात्र पहुँचयोग्य छन्।

प्रत्येक एन्डपोइन्ट प्रविष्टिमा एउटा लाइभ-टेस्ट टिप्पणी हुन्छ, जसले जानकारी registry schema, स्वचालित परीक्षण वा वास्तविक लाइभ अवलोकनमध्ये कुनबाट आएको हो भनेर खुलाउँछ -- काम गरिरहेको कोड पथसँगको केवल समानतालाई पूर्ण प्रमाण मानिँदैन। प्राविधिक रूपमा सफल कलले पनि सधैँ सम्बन्धित request को प्रशोधन मात्र पुष्टि गर्छ, इमेल डेलिभरी, भुक्तानी सम्पन्नता वा सम्पन्न SSO लगइनजस्ता पछिल्ला प्रक्रियाहरू स्वतः पुष्टि गर्दैन।

सुरक्षा सम्बन्धित समूहमा निर्भर गर्छ। सार्वजनिक कानुनी, मार्केटिङ र फारम एन्डपोइन्टहरूलाई ड्यासबोर्ड सत्र आवश्यक पर्दैन। अर्कोतर्फ, च्याट विजेटले `X-Widget-Token` हेडर र origin allowlist प्रयोग गर्छ। ड्यासबोर्ड लगइनले बाह्र घण्टा अवधिको session JWT र सात दिनसम्म मान्य refresh token दिन्छ। SSO एन्डपोइन्टहरू आफ्नै एकपटके कोड र callback प्रक्रियाहरूसँग काम गर्छन्।

प्रत्येक एन्डपोइन्ट पृष्ठलाई स्वतन्त्र सम्झौताका रूपमा पढ्नुहोस्। HTTP मेथड, पथ, अनिवार्य प्यारामिटरहरू, डेटा प्रकारहरू, request body, response संरचना, त्रुटि कोडहरू र idempotency निर्णायक हुन्छन्। उदाहरणले एउटा सम्भावित ढाँचा देखाउँछ, तर वास्तविक जवाफको जाँचको विकल्प हुँदैन। कन्फिगरेसन स्थिति, प्रमाणीकरण जाँच (validation), अनुमतिहरू र बाह्य प्रदायकहरूले नतिजा परिवर्तन गर्न सक्छन्।

पुष्टि गरिएको प्लेटफर्मव्यापी rate limit 15 मिनेटभित्र 2,000 request हो। प्रत्येक एन्डपोइन्टका छुट्टै सीमाहरू सबै ठाउँमा दस्तावेजीकृत छैनन्। त्यसैले क्लाइन्टहरूले अनावश्यक रूपमा छोटो अन्तरालका polling लूपहरू प्रयोग गर्नु हुँदैन। idempotent नभएका कार्यहरूमा स्वचालित पुनःप्रयासले दोहोरो रेकर्ड वा सन्देशहरू सिर्जना गर्न सक्छ।

संवेदनशील मानहरू लगमा राख्नु हुँदैन। यसमा पासवर्ड, रिसेट टोकन, प्रमाणीकरण कोड, विजेट टोकन, session ID र वास्तविक व्यक्तिगत उदाहरण डेटा पर्छन्। दस्तावेज र परीक्षणहरूमा अज्ञात (anonymized) मानहरू प्रयोग गर्नुहोस्। लाइभ-टेस्ट टिप्पणीहरूले वास्तविक प्रमाणलाई सही रूपमा प्रतिबिम्बित गर्नुपर्छ।

प्रमाणिकरण (5)लगइन, टोकन नवीकरण, पासवर्ड रिसेट, SSO विनिमय।सार्वजनिक फारामहरू (11)सम्पर्क, परामर्शको लागि अनुरोध, पहुँचको लागि अनुरोध, खाता सक्रियता।उत्पादन कन्फिगरर (5)प्याकेज सूची, मूल्य पूर्वानुमान, इमेल प्रमाणिकरण, कन्फिगरेसन फाइल।सार्वजनिक सामग्री (6)कानूनी पाठ, मार्केटिङ पृष्ठ, विषयवस्तु र पाठ रंग कन्फिगरेसन।च्याट विजेट (9)सबै अन्त बिन्दुहरु जुन ग्राहकको वेबसाइटमा इम्बेडेड च्याट विजेटले प्रयोग गर्दछ।डेमो च्याटबट र SSO (13)सार्वजनिक डेमो च्याटबट र एकल साइन-अन अन्त्यहरू।
← पुनः समीक्षामा जानुहोस्