Skip to main content
सार्वजनिक API आपके Failproof AI डैशबोर्ड origin पर /v1 के तहत उपलब्ध है।

​
कुंजी बनाएं और अनुरोध करें

  1. Administration → Keys खोलें, Create key चुनें, और वह सबसे संकीर्ण अनुमति प्रीसेट चुनें जो आपके integration को कवर करे।
  2. केवल आवश्यकता होने पर ही अलग-अलग grants जोड़ें, कुंजी बनाएं, और इसका एकबारी secret कॉपी करें।
  3. /v1/sessions के लिए एक परीक्षण अनुरोध करें और Keys पृष्ठ पर पुष्टि करें कि कुंजी सक्रिय रहती है।
  4. जब integration की स्वामित्व बदले, तो इसके action मेनू से कुंजी को rotate या disable करें। अनुमति presets और अलग-अलग grants के साथ नई API कुंजी drawer।
ऊपर दिखाई गई creation drawer है। एकबारी secret केवल तभी दिखाई देता है जब आप create चुनते हैं; उस पुष्टि को बंद करने से पहले इसे कॉपी करें।
कुंजियां एक organization और permission set के लिए scoped हैं। endpoint की आवश्यक अनुमति के बिना एक अनुरोध 403 लौटाता है और missing अनुमति की पहचान करता है।

​
Organization selection

एक organization कुंजी अपने organization पर स्वचालित रूप से कार्य करती है। एक instance-scoped कुंजी प्रति अनुरोध एक organization चुन सकती है:
Administration → Keys खोलने से पहले डैशबोर्ड header में organization switcher का उपयोग करें। वहां बनाई गई कुंजियां चयनित organization से संबंधित हैं। URL और कुंजी विवरण में organization slug की पुष्टि करें, फिर credential को automation में कॉपी करें।
इस section में जेनरेट किए गए endpoint पृष्ठों का उपयोग करें वर्तमान paths, parameters, permission आवश्यकताओं, और status codes के लिए। विशिष्टता server route annotations से जेनरेट की गई है और /v1 router के विरुद्ध जांची गई है। वर्तमान विशिष्टता में पूर्ण route, method, parameter, permission, और status-code कवरेज है। कुछ response bodies जानबूझकर untyped हैं क्योंकि server अभी भी उन्हें dynamic JSON के रूप में बनाता है। किसी endpoint के चारों ओर एक strongly typed client जेनरेट करने से पहले एक वास्तविक response की जांच करें जिसके पास response schema नहीं है। JSON writes के लिए Content-Type: application/json का उपयोग करें। 401 को missing या invalid authentication के रूप में, 403 को required permission के बिना एक valid identity के रूप में, 404 को missing या organization-inaccessible resource के रूप में, 409 को एक state conflict के रूप में, और 422 को एक invalid field या permission value के रूप में मानें। Error responses में एक human-readable message शामिल होता है; permission failures required grant का नाम भी देती हैं।
Policy enforcement deployment को जानबूझकर सामान्य सार्वजनिक /v1 surface के बाहर प्रबंधित किया जाता है। समर्थित Cloud deployment workflow का उपयोग करें।