भाषा चुनें

डेवलपर अवलोकन

Developer पृष्ठ कस्टम इंटीग्रेशन बनाने के लिए Shifton की API दस्तावेज़ीकरण और डेवलपर टूल तक एक्सेस प्रदान करता है।


यह क्या है?

Developer पृष्ठ Shifton के साथ तकनीकी इंटीग्रेशन का प्रारंभिक बिंदु है। इसमें तीन टैब हैं: Overview, Webhooks और Applications। Overview टैब आपको वर्तमान और legacy दोनों API दस्तावेज़ीकरण के त्वरित लिंक देता है, जिनका उपयोग आप कस्टम इंटीग्रेशन बनाने, वर्कफ़्लो स्वचालित करने, या Shifton को अपने आंतरिक उपकरणों से जोड़ने के लिए कर सकते हैं।


पूर्व-आवश्यकताएँ

आवश्यकताविवरण
भूमिकाOwner या
ज्ञानAPI और वेब डेवलपमेंट की बुनियादी समझ (या ऐसे डेवलपर तक एक्सेस जो यह जानता हो)

चरण-दर-चरण निर्देश

Developer पृष्ठ तक पहुँचना

1
बाईं साइडबार से इंटीग्रेशन पर क्लिक करें।
2
डेवलपर
पृष्ठ पर जाएँ।
3
आप शीर्ष पर तीन टैब देखेंगे: अवलोकन, वेबहुक, और आवेदन

Overview टैब का उपयोग करना

Shifton screenshot

Overview टैब Shifton की API दस्तावेज़ीकरण के लिंक दिखाता है:

लिंकविवरण
नई दस्तावेज़ीकरणवर्तमान, अप-टू-डेट API दस्तावेज़ीकरण के लिंक
पुराने दस्तावेज़पुराने इंटीग्रेशन के लिए legacy API दस्तावेज़ीकरण के लिंक
1
वर्तमान API संदर्भ को नए टैब में खोलने के लिए नई दस्तावेज़ीकरण पर क्लिक करें।
2
यदि आपके पास पुराने API पर बना मौजूदा इंटीग्रेशन है, तो legacy संदर्भ एक्सेस करने के लिए पुराने दस्तावेज़ पर क्लिक करें।

अन्य Developer टैब पर नेविगेट करना

Developer पृष्ठ से, आप इन तक भी एक्सेस कर सकते हैं:

1
वेबहुक
टैब — Shifton से रियल-टाइम इवेंट नोटिफिकेशन प्राप्त करने के लिए webhook endpoints सेट करें।
2
आवेदन
टैब — Shifton के साथ इंटीग्रेट होने वाले कस्टम एप्लिकेशन बनाएँ और प्रबंधित करें।

इन्हें अपने-अपने लेखों में विस्तार से कवर किया गया है।


एक्सेस अनुमतियाँ

भूमिकाDeveloper पृष्ठ देखेंAPI दस्तावेज़ एक्सेस करेंWebhooks/Apps बनाएँ
Ownerहाँहाँहाँ
हाँहाँहाँ
Managerनहींनहींनहीं
Employeeनहींनहींनहीं

FAQ

प्र: क्या डेवलपर पृष्ठ उपयोग करने के लिए प्रोग्रामिंग कौशल की आवश्यकता है?
उ: API दस्तावेज़ीकरण डेवलपर्स के लिए डिज़ाइन किया गया है। यदि आप एक non-technical Manager हैं, तो आप अपनी डेवलपमेंट टीम या IT विभाग के साथ दस्तावेज़ीकरण लिंक साझा कर सकते हैं।

प्र: मुझे कौन सा API दस्तावेज़ीकरण उपयोग करना चाहिए — नया या पुराना?
उ: सभी नए इंटीग्रेशन के लिए नई दस्तावेज़ीकरण उपयोग करें। पुराने दस्तावेज़ उन मौजूदा इंटीग्रेशन के साथ पिछड़ी संगतता के लिए प्रदान किया जाता है जो legacy API पर बनाए गए थे।

प्र: क्या API पर रेट लिमिट है?
उ: हाँ, API रेट लिमिट लागू हो सकती हैं। अनुरोध सीमाओं और सर्वोत्तम प्रथाओं के बारे में विशिष्ट विवरण के लिए API दस्तावेज़ीकरण देखें।

प्र: क्या मैं लाइव डेटा को प्रभावित किए बिना API कॉल परीक्षण कर सकता हूँ?
उ: यदि उपलब्ध हो तो परीक्षण वातावरण या sandbox मोड के बारे में जानकारी के लिए API दस्तावेज़ीकरण देखें।


संभावित समस्याएँ और समाधान

समस्यासंभावित कारणसमाधान
Developer पृष्ठ साइडबार में दिखाई नहीं देताआपके पास Owner या भूमिका नहीं हैउपयुक्त भूमिका प्रदान करने के लिए अपने खाते के Owner से पूछें
दस्तावेज़ीकरण लिंक एरर पृष्ठ पर ले जाता हैअस्थायी सेवा समस्याबाद में पुनः प्रयास करें, या Shifton सहायता से संपर्क करें
कौन सा API संस्करण उपयोग करना है यह नहीं पतामौजूदा इंटीग्रेशन के साथ काम कर रहे हैंयह निर्धारित करने के लिए कि कौन सा संस्करण उपयोग किया जाता है, API endpoint URL के लिए अपना वर्तमान इंटीग्रेशन कोड जाँचें
API कुंजी दिखाई नहीं देतीपहले कुंजी उत्पन्न करनी पड़ सकती हैAPI कुंजी उत्पन्न करने के निर्देशों के लिए API दस्तावेज़ीकरण का पालन करें