Dokumentacija

Nauči TicketsX brže

Upute za postavljanje, popis svih naredbi, mogućnosti Premiuma i REST API na jednom mjestu.

13.1

Provjera identiteta

API ključevi stvaraju se i vode iz bočne trake poslužitelja u nadzornoj ploči TicketsX-a. Svaki ključ vezan je uz jedan poslužitelj, a za njegovo stvaranje ili korištenje poslužitelj mora imati aktivnu Premium pretplatu.

Stvaranje ključa

  • Uključite Premium za poslužitelj na stranici Premium (stranica Pristup API-ju vodi ravno onamo).
  • Otvorite bočnu traku poslužitelja i idite na Pristup API-ju.
  • Dajte ključu naziv (na primjer "Bot podrške" ili "Veza s CRM-om").
  • Kliknite Stvori ključ i kopirajte prikazanu vrijednost.
  • Spremite je u trezor za tajne podatke; nakon zatvaranja obavijesti više je nećete vidjeti.

Ako Premium istekne

Vaši ključevi ne brišu se. Svaki zahtjev API-ju počinje vraćati 402 s poljem premium_required: true, a stvaranje i zamjena ključeva blokirani su dok pretplata ponovno ne proradi. Pregled, isključivanje i poništavanje ključeva i dalje rade, pa možete pospremiti što treba. U svojoj vezi 402 obradite jednako kao 401: prestanite ponavljati pokušaje i obavijestite čovjeka.

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

Poništavanje ključa odmah ga čini neupotrebljivim na svim krajnjim točkama. Ako ne smijete imati prekid, najprije napravite zamjenski ključ.

Korištenje ključa

Ključ šaljite kao Bearer zaglavlje uz svaki zahtjev. Svi zahtjevi vrijede samo za poslužitelj na kojem je ključ nastao.

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