API-referens

Med TicketsX REST-API kopplar du ihop egna verktyg med serverns ärendesystem. Du skapar, stänger och hanterar ärenden från kod utan Discords gränssnitt, söker i hela utskriftsarkivet och hämtar hela texten eller HTML:en för vilket stängt ärende som helst.

REST-API:et är en Premium-funktion. API-nycklar går bara att skapa och använda medan servern har en aktiv Premium-prenumeration (se prissidan). Anrop från en server utan Premium avvisas med 402 och fältet premium_required: true. Löper Premium ut behålls dina nycklar men slutar fungera tills du aktiverar igen. Under tiden kan du fortfarande lista, stänga av och återkalla dem i panelen.

Bas-URLhttps://api.ticketsx.xyz

Bearer Token

Varje anrop kräver en API-nyckel som skickas som Bearer-nyckel i Authorization-huvudet. Nycklarna gäller en enda server och kan begränsas per åtgärd.

Authorization: Bearer <API_TOKEN>

Byt ut <guild_id> mot din Discord-servers ID och <ticket_id> mot det aktuella ärendets ID i alla sökvägar nedan.

Alla POST-anrop behöver Content-Type: application/json. Svar i 4xx-serien innehåller JSON-fältet error; 401 betyder att nyckeln är ogiltig, har gått ut eller återkallats; 402 betyder att servern saknar Premium (svaret innehåller även premium_required: true); 403 betyder att nyckeln är avstängd eller saknar rätt behörighet; 429 betyder att du slagit i en gräns (se Gränser och säkerhet) och innehåller ett värde retry_after i sekunder.