Developer पृष्ठ कस्टम इंटीग्रेशन बनाने के लिए Shifton की API दस्तावेज़ीकरण और डेवलपर टूल तक एक्सेस प्रदान करता है।
यह क्या है?
Developer पृष्ठ Shifton के साथ तकनीकी इंटीग्रेशन का प्रारंभिक बिंदु है। इसमें तीन टैब हैं: अवलोकन, Webhooks और Applications। अवलोकन टैब आपको वर्तमान और legacy दोनों API दस्तावेज़ीकरण के त्वरित लिंक देता है, जिनका उपयोग आप कस्टम इंटीग्रेशन बनाने, वर्कफ़्लो स्वचालित करने, या Shifton को अपने आंतरिक उपकरणों से जोड़ने के लिए कर सकते हैं।
पूर्व-आवश्यकताएँ
| आवश्यकता | विवरण |
|---|---|
| भूमिका | मालिक या |
| ज्ञान | API और वेब डेवलपमेंट की बुनियादी समझ (या ऐसे डेवलपर तक एक्सेस जो यह जानता हो) |
चरण-दर-चरण निर्देश
Developer पृष्ठ तक पहुँचना
अवलोकन टैब का उपयोग करना
अवलोकन टैब Shifton की API दस्तावेज़ीकरण के लिंक दिखाता है:
| लिंक | विवरण |
|---|---|
| नई दस्तावेज़ीकरण | वर्तमान, अप-टू-डेट API दस्तावेज़ीकरण के लिंक |
| पुराने दस्तावेज़ | पुराने इंटीग्रेशन के लिए legacy API दस्तावेज़ीकरण के लिंक |
अन्य Developer टैब पर नेविगेट करना
Developer पृष्ठ से, आप इन तक भी एक्सेस कर सकते हैं:
इन्हें अपने-अपने लेखों में विस्तार से कवर किया गया है।
एक्सेस अनुमतियाँ
| भूमिका | Developer पृष्ठ देखें | API दस्तावेज़ एक्सेस करें | Webhooks/Apps बनाएँ |
|---|---|---|---|
| मालिक | हाँ | हाँ | हाँ |
| हाँ | हाँ | हाँ | |
| प्रबंधक | नहीं | नहीं | नहीं |
| कर्मचारी | नहीं | नहीं | नहीं |
अक्सर पूछे जाने वाले प्रश्न
प्र: क्या डेवलपर पृष्ठ उपयोग करने के लिए प्रोग्रामिंग कौशल की आवश्यकता है?
उ: API दस्तावेज़ीकरण डेवलपर्स के लिए डिज़ाइन किया गया है। यदि आप एक non-technical प्रबंधक हैं, तो आप अपनी डेवलपमेंट टीम या IT विभाग के साथ दस्तावेज़ीकरण लिंक साझा कर सकते हैं।
प्र: मुझे कौन सा API दस्तावेज़ीकरण उपयोग करना चाहिए — नया या पुराना?
उ: सभी नए इंटीग्रेशन के लिए नई दस्तावेज़ीकरण उपयोग करें। पुराने दस्तावेज़ उन मौजूदा इंटीग्रेशन के साथ पिछड़ी संगतता के लिए प्रदान किया जाता है जो legacy API पर बनाए गए थे।
प्र: क्या API पर रेट लिमिट है?
उ: हाँ, API रेट लिमिट लागू हो सकती हैं। अनुरोध सीमाओं और सर्वोत्तम प्रथाओं के बारे में विशिष्ट विवरण के लिए API दस्तावेज़ीकरण देखें।
प्र: क्या मैं लाइव डेटा को प्रभावित किए बिना API कॉल परीक्षण कर सकता हूँ?
उ: यदि उपलब्ध हो तो परीक्षण वातावरण या sandbox मोड के बारे में जानकारी के लिए API दस्तावेज़ीकरण देखें।
संभावित समस्याएँ और समाधान
| समस्या | संभावित कारण | समाधान |
|---|---|---|
| Developer पृष्ठ साइडबार में दिखाई नहीं देता | आपके पास मालिक या भूमिका नहीं है | उपयुक्त भूमिका प्रदान करने के लिए अपने खाते के मालिक से पूछें |
| दस्तावेज़ीकरण लिंक एरर पृष्ठ पर ले जाता है | अस्थायी सेवा समस्या | बाद में पुनः प्रयास करें, या Shifton सहायता से संपर्क करें |
| कौन सा API संस्करण उपयोग करना है यह नहीं पता | मौजूदा इंटीग्रेशन के साथ काम कर रहे हैं | यह निर्धारित करने के लिए कि कौन सा संस्करण उपयोग किया जाता है, API endpoint URL के लिए अपना वर्तमान इंटीग्रेशन कोड जाँचें |
| API कुंजी दिखाई नहीं देती | पहले कुंजी उत्पन्न करनी पड़ सकती है | API कुंजी उत्पन्न करने के निर्देशों के लिए API दस्तावेज़ीकरण का पालन करें |