API
प्रमाणीकरण
एक वर्कस्पेस कुंजी के साथ Mandavo API को प्रमाणित करें, और उससे सीमित-दायरे एजेंट क्रेडेंशियल बनाएं।
वर्कस्पेस कुंजियां
प्रशासनिक कॉल — पहचान बनाना, पॉलिसी लिखना, क्रेडेंशियल जारी करना — एक वर्कस्पेस कुंजी से प्रमाणित होते हैं। सेटिंग्स में एक बनाएं और इसे Authorization हेडर में एक बियरर टोकन के रूप में भेजें।
वर्कस्पेस कुंजियां केवल आपके बैकएंड के लिए हैं। वे कभी किसी एजेंट तक नहीं जातीं; एजेंट उन अल्पकालिक क्रेडेंशियल के साथ काम करते हैं जो आप उनके लिए बनाते हैं।
बेस URL और संस्करणीकरण
सभी अनुरोध https://api.mandavo.com पर जाते हैं और पथ उपसर्ग द्वारा संस्करणित होते हैं, /v1 से शुरू होकर। ब्रेकिंग परिवर्तन एक नए उपसर्ग के तहत भेजे जाते हैं; योगात्मक परिवर्तन नहीं।
अनुरोध और जवाब JSON हैं। किसी भी बॉडी वाले अनुरोध पर Content-Type: application/json भेजें।
एजेंट क्रेडेंशियल
किसी एजेंट को कार्य करने देने के लिए, इश्यूएंस इंजन के माध्यम से एक वर्कस्पेस कुंजी को एक सीमित-दायरे क्रेडेंशियल के लिए एक्सचेंज करें, फिर केवल वह अल्पकालिक टोकन एजेंट को सौंपें। टोकन पहचान, दायरा, और एक समाप्ति रखता है।
एजेंट क्रेडेंशियल को एकल-कार्य और मेमोरी-में मानें। उन्हें बनाए न रखें; अगले कार्य के लिए एक नया अनुरोध करें।
त्रुटियां
API मानक HTTP स्थिति कोड का उपयोग करता है। 401 का मतलब है कुंजी गायब है या अमान्य है, 403 का मतलब है क्रिया कॉलर के दायरे से बाहर है या पॉलिसी द्वारा अस्वीकृत है, और 429 का मतलब है आप रेट-सीमित हैं। त्रुटि बॉडी में एक मशीन-पठनीय कोड और एक मानव-पठनीय संदेश शामिल है।