प्रमाणीकरण
SupDesk API यहाँ रहता है:
https://api.supdesk.app/v1हर अनुरोध Bearer टोकन के रूप में भेजी गई API कुंजी से प्रमाणित होता है:
curl https://api.supdesk.app/v1/submissions \
-H "Authorization: Bearer sd_live_..."कुंजी बनाना
कंसोल में वर्कस्पेस सेटिंग्स → API कुंजियाँ के अंतर्गत कुंजियाँ बनाएँ। हर कुंजी:
- एक ही प्रोजेक्ट तक सीमित है — आप उसके ज़रिए जो कुछ पढ़ते या लिखते हैं वह उसी प्रोजेक्ट का होता है;
sd_live_जैसे पहचानने योग्य उपसर्ग से शुरू होती है, ताकि आप कॉन्फ़िग फ़ाइलों में कुंजियाँ उजागर किए बिना पहचान सकें;- बनाते समय एक बार दिखाई जाती है। SupDesk कुंजी का केवल हैश संग्रहीत करता है — यदि आप इसे खो दें, तो इसे रद्द करें और नई बनाएँ।
कुंजी संभालना
API कुंजियों को पासवर्ड की तरह मानें। API को केवल अपने सर्वर से कॉल करें — API में जानबूझकर CORS समर्थन नहीं है, ताकि कुंजियाँ ब्राउज़र से उपयोग न की जा सकें। यदि कोई कुंजी लीक हो जाए, तो उसे कंसोल में रद्द करें; रद्दीकरण तुरंत प्रभावी होता है।
विफल प्रमाणीकरण
अनुपस्थित, विकृत, रद्द या अज्ञात कुंजी हमेशा एक ही प्रतिक्रिया देती है, ताकि कॉलर यह न टटोल सकें कि कौन-सी कुंजियाँ मौजूद हैं:
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}पठन बनाम लेखन पहुँच
सभी योजनाएँ API के माध्यम से पढ़ सकती हैं। लेखन एंडपॉइंट (POST, PATCH, DELETE) के
लिए वर्कस्पेस का सशुल्क योजना पर होना आवश्यक है Pro — Free पर, लेखन
403 forbidden त्रुटि लौटाते हैं। देखें
दर सीमाएँ और उपयोग।