/v1 के तहत सर्व किया जाता है।
एक कुंजी बनाएं और एक अनुरोध करें
- Dashboard
- CLI
- Administration → Keys खोलें, Create key चुनें, और सबसे संकीर्ण अनुमति प्रीसेट चुनें जो इंटीग्रेशन को कवर करे।
- आवश्यकता पड़ने पर ही व्यक्तिगत अनुदान जोड़ें, कुंजी बनाएं, और इसका एकबारी रहस्य कॉपी करें।
-
/v1/sessionsको एक परीक्षण अनुरोध करें और पुष्टि करें कि कुंजी Keys पृष्ठ पर सक्रिय रहती है। -
जब इंटीग्रेशन स्वामित्व बदले तो इसकी कार्य मेनू से कुंजी को रोटेट या अक्षम करें।
403 लौटाता है और लापता अनुमति की पहचान करता है।
संगठन चयन
एक संगठन कुंजी स्वचालित रूप से अपने संगठन पर कार्य करती है। एक इंस्टेंस-स्कोप की गई कुंजी प्रति अनुरोध एक संगठन चुन सकती है:- Dashboard
- CLI
डैशबोर्ड हेडर में संगठन स्विचर का उपयोग करें और फिर Administration → Keys खोलें। वहां बनाई गई कुंजियां चयनित संगठन की हैं। क्रेडेंशियल को ऑटोमेशन में कॉपी करने से पहले URL और कुंजी विवरण में संगठन स्लग की पुष्टि करें।
/v1 राउटर के विरुद्ध जांचा जाता है।
वर्तमान विनिर्देश में संपूर्ण मार्ग, विधि, पैरामीटर, अनुमति, और स्थिति-कोड कवरेज है। कुछ प्रतिक्रिया निकाय जानबूझकर बिना प्रकार के रहते हैं क्योंकि सर्वर अभी भी उन्हें गतिशील JSON के रूप में बनाता है। प्रतिक्रिया स्कीमा के बिना किसी एंडपॉइंट के चारों ओर एक दृढ़ रूप से टाइप किए गए क्लाइंट को उत्पन्न करने से पहले एक वास्तविक प्रतिक्रिया का निरीक्षण करें।
JSON लेखन के लिए Content-Type: application/json का उपयोग करें। 401 को लापता या अमान्य प्रमाणीकरण के रूप में, 403 को आवश्यक अनुमति के बिना एक वैध पहचान के रूप में, 404 को एक लापता या संगठन-अनुपलब्ध संसाधन के रूप में, 409 को एक स्थिति संघर्ष के रूप में, और 422 को एक अमान्य क्षेत्र या अनुमति मान के रूप में मानें। त्रुटि प्रतिक्रियाएं एक मानव-पठनीय संदेश शामिल करती हैं; अनुमति विफलताएं आवश्यक अनुदान का नाम भी देती हैं।