13
Rajapintaohje
TicketsX:n REST-rajapinnalla liität omat työkalusi palvelimesi tikettijärjestelmään. Luot, suljet ja hoidat tikettejä koodista ilman Discordin käyttöliittymää, haet koko tallennearkistostasi ja noudat minkä tahansa suljetun tiketin koko tekstin tai HTML:n.
REST-rajapinta on Premium-ominaisuus. Rajapinta-avaimia voi luoda ja käyttää vain silloin, kun palvelimella on voimassa oleva Premium-tilaus (katso hinnoittelusivu). Ilman Premiumia olevan palvelimen pyynnöt hylätään vastauksella 402 ja kentällä premium_required: true. Jos Premium päättyy, avaimesi säilytetään mutta ne eivät toimi, ennen kuin otat tilauksen taas käyttöön. Sillä välin voit silti listata, poistaa käytöstä ja mitätöidä ne hallintapaneelissa.
https://api.ticketsx.xyzJokainen pyyntö vaatii rajapinta-avaimen, joka lähetetään Bearer-avaimena Authorization-otsakkeessa. Avaimet koskevat yhtä palvelinta, ja niitä voi rajoittaa toimintokohtaisesti.
Authorization: Bearer <API_TOKEN>Korvaa alla olevissa päätepisteiden poluissa <guild_id> Discord-palvelimesi tunnuksella ja <ticket_id> kyseisen tiketin tunnuksella.
Kaikki POST-pyyntöjen rungot vaativat otsakkeen Content-Type: application/json. 4xx-vastauksissa on JSON-kenttä error; 401 tarkoittaa, että avain on virheellinen, vanhentunut tai mitätöity; 402 tarkoittaa, ettei palvelimella ole Premiumia (vastauksessa on myös premium_required: true); 403 tarkoittaa, että avain on poistettu käytöstä tai siltä puuttuu tarvittava oikeus; 429 tarkoittaa, että tuli raja vastaan (katso Rajat ja turvallisuus), ja mukana on arvo retry_after sekunteina.