अन्य सॉफ़्टवेयर को आपका डेटा पढ़ने की अनुमति देना
एपीआई स्टूडियो: एक समय में एक स्क्रीन प्रकाशित करना, एक कुंजी जारी करना, इसे एक पते पर पिन करना, और एआई एजेंट के लिए एमसीपी सर्वर के समान प्रकाशन करना।
कभी न कभी TRANXACT के बाहर किसी न किसी को आपके डेटा की आवश्यकता होगी: कोई रिपोर्टिंग टूल, किसी पार्टनर का सिस्टम, कोई वेबसाइट जिसे मूल्य सूची चाहिए, या कोई AI एजेंट जिसे आपके व्यवसाय के बारे में कोई प्रश्न पूछा गया हो। प्लेटफ़ॉर्म के अंतर्गत API स्टूडियो वह जगह है जहाँ आप तय करते हैं कि किस-किस को डेटा के रूप में इस्तेमाल किया जा सकता है — एक बार में एक स्क्रीन, एक बार में एक कॉलम।
जब तक कोई इसे प्रकाशित नहीं करता, तब तक बाहर से कुछ भी पहुंच योग्य नहीं होता। ऐसी कोई सेटिंग नहीं है जो सब कुछ खोल दे और न ही कोई कुंजी है जो सब कुछ तक पहुंच प्रदान करे। एक बिल्कुल नए डिप्लॉयमेंट में कोई एपीआई सतह नहीं होती, और यही सही शुरुआती स्थिति है, न कि कुछ ऐसा जो चालू होने की प्रतीक्षा कर रहा हो।
चारों निर्णय, क्रमानुसार
| क्या | यह क्या निर्णय लेता है | इसे आमतौर पर कौन बनाता है? |
|---|---|---|
| एक जोखिम | वह एक स्क्रीन इस कंपनी से पूरी तरह बाहर जा सकती है - इसके कौन से कॉलम, कौन सी पंक्तियाँ, और क्या कुछ वापस लिखा जा सकता है। | डेटा का मालिक कोई भी हो |
| एक ग्राहक | वह सॉफ्टवेयर मौजूद है, उसका नाम क्या है, उसके बारे में किससे संपर्क करना है, और वह आपके किस उपयोगकर्ता के रूप में कार्य करता है। | एकीकरण का संचालन जो भी करे |
| मदद | इन क्रियाओं के माध्यम से यह ग्राहक उस स्तर तक पहुंच सकता है। | एकीकरण का संचालन जो भी करे |
| एक अनुमत पता | कुंजी को ब्राउज़र स्रोत, होस्ट, सर्वर पते या नेटवर्क से प्रस्तुत किया जा सकता है। | एकीकरण का संचालन जो भी करे |
इस प्लेटफॉर्म पर इसके लिए तीन भूमिकाएँ हैं और इन्हें जानबूझकर अलग रखा गया है। API पब्लिशर यह तय करता है कि क्या प्रकाशित किया जा सकता है और वह कुंजी जारी नहीं कर सकता। API रजिस्ट्रार कुंजी जारी करता है और कोई जोखिम उत्पन्न नहीं कर सकता। API समीक्षक सब कुछ पढ़ता है और कुछ भी नहीं बदलता। एक ही व्यक्ति द्वारा पेरोल टेबल को प्रकाशित करना और उसे पढ़ने वाली कुंजी जारी करना एक पूर्ण, प्रत्यक्षदर्शी निर्यात प्रक्रिया है जिसमें हर चरण एक सामान्य प्रशासनिक परिवर्तन जैसा दिखता है।
स्क्रीन प्रकाशित करना
- ओपन प्लेटफ़ॉर्म → एपीआई स्टूडियो खोलें और एक स्क्रीन चुनें। सूची में कंसोल की सभी स्क्रीन शामिल हैं, जो उत्पाद से ही पढ़ी जाती हैं - इसलिए इस रिलीज़ में शामिल स्क्रीन भी इसमें मौजूद है।
- उन कॉलमों पर निशान लगाएँ जिन्हें छोड़ा जा सकता है। जिन कॉलमों पर निशान नहीं लगा है, उन्हें कभी भेजा नहीं जाता: न तो सूची में, न ही किसी एक रिकॉर्ड में, और न ही किसी राइट रिटर्न में। जानबूझकर, शुरू से ही किसी पर निशान नहीं लगाया जाता।
- क्रियाओं का चयन करें। 'पढ़ना' डिफ़ॉल्ट रूप से चालू है; 'बनाना', 'बदलना' और 'हटाना' प्रत्येक के लिए अलग-अलग निर्णय लेने होंगे, क्योंकि उनके सिस्टम को आपके आइटम मास्टर को पढ़ने देना और उनके सिस्टम को उसे हटाने देना एक ही वाक्य नहीं है।
- आप चाहें तो पंक्तियों को सीमित कर सकते हैं — केवल पोस्ट किए गए इनवॉइस, केवल इस वर्ष के इनवॉइस। यह वही फ़िल्टर है जो प्रत्येक सूची स्क्रीन पर दिखाई देता है, सर्वर पर हर कॉल पर लागू होता है, और कॉलर द्वारा भेजा गया कोई भी संदेश इसे विस्तृत नहीं कर सकता।
- इसे सहेज कर रखें। यह एक मसौदा है, और मसौदे से कुछ हासिल नहीं होता। जब आप इसे वास्तव में करना चाहें, तभी इसे प्रकाशित करें।
- किसी को भी कुंजी देने से पहले पूर्वावलोकन बटन दबाएँ। इससे आपको पता चल जाएगा कि आपके पार्टनर को क्या मिलेगा और कितने कॉलम छिपाए गए हैं।
सॉफ़्टवेयर का पंजीकरण
क्लाइंट किसी सॉफ़्टवेयर का रिकॉर्ड होता है: उसका नाम, वह क्या है, उसके बारे में किससे संपर्क करना है, और सबसे महत्वपूर्ण बात - वह आपके किस उपयोगकर्ता के रूप में कार्य करता है। कुंजी द्वारा की गई प्रत्येक कॉल उसी व्यक्ति के रूप में की जाती है। जो कार्य वे नहीं कर सकते, वह कार्य कुंजी भी नहीं कर सकती।
स्क्रीन पर यही सबसे महत्वपूर्ण क्षेत्र है, और यही कारण है कि किसी भी तरह की छूट से पहुंच को केवल सीमित किया जा सकता है, बढ़ाया नहीं जा सकता। कुंजी को उस उपयोगकर्ता की ओर निर्देशित करें जिसे इस उद्देश्य के लिए बनाया गया है और जिसके पास कार्य करने के लिए सबसे सीमित भूमिका है - न कि किसी वास्तविक प्रशासक की ओर, क्योंकि यह सुविधाजनक था।
कुंजी जारी होने पर केवल एक बार दिखाई देती है, और फिर कभी नहीं। नई कुंजी जारी करने पर पुरानी कुंजी तुरंत काम करना बंद कर देती है। क्लाइंट को हटाए बिना कुंजी वापस ली जा सकती है, इसलिए रजिस्टर में यह दर्ज रहता है कि किसने कुंजी का उपयोग किया और कब उसे वापस लिया गया।
जहां से चाबी का उपयोग किया जा सकता है
बिना अनुमति वाले पतों वाली कुंजी किसी काम की नहीं होती। बिना बताए गए पतों को अभी तक अप्राप्य माना जाता है और न ही कभी कहीं से भी अप्राप्य माना जा सकता है, क्योंकि दुनिया के किसी भी लैपटॉप से काम करने वाली लीक हुई कुंजी ही सारा जोखिम है। प्रवेश के चार प्रकार हैं: ब्राउज़र स्रोत, संदर्भ देने वाला होस्ट, एकल पता या CIDR प्रारूप में नेटवर्क।
किसी क्लाइंट को कहीं से भी उपयोग करने योग्य के रूप में चिह्नित किया जा सकता है, और कभी-कभी यह सही होता है - एक ऐसा पार्टनर जिसका निकास पता वास्तव में बदल जाता है। यह डिफ़ॉल्ट सेटिंग नहीं है, बल्कि जानबूझकर किया गया एक बदलाव है जिसके साथ एक चेतावनी भी दी गई है।
एकीकरण करने वाले किसी भी व्यक्ति को क्या भेजना है
स्टूडियो चारों पते प्रिंट करता है। बेस /api/v1 है, कुंजी Authorization: Bearer हेडर में जाती है, /api/v1/resources उन सभी स्रोतों को सूचीबद्ध करता है जहाँ यह कुंजी पहुँच सकती है, और /api/v1/openapi.json एक OpenAPI 3.1 दस्तावेज़ के समान है।
ये दोनों ही उस कुंजी से उत्पन्न होते हैं जो इनकी मांग करती है। किसी पार्टनर को कभी भी ऐसा दस्तावेज़ नहीं दिया जाता जिसमें चालीस ऐसे एंडपॉइंट्स सूचीबद्ध हों जिन्हें वे कॉल नहीं कर सकते: उनके दस्तावेज़ में केवल उन्हीं एंडपॉइंट्स का वर्णन होता है जिन्हें वे कॉल कर सकते हैं, और इसमें ऐसे किसी पथ का वर्णन नहीं होता जिसे अस्वीकार कर दिया जाए, क्योंकि यह उन्हीं पंक्तियों से बना होता है जिनकी जांच अनुरोध हैंडलर करता है।
एआई एजेंट के लिए भी यही डेटा उपलब्ध है।
पता /api/v1/mcp एक मॉडल कॉन्टेक्स्ट प्रोटोकॉल सर्वर है। इससे कनेक्ट होने वाले एजेंट को कुंजी द्वारा किए जा सकने वाले प्रत्येक कार्य के लिए एक टूल प्रदान किया जाता है और कुछ नहीं - किसी भी प्रकाशित डेटा के लिए कोई टूल नहीं, किसी भी क्रिया के लिए कोई टूल नहीं जिसे किसी ने अनुमति नहीं दी है। यह वही प्रकाशन है, जिसे डेवलपर के बजाय मॉडल के लिए वर्णित किया गया है, इसलिए दोनों कभी भी एक-दूसरे से अलग नहीं हो सकते।
क्लाइंट पर MCP निर्देश लिखें। यही एकमात्र स्थान है जहाँ मॉडल को बताया जाता है कि ये उपकरण सैंडबॉक्स के बजाय लाइव लेजर तक पहुँचते हैं, और यही एकमात्र स्थान है जहाँ आप कह सकते हैं कि यहाँ ऑर्डर का अर्थ खरीद ऑर्डर है, न कि बिक्री ऑर्डर।
हर कॉल पर क्या होता है
प्रकाशित कॉल डेटाबेस में सीधे प्रवेश करने का शॉर्टकट नहीं है। इसकी प्रमाणीकरण प्रक्रिया होती है, एक्सपोज़र और ग्रांट के आधार पर इसकी जाँच की जाती है, और फिर प्लेटफ़ॉर्म के अपने API के माध्यम से आपके रन-एज़ उपयोगकर्ता के रूप में इसे किया जाता है — ठीक उसी मार्ग से जिसका उपयोग कंसोल करता है। कंपनी स्कोपिंग, बिज़नेस-यूनिट स्कोपिंग, स्थान प्रतिबंध, बंद अवधि, पोस्टिंग नियम, कस्टम फ़ील्ड, कस्टम लॉजिक, संपादन क्षमता और ऑडिट ट्रेल सभी लागू होते हैं, क्योंकि ये सभी एक ही कोड द्वारा संचालित होते हैं।
हर कॉल रिकॉर्ड की जाती है, चाहे उसे अनुमति दी गई हो या अस्वीकार किया गया हो, साथ ही उसका कारण भी बताया जाता है। यह लॉग Platform → API Studio → API Call Log के अंतर्गत उपलब्ध है, और किसी ऐसे पते से भेजी गई कुंजी, जिसे किसी ने अनुमति नहीं दी थी, इस लॉग में मौजूद सबसे दिलचस्प पंक्ति है।
जब यह काम नहीं करता है
| साथी क्या देखता है | इसका क्या मतलब है |
|---|---|
| वह एपीआई कुंजी पहचानी नहीं गई है | गलत चाबी है, या उसके बाद कोई नई चाबी जारी की गई है। |
| इस API कुंजी में कोई भी पता मान्य नहीं है। | अभी तक किसी ने यह नहीं बताया है कि इसका उपयोग कहाँ से किया जा सकता है। |
| इस एपीआई कुंजी का उपयोग यहां से करने की अनुमति नहीं है। | इसमें उस स्रोत और पते का उल्लेख होता है जहां से वास्तव में डेटा पहुंचा है — आमतौर पर पार्टनर ने सर्वर बदल दिए होते हैं। |
| यहां X के रूप में कुछ भी प्रकाशित नहीं किया गया है | नाम गलत है, या इस कुंजी को सार्वजनिक करने की अनुमति नहीं है, या यह अभी भी एक मसौदा है। |
| यह कुंजी X उत्पन्न नहीं कर सकती है | यह अनुमति या अनुदान उस क्रिया की अनुमति नहीं देता है। |
| आपको X देखने की अनुमति नहीं है | ग्रांट तो ठीक है, लेकिन रन-एज़ यूज़र ठीक नहीं है। स्टूडियो इन्हें पार्टनर द्वारा खोजे जाने से पहले ही सूचीबद्ध कर देता है। |
क्लाइंट सूची में केवल स्थिति के बजाय तत्परता कॉलम दिखाया जाता है, क्योंकि एक क्लाइंट सक्रिय हो सकता है, कुंजी धारण कर सकता है और फिर भी किसी भी स्थिति तक नहीं पहुंच सकता है - चलाने के लिए कोई उपयोगकर्ता नहीं, कोई पता अनुमत नहीं, कुछ भी स्वीकृत नहीं। हर कॉल के अस्वीकृत होने के बावजूद सक्रिय स्थिति पढ़ना एक दोपहर का समय होता है।