डेवलपर्स के लिए API संदर्भ

अपना ऐप अपने वर्कस्पेस से जोड़ें: REST API, उसकी कुंजियाँ और स्कोप, त्रुटियाँ, दर सीमाएँ और वेबहुक।

यह कहाँ मिलेगा

⚙️ सेटिंग्स › API संदर्भ · होम पेज › संसाधन › API संदर्भ

यह स्क्रीन खोलें
साइड मेनू, प्रमाणीकरण और एंडपॉइंट के साथ API संदर्भ।

चरण

  1. साइडबार में “API संदर्भ” खोलें, या होम पेज के “संसाधन” मेनू में “API संदर्भ”।
  2. “यहाँ से शुरू करें” से शुरू करें: “बेस URL और परिपाटियाँ”, “प्रमाणीकरण” और “स्कोप”।
  3. “एंडपॉइंट” समूह के अनुसार देखें; हर एक अपने पैरामीटर, अनुरोध बॉडी, जवाब और त्रुटियाँ उदाहरणों के साथ दिखाता है।
  4. लाइव जाने से पहले “त्रुटियाँ और स्टेटस कोड”, “दर सीमाएँ” और “वेबहुक (आउटबाउंड)” पढ़ें। “OpenAPI JSON” पूरा विनिर्देश डाउनलोड करता है।

समस्या निवारण

मुझे API कुंजी कैसे मिलेगी?

कुंजियाँ अनुरोध पर आपके वर्कस्पेस के लिए जारी की जाती हैं; उन्हें अभी ऐप में नहीं बनाया जा सकता। आपके वर्कस्पेस की कुंजियाँ AI क्षेत्र के डेवलपर पेज पर सूचीबद्ध हैं, जहाँ वर्कस्पेस संभालने वाले लोग वेबहुक एंडपॉइंट भी जोड़ और परख सकते हैं।

सुझाव

  • API को केवल अपने सर्वर से कॉल करें। कुंजी को कभी वेब पेज या मोबाइल ऐप में न रखें।

जानने योग्य बातें

  • API संदर्भ साइन इन किए बिना पढ़ा जा सकता है।

संबंधित हाउ-टू

मुफ़्त शुरू करें होम