API रेफ़रेंस

Sursa का पब्लिक API: 35 सेक्शन में 222 एंडपॉइंट। वर्शन 1.62.0।

API कुंजी से ऑथेंटिकेट होने वाले इंटीग्रेशन के लिए Sursa का पब्लिक API। /v1 के अंदर बदलाव सिर्फ़ जोड़ने वाले होते हैं: नए ऑपरेशन, वैकल्पिक पैरामीटर, रिस्पॉन्स के फ़ील्ड और रिस्पॉन्स में नए enum मान आ सकते हैं, और मौजूदा क्लाइंट काम करते रहते हैं। रिस्पॉन्स में अनजान enum मानों को मान्य मानें।

बेस URL: https://api.sursa.com
ऑथेंटिकेशन: Authorization हेडर में API कुंजी भेजें: Authorization: Bearer <कुंजी>।

सेक्शन

health1 एंडपॉइंट

सर्विस का स्टेटस और वर्शन

auth1 एंडपॉइंट

साइन-इन, सेशन, “View as” मोड (दूसरे की नज़र से देखना), पासवर्ड बदलना और रीसेट करना, आमंत्रण स्वीकार करना

users5 एंडपॉइंट

संगठन के यूज़र अकाउंट

api-keys9 एंडपॉइंट

संगठन की API कुंजियाँ

apps8 एंडपॉइंट

संगठन के OAuth ऐप और कर्मचारियों के ऑथराइज़ेशन

oauth3 एंडपॉइंट

OAuth 2.0 प्रोटोकॉल: सहमति स्क्रीन, टोकन जारी करना और रद्द करना, ऑथराइज़ेशन सर्वर का मेटाडेटा

audit4 एंडपॉइंट

संगठन का ऑडिट लॉग

org1 एंडपॉइंट

संगठन, उसका लोगो और डेटा एक्सपोर्ट

categories4 एंडपॉइंट

दस्तावेज़ों की कैटेगरी

collections6 एंडपॉइंट

नॉलेज कलेक्शन

cards26 एंडपॉइंट

नॉलेज कार्ड: अपलोड, कंटेंट, टेबल, वर्शन, सत्यापन, कमेंट

jobs5 एंडपॉइंट

इंडेक्सिंग की कतार: जॉब, पार्सिंग प्रीव्यू, बदलावों की स्ट्रीम (SSE)

conversations2 एंडपॉइंट

असिस्टेंट के साथ बातचीत

answers3 एंडपॉइंट

खोज और असिस्टेंट के जवाब, SSE स्ट्रीम समेत

access-requests4 एंडपॉइंट

छिपे हुए जवाब के स्रोतों तक ऐक्सेस के लिए रिक्वेस्ट

questions10 एंडपॉइंट

सवालों का लॉग, सुझाव, जवाबों का एक्सपोर्ट, लाइव जवाब

files8 एंडपॉइंट

एक्सपोर्ट फ़ाइलें

insights1 एंडपॉइंट

इनसाइट्स: सारांश, डुप्लिकेट, नॉलेज गैप और नॉलेज हेल्थ

tasks1 एंडपॉइंट

यूज़र और टीम के टास्क

sources19 एंडपॉइंट

डेटा स्रोत, जैसे Google Drive और Confluence

permissions17 एंडपॉइंट

ऐक्सेस मॉडल: अनुमतियों की रजिस्ट्री और संगठन, कलेक्शन, कार्ड और स्रोतों पर अनुमतियाँ, सीधी भी और विरासत में मिली भी

roles4 एंडपॉइंट

रोल: अनुमतियों के नाम वाले सेट, बिल्ट-इन और कस्टम

groups7 एंडपॉइंट

यूज़र ग्रुप: सामान्य ग्रुप, “All members” (सभी सदस्य), रोल ग्रुप और निजी ग्रुप

folders7 एंडपॉइंट

कलेक्शन के फ़ोल्डर: तीन स्तर तक गहरा ट्री, पड़ोसी आइटम के सापेक्ष क्रम, एक कार्ड कई फ़ोल्डरों में, विरासत में मिली अनुमतियाँ

catalog6 एंडपॉइंट

बाहरी सर्विसों (SaaS और वेंडर) का कैटलॉग, जिसमें नाम, वेबसाइट, कैटेगरी, आइकन और विवरण हैं, और आपके संगठन के नामों और कैटलॉग की एंट्री के बीच लिंक

drafts6 एंडपॉइंट

ड्राफ़्ट और प्रकाशन की मंज़ूरी

verification9 एंडपॉइंट

सत्यापन: स्टेटस, समीक्षा की तारीख़ें, वेरिफ़ायर, इतिहास, “पहले सत्यापित करें” कतार, ट्रस्ट स्कोर और ऑफ़बोर्डिंग

announcements5 एंडपॉइंट

“ज़रूर पढ़ें” घोषणाएँ: ऑडियंस, पढ़ने की पुष्टि, रिपोर्ट, रिमाइंडर, एक्सपोर्ट

comments4 एंडपॉइंट

कार्ड पर थ्रेड वाले कमेंट, ऐंकर और स्टेटस के साथ, और रिएक्शन

webhooks17 एंडपॉइंट

संगठन के वेबहुक: वेबहुक की सेटिंग, इवेंट सब्सक्रिप्शन, सिग्नेचर, डिलीवरी और रीट्राई

public-api1 एंडपॉइंट

इंटीग्रेशन के लिए पब्लिक API: इस API का मशीन से पढ़ा जा सकने वाला स्पेसिफ़िकेशन

uploads5 एंडपॉइंट

बड़ी फ़ाइलों के मल्टीपार्ट अपलोड: सेशन, हिस्से, जाँच के साथ पूरा करना, और कार्ड, आर्काइव या इम्पोर्ट में इस्तेमाल

analytics4 एंडपॉइंट

प्रोडक्ट एनालिटिक्स: इस्तेमाल के इवेंट, हर ऑब्जेक्ट के काउंटर, हेल्थ, इस्तेमाल और योगदान डैशबोर्ड, रिन्यूअल रिपोर्ट और एक्सपोर्ट

quality3 एंडपॉइंट

जवाबों की गुणवत्ता: बिना अच्छे जवाब वाले सवाल और काम में लिए गए नॉलेज गैप

finance6 एंडपॉइंट

वित्तीय दस्तावेज़: विनिमय दरें और काउंटरपार्टी डायरेक्टरी