API दस्तावेज़

TicketsX का REST API आपको बाहरी औज़ारों को अपने सर्वर की टिकट व्यवस्था से जोड़ने देता है। Discord का पर्दा खोले बिना कोड से टिकट बनाएँ, बंद करें और सँभालें, अपने पूरे रिकॉर्ड संग्रह में खोजें, और किसी भी बंद टिकट का पूरा पाठ या HTML ले आएँ।

REST API एक Premium सुविधा है। API टोकन सिर्फ़ तभी बनाए और इस्तेमाल किए जा सकते हैं जब सर्वर की Premium सदस्यता चालू हो (क़ीमत पृष्ठ देखें)। Premium के बिना सर्वर से आए अनुरोध 402 और premium_required: true फ़ील्ड के साथ ठुकरा दिए जाते हैं। Premium ख़त्म होने पर आपके टोकन रखे तो रहते हैं, पर दोबारा चालू करने तक काम करना बंद कर देते हैं। इस बीच भी आप डैशबोर्ड से उन्हें देख, बंद कर और रद्द कर सकते हैं।

बेस URLhttps://api.ticketsx.xyz

Bearer Token

हर अनुरोध के लिए API टोकन चाहिए, जो Authorization हेडर में Bearer टोकन के रूप में भेजा जाता है। टोकन एक ही सर्वर के लिए चलते हैं और हर काम के हिसाब से सीमित किए जा सकते हैं।

Authorization: Bearer <API_TOKEN>

नीचे दिए सभी एंडपॉइंट पथों में <guild_id> की जगह अपने Discord सर्वर की आईडी और <ticket_id> की जगह उस टिकट की आईडी लिखें।

हर POST अनुरोध की सामग्री के लिए Content-Type: application/json ज़रूरी है। 4xx जवाबों में JSON का error फ़ील्ड होता है; 401 का मतलब है कि टोकन ग़लत है, उसकी अवधि ख़त्म हो गई है या उसे रद्द किया जा चुका है; 402 का मतलब है कि सर्वर के पास Premium नहीं है (जवाब में premium_required: true भी आता है); 403 का मतलब है कि टोकन बंद है या उसके पास ज़रूरी अनुमति नहीं है; और 429 का मतलब है कि कोई सीमा पार हो गई (सीमाएँ और सुरक्षा देखें) और इसमें सेकंडों में retry_after मान भी आता है।