Dokumentacja API

API REST TicketsX pozwala połączyć zewnętrzne narzędzia z systemem zgłoszeń na twoim serwerze. Tworzysz, zamykasz i prowadzisz zgłoszenia z poziomu kodu, bez interfejsu Discorda, przeszukujesz całe archiwum zapisów i pobierasz pełny tekst albo HTML dowolnego zamkniętego zgłoszenia.

API REST to funkcja Premium. Tokeny API można tworzyć i używać tylko wtedy, gdy serwer ma aktywną subskrypcję Premium (zobacz stronę z cennikiem). Żądania z serwera bez Premium są odrzucane z kodem 402 i polem premium_required: true. Gdy Premium wygaśnie, dotychczasowe tokeny zostają, ale przestają działać do czasu wznowienia subskrypcji. W tym czasie i tak przejrzysz je, wyłączysz i unieważnisz w panelu.

Adres bazowyhttps://api.ticketsx.xyz

Bearer Token

Każde żądanie wymaga tokenu API przekazanego jako token Bearer w nagłówku Authorization. Token obejmuje jeden serwer i można go ograniczyć osobno dla każdej czynności.

Authorization: Bearer <API_TOKEN>

We wszystkich ścieżkach poniżej zastąp <guild_id> identyfikatorem swojego serwera Discord, a <ticket_id> identyfikatorem wybranego zgłoszenia.

Każde ciało żądania POST wymaga nagłówka Content-Type: application/json. Odpowiedzi z rodziny 4xx zawierają pole JSON error; 401 oznacza, że token jest nieprawidłowy, wygasł albo został unieważniony; 402 oznacza, że serwer nie ma Premium (odpowiedź niesie też premium_required: true); 403 oznacza, że token jest wyłączony albo brakuje mu wymaganego uprawnienia; 429 oznacza przekroczony limit zapytań (zobacz Limity i bezpieczeństwo) i zawiera wartość retry_after w sekundach.