API-Referenz

Mit der REST-API von TicketsX bindest du externe Werkzeuge an das Ticketsystem deines Servers an. Erstelle, schließe und verwalte Tickets programmgesteuert ohne die Discord-Oberfläche, durchsuche dein gesamtes Transkriptarchiv und hol dir den vollständigen Text oder das HTML jedes geschlossenen Tickets.

Die REST-API ist eine Premium-Funktion. API-Tokens lassen sich nur anlegen und nutzen, solange der Server ein aktives Premium-Abo hat (siehe Preisseite). Anfragen von Servern ohne Premium werden mit 402 und dem Feld premium_required: true abgelehnt. Läuft Premium aus, bleiben deine Tokens erhalten, funktionieren aber erst nach erneuter Aktivierung wieder. Auflisten, deaktivieren und widerrufen kannst du sie im Dashboard jederzeit.

Basis-URLhttps://api.ticketsx.xyz

Bearer Token

Jede Anfrage braucht ein API-Token, das als Bearer-Token im Authorization-Header mitgeschickt wird. Tokens gelten für genau einen Server und lassen sich je Aktion einschränken.

Authorization: Bearer <API_TOKEN>

Ersetze in allen Endpunktpfaden unten <guild_id> durch die ID deines Discord-Servers und <ticket_id> durch die ID des gewünschten Tickets.

Content-Type: application/json ist für alle POST-Anfragen erforderlich. 4xx-Antworten enthalten ein JSON-Feld error. 401 heißt, das Token ist ungültig, abgelaufen oder widerrufen. 402 heißt, der Server hat kein Premium (die Antwort enthält zusätzlich premium_required: true). 403 heißt, das Token ist deaktiviert oder hat die nötige Berechtigung nicht. 429 heißt, eine Ratenbegrenzung hat gegriffen (siehe Ratenbegrenzungen und Sicherheit) und enthält einen Wert retry_after in Sekunden.