13
API-oversigt
Med TicketsX' REST-API kan du koble dine egne værktøjer sammen med sagssystemet på din server. Du opretter, lukker og håndterer sager fra kode uden om Discords brugerflade, søger i hele udskriftsarkivet og henter hele teksten eller HTML'en for en hvilken som helst lukket sag.
REST-API'et er en Premium-funktion. API-nøgler kan kun oprettes og bruges, mens serveren har et aktivt Premium-abonnement (se prissiden). Kald fra en server uden Premium bliver afvist med 402 og feltet premium_required: true. Udløber Premium, bliver dine nøgler gemt, men de virker ikke, før du aktiverer igen. Imens kan du stadig se, slå fra og tilbagekalde dem i kontrolpanelet.
https://api.ticketsx.xyzHvert kald kræver en API-nøgle sendt som Bearer-nøgle i Authorization-headeren. Nøglerne gælder én server og kan begrænses pr. handling.
Authorization: Bearer <API_TOKEN>Erstat <guild_id> med din Discord-servers id og <ticket_id> med den pågældende sags id i alle stier nedenfor.
Alle POST-kald kræver Content-Type: application/json. Svar i 4xx-serien indeholder JSON-feltet error; 401 betyder, at nøglen er ugyldig, udløbet eller tilbagekaldt; 402 betyder, at serveren ikke har Premium (svaret indeholder også premium_required: true); 403 betyder, at nøglen er slået fra eller mangler den rigtige rettighed; 429 betyder, at du har ramt en grænse (se Grænser og sikkerhed) og indeholder en værdi retry_after i sekunder.