सीधे मुख्य कॉन्टेंट पर जाएं

टीचवर्क्स एपीआई

Teachworks Support द्वारा लिखा गया

टीचवर्क्स एपीआई एक एप्लिकेशन प्रोग्रामिंग इंटरफेस है जो आपको कस्टम इंटीग्रेशन और सॉफ्टवेयर विकसित करने के लिए आपके टीचवर्क्स खाते में मौजूद डेटा तक पहुंचने की अनुमति देता है।

नोट: एपीआई तक पहुंच केवल "ग्रोथ" और "प्रीमियम" सदस्यता वाली कंपनियों के लिए ही उपलब्ध है।

एपीआई को सक्षम करना

  1. "अकाउंट" पर क्लिक करें और फिर "इंटीग्रेशन और ऐड-ऑन" पर क्लिक करें।

  2. ऊपर दिए गए "खोज" फ़ील्ड का उपयोग करें और "एपीआई" दर्ज करें।

  3. एपीआई को सक्रिय करने के लिए टॉगल को "चालू" करें।

प्रयोग

API को सक्रिय करने के बाद, आप "सेटिंग्स" लिंक पर क्लिक कर सकते हैं। "जनरेट API टोकन" बटन पर क्लिक करके आप अपना Teachworks API टोकन जनरेट कर सकते हैं।

आप इस कुंजी का उपयोग एपीआई के माध्यम से अपने खाते तक पहुंचने के लिए करेंगे। इस कुंजी को पासवर्ड की तरह सुरक्षित रखें और इसे किसी भी सार्वजनिक वेब पेज में शामिल न करें (सार्वजनिक वेब पेजों के लिए इसका उपयोग सर्वर-साइड पर किया जाना चाहिए)।

यदि आप अपनी कंपनी के लाइव खाते से कनेक्ट करने से पहले अपने एपीआई इंटीग्रेशन का परीक्षण करने के लिए एक सैंडबॉक्स खाता बनाना चाहते हैं, तो आप "सैंडबॉक्स खाता बनाएं" बटन पर भी क्लिक कर सकते हैं।

एपीआई दस्तावेज़ीकरण

आप हमारे API के दस्तावेज़ यहाँ पा सकते हैं: Teachworks API दस्तावेज़। हम अतिरिक्त प्रकार के डेटा तक पहुँचने और रिकॉर्ड प्रबंधित करने के लिए API में अतिरिक्त एंडपॉइंट जोड़ेंगे।

यदि आप किसी ऐसे एंडपॉइंट में रुचि रखते हैं जो वर्तमान में उपलब्ध नहीं है, तो कृपया support@teachworks.com पर हमसे संपर्क करें और हम इसे जोड़ने पर विचार करेंगे।

क्या इससे आपके सवाल का जवाब मिला?