Dokumentáció

Tanuld meg gyorsabban a TicketsX-et

Beállítási útmutatók, a teljes parancslista, a Premium funkciói és a REST API egy helyen.

13.1

Hitelesítés

Az API-kulcsokat a TicketsX vezérlőpultján, a szerver oldalsávjából hozod létre és kezeled. Minden kulcs egyetlen szerverhez tartozik, és a létrehozásához meg a használatához a szervernek élő Prémium előfizetés kell.

Kulcs létrehozása

  • Kapcsold be a szerver Prémiumát a Prémium oldalon (az API-hozzáférés oldala közvetlenül odavezet).
  • Nyisd meg a szerver oldalsávját, és lépj az API-hozzáférés menüpontra.
  • Adj nevet a kulcsnak (például "Támogatói bot" vagy "CRM-kapcsolat").
  • Kattints a Kulcs létrehozása gombra, és másold ki a megjelenő értéket.
  • Tedd el titokkezelőbe; miután bezárod az üzenetet, többé nem látod.

Ha a Prémium lejár

A kulcsaidat nem töröljük. Minden API-kérés 402 választ ad a premium_required: true mezővel, a kulcsok létrehozása és cseréje pedig addig tiltott, amíg az előfizetés újra él. A kulcsok listázása, kikapcsolása és visszavonása továbbra is működik, így bármikor rendet tehetsz. A 402 választ ugyanúgy kezeld a rendszeredben, mint a 401-et: hagyd abba az újrapróbálkozást, és szólj egy embernek.

A válasz, amikor a szervernek nincs Prémiuma
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

A kulcs visszavonása azonnal érvénytelenné teszi minden végponton. Ha nem engedhetsz meg kiesést, előbb hozd létre az új kulcsot.

A kulcs használata

Minden kérésnél küldd el a kulcsot Bearer fejlécben. Minden kérés csak arra a szerverre vonatkozik, ahol a kulcs készült.

Példa hitelesített kérésre
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets