Uwierzytelnianie

Tokeny API tworzysz i prowadzisz w bocznym menu serwera w panelu TicketsX. Każdy token jest przypisany do jednego serwera, a do jego utworzenia i użycia serwer potrzebuje aktywnej subskrypcji Premium.

Tworzenie tokenu

Włącz Premium dla serwera na stronie Premium (strona Dostęp do API prowadzi do niej wprost).
Otwórz boczne menu serwera i przejdź do Dostęp do API.
Nazwij token (na przykład "Bot pomocy" albo "Synchronizacja CRM").
Kliknij Utwórz token i skopiuj wyświetloną wartość.
Zapisz ją w menedżerze sekretów, bo po zamknięciu komunikatu już jej nie zobaczysz.

Gdy Premium wygaśnie

Tokeny nie znikają. Każde żądanie do API zaczyna zwracać 402 z polem premium_required: true, a tworzenie i wymiana tokenów są zablokowane, dopóki subskrypcja nie wróci. Przeglądanie, wyłączanie i unieważnianie tokenów działa dalej, więc porządki zrobisz niezależnie od wszystkiego. W swojej integracji potraktuj 402 tak samo jak 401: przerwij ponawianie i powiadom człowieka.

Odpowiedź, gdy serwer nie ma Premium

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

Unieważnienie tokenu od razu wyłącza go we wszystkich punktach końcowych. Jeśli nie możesz pozwolić sobie na przerwę, najpierw utwórz token zastępczy.

Używanie tokenu

Wysyłaj token w nagłówku Bearer przy każdym żądaniu. Wszystkie żądania dotyczą wyłącznie serwera, na którym token powstał.

Przykład uwierzytelnionego żądania

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