13
API aprašas
TicketsX REST API leidžia savo įrankius sujungti su serverio bilietų sistema. Bilietus kuriate, uždarote ir tvarkote iš kodo, neužeidami į Discord sąsają, ieškote visame įrašų archyve ir pasiimate bet kurio uždaryto bilieto visą tekstą ar HTML.
REST API yra Premium galimybė. API raktus kurti ir naudoti galima tik tol, kol serveris turi veikiančią Premium prenumeratą (žiūrėkite kainų puslapį). Užklausos iš serverio be Premium atmetamos su 402 ir lauku premium_required: true. Premium pasibaigus, jūsų raktai lieka, bet nustoja veikti, kol vėl jo neįjungsite. Tuo metu juos vis tiek galite peržiūrėti, išjungti ir atšaukti valdymo pulte.
https://api.ticketsx.xyzKiekvienai užklausai reikia API rakto, siunčiamo kaip Bearer raktas Authorization antraštėje. Raktai galioja vienam serveriui ir gali būti apriboti kiekvienam veiksmui atskirai.
Authorization: Bearer <API_TOKEN>Visuose toliau pateiktuose keliuose vietoj <guild_id> įrašykite savo Discord serverio identifikatorių, o vietoj <ticket_id> - atitinkamo bilieto identifikatorių.
Visiems POST užklausų turiniams reikia Content-Type: application/json. 4xx atsakymuose būna JSON laukas error; 401 reiškia, kad raktas netinkamas, baigė galioti arba atšauktas; 402 reiškia, kad serveris neturi Premium (atsakyme būna ir premium_required: true); 403 reiškia, kad raktas išjungtas arba jam trūksta reikiamos teisės; o 429 reiškia, kad pasiekta riba (žiūrėkite Ribas ir saugumą) ir kartu pateikiama retry_after reikšmė sekundėmis.