एपीआई पहुंच और प्रमाणीकरण

SPREEAI अनुमोदित भागीदार वर्कफ़्लो के लिए एक सार्वजनिक API संदर्भ प्रदान करता है: https://docs.spreeai.com/swagger/public/.

पहुँच मॉडल

API का दायरा, वातावरण, क्रेडेंशियल और अनुमत संचालन पार्टनर ऑनबोर्डिंग के दौरान तय किए जाते हैं। यह न मानें कि कोई आंतरिक, विकास या ऐतिहासिक एंडपॉइंट प्रोडक्शन में उपलब्ध है।

क्रेडेंशियल नियम

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

ब्राउज़र बनाम सर्वर

वेब एसडीके पार्टनर द्वारा जारी ब्राउज़र कॉन्फ़िगरेशन का उपयोग करता है। ब्राउज़र में क्लाइंट सीक्रेट शामिल नहीं होना चाहिए।

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

वेबहुक

सर्वर-पुश वेबहुक वर्तमान में प्रकाशित वेब एसडीके दस्तावेज़ का हिस्सा नहीं हैं। किसी भी वेबहुक की आवश्यकता होने पर ही उस पर निर्भरता डिज़ाइन करें।

पर्यावरण चेकलिस्ट

[ ] पर्यावरण का नाम प्रलेखित है।
[ ] मूल यूआरएल स्वीकृत संदर्भ या ऑनबोर्डिंग हैंडऑफ़ से आया है।
[ ] उस वातावरण के लिए क्रेडेंशियल जारी किए गए थे।
[ ] गुप्त जानकारी सर्वर-साइड पर संग्रहीत की जाती है।
[ ] लॉग टोकन और ग्राहक छवियों को संपादित करते हैं।
लेखन कार्यों के लिए टाइमआउट, पुनः प्रयास और आइडमपोटेंसी व्यवहार पर सहमति हो गई है।
[ ] उत्पादन पहुंच का उपयोग करने से पहले एक गैर-उत्पादन परीक्षण सफल होता है।