Tunnistautuminen

Rajapinta-avaimet luodaan ja niitä hallitaan TicketsX-hallintapaneelin palvelimen sivupalkista. Kukin avain liittyy yhteen palvelimeen, ja avaimen luominen tai käyttö vaatii palvelimelta voimassa olevan Premium-tilauksen.

Avaimen luominen

Ota palvelimen Premium käyttöön sivulla Premium (Rajapintakäyttö-sivulta on sinne suora linkki).
Avaa palvelimen sivupalkki ja siirry kohtaan Rajapintakäyttö.
Anna avaimelle nimi (esimerkiksi "Tukibotti" tai "CRM-yhteys").
Napsauta Luo avain ja kopioi näkyvä arvo.
Säilytä se salaisuuksien hallinnassa; ilmoituksen sulkemisen jälkeen sitä ei näe enää.

Jos Premium päättyy

Avaimiasi ei poisteta. Kaikki rajapintapyynnöt alkavat palauttaa vastausta 402 ja kenttää premium_required: true, eikä avaimia voi luoda tai vaihtaa ennen kuin tilaus on taas voimassa. Avainten listaaminen, käytöstä poistaminen ja mitätöinti toimivat edelleen, joten voit siivota joka tapauksessa. Käsittele 402 liitoksessasi samoin kuin 401: lopeta uudelleenyritykset ja ilmoita ihmiselle.

Vastaus, kun palvelimella ei ole Premiumia

{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Avaimen mitätöinti tekee siitä heti kelvottoman kaikissa päätepisteissä. Jos et halua katkoa, luo korvaava avain ensin.

Avaimen käyttö

Lähetä avain Bearer-otsakkeessa jokaisen pyynnön mukana. Kaikki pyynnöt koskevat vain sitä palvelinta, jolla avain luotiin.

Esimerkki tunnistautuneesta pyynnöstä

curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets