13
API-oversikt
Med REST-API-et til TicketsX kan du koble dine egne verktøy til sakssystemet på serveren din. Du oppretter, lukker og håndterer saker fra kode uten å gå gjennom Discord, søker i hele utskriftsarkivet og henter hele teksten eller HTML-en til hvilken som helst lukket sak.
REST-API-et er en Premium-funksjon. API-nøkler kan bare lages og brukes mens serveren har et aktivt Premium-abonnement (se prissiden). Kall fra en server uten Premium blir avvist med 402 og feltet premium_required: true. Går Premium ut, blir nøklene dine tatt vare på, men de virker ikke før du aktiverer igjen. I mellomtiden kan du fortsatt se, slå av og trekke dem tilbake i kontrollpanelet.
https://api.ticketsx.xyzHvert kall krever en API-nøkkel sendt som Bearer-nøkkel i Authorization-hodet. Nøklene gjelder én server og kan begrenses per handling.
Authorization: Bearer <API_TOKEN>Bytt ut <guild_id> med ID-en til Discord-serveren din og <ticket_id> med ID-en til den aktuelle saken i alle stiene nedenfor.
Alle POST-kall krever Content-Type: application/json. Svar i 4xx-serien inneholder JSON-feltet error; 401 betyr at nøkkelen er ugyldig, utgått eller trukket tilbake; 402 betyr at serveren ikke har Premium (svaret inneholder også premium_required: true); 403 betyr at nøkkelen er slått av eller mangler den nødvendige rettigheten; 429 betyr at du har nådd en grense (se Grenser og sikkerhet) og inneholder en verdi retry_after i sekunder.