API दस्तावेज़ीकरण
शुरू करना
प्रमाणीकरण
REST API दो क्रेडेंशियल शैलियों का समर्थन करता है। अंतिम उपयोगकर्ता साइन-इन किए गए ऐप में डेवलपर्स के अंतर्गत एक व्यक्तिगत एक्सेस टोकन बनाते हैं, फिर इसे ऑथराइजेशन बियरर om_pat_… के रूप में भेजते हैं। फर्म और पार्टनर इंटीग्रेशन इसके बजाय आपके डिप्लॉयमेंट (एडमिन → बाहरी ऐप्स) के लिए ओबरमाइंड ऑपरेशंस द्वारा जारी किए गए एप्लिकेशन क्रेडेंशियल - ऐप टोकन और सीक्रेट कुंजी - का उपयोग कर सकते हैं। एप्लिकेशन क्रेडेंशियल ऐप में अंतिम उपयोगकर्ताओं को नहीं दिखाए जाते हैं। प्रत्येक गुप्त कुंजी को सुरक्षित रूप से संग्रहीत करें; उन्हें कभी भी ब्राउज़र पर भेजे गए क्लाइंट-साइड कोड में एम्बेड न करें। केवल इस ब्राउज़र सत्र के क्रेडेंशियल के साथ परीक्षण करने के लिए प्रत्येक एंडपॉइंट पर 'ट्राई इट' पैनल का उपयोग करें।
वातावरण
इंटीग्रेशन बनाते और टेस्ट करते समय डेवलपमेंट एनवायरनमेंट का उपयोग करें। प्रोडक्शन क्रेडेंशियल और बेस यूआरएल तब जारी किए जाते हैं जब आपका डिप्लॉयमेंट लाइव हो जाता है। कोड सैंपल डिफ़ॉल्ट रूप से डेवलपमेंट API होस्ट पर चलते हैं, जब तक कि आपकी कंपनी कोई दूसरा एंडपॉइंट कॉन्फ़िगर न कर दे।
प्लेटफ़ॉर्म का अवलोकन
ओबरमाइंड प्लेटफ़ॉर्म ब्रांडेड वेब और मोबाइल ऐप्स, एक मल्टी-टैब ट्रेडिंग टर्मिनल, पोर्टफोलियो और जोखिम संबंधी टूलिंग, और एडमिन बैक-ऑफिस को एक ही प्लेटफ़ॉर्म पर एकीकृत करता है। API इस साइट पर मौजूद दस्तावेज़ बताते हैं कि आपका एकीकरण इन प्लेटफ़ॉर्म से कैसे जुड़ता है — यह कोई अलग उत्पाद नहीं है।
उपयोगकर्ता इंटरफेस
व्यापारी टर्मिनल, इंस्ट्रूमेंट पेज और मोबाइल ऐप के माध्यम से बातचीत करते हैं। आपका एकीकरण आम तौर पर REST APIके विरुद्ध सर्वर-टू-सर्वर चलता है, जबकि WebSocket फ़ीड उन यूआई के भीतर लाइव कोट और पोर्टफोलियो अपडेट को शक्ति प्रदान करते हैं।
