Tapatybės tikrinimas

API raktai kuriami ir tvarkomi TicketsX valdymo pulto serverio šoninėje juostoje. Kiekvienas raktas susietas su vienu serveriu, o kad jį sukurtumėte ar naudotumėte, serveris turi turėti veikiančią Premium prenumeratą.

Rakto kūrimas

Įjunkite serveriui Premium puslapyje Premium (puslapis API prieiga veda tiesiai ten).
Atverkite serverio šoninę juostą ir eikite į API prieiga.
Duokite raktui pavadinimą (pavyzdžiui, "Pagalbos botas" arba "CRM sąsaja").
Spustelėkite Kurti raktą ir nusikopijuokite parodytą reikšmę.
Padėkite ją į slaptų duomenų saugyklą; užvėrus pranešimą jos nebematysite.

Jei Premium baigia galioti

Jūsų raktai neištrinami. Kiekviena API užklausa ima grąžinti 402 su lauku premium_required: true, o raktų kūrimas ir keitimas užblokuojami, kol prenumerata vėl ims galioti. Raktų peržiūra, išjungimas ir atšaukimas veikia toliau, tad susitvarkyti galėsite bet kuriuo atveju. Savo sąsajoje 402 tvarkykite taip pat kaip 401: liaukitės kartoję bandymus ir praneškite žmogui.

Atsakymas, kai serveris neturi Premium

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

Atšauktas raktas iškart tampa netinkamas visuose galiniuose taškuose. Jei pertrūkio negalite sau leisti, pirma pasidarykite raktą jam pakeisti.

Rakto naudojimas

Raktą siųskite Bearer antraštėje su kiekviena užklausa. Visos užklausos galioja tik tam serveriui, kuriame raktas sukurtas.

Užklausos su patikrinta tapatybe pavyzdys

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