13
API-naslag
Met de REST API van TicketsX koppel je externe software aan het ticketsysteem van je server. Je maakt, sluit en beheert tickets vanuit code zonder de Discord-interface, doorzoekt je hele transcriptiearchief en haalt de volledige tekst of HTML van elk gesloten ticket op.
De REST API is een Premium-functie. API-tokens zijn alleen aan te maken en te gebruiken zolang de server een lopend Premium-abonnement heeft (zie de prijzenpagina). Verzoeken van een server zonder Premium worden geweigerd met 402 en een veld premium_required: true. Loopt Premium af, dan blijven je tokens bewaard maar werken ze niet meer tot je het abonnement weer activeert. Bekijken, uitzetten en intrekken kan ondertussen gewoon via het dashboard.
https://api.ticketsx.xyzElk verzoek heeft een API-token nodig, als Bearer-token in de Authorization-header. Tokens gelden voor één server en zijn per handeling te beperken.
Authorization: Bearer <API_TOKEN>Vervang in alle endpointpaden hieronder <guild_id> door de ID van je Discord-server en <ticket_id> door de ID van het ticket in kwestie.
Voor alle POST-verzoeken is Content-Type: application/json nodig. Antwoorden in de 4xx-reeks bevatten een JSON-veld error; 401 betekent dat het token ongeldig, verlopen of ingetrokken is; 402 betekent dat de server geen Premium heeft (het antwoord bevat dan ook premium_required: true); 403 betekent dat het token uitstaat of het benodigde recht mist; 429 betekent dat je tegen een limiet aanliep (zie Limieten en veiligheid) en bevat een waarde retry_after in seconden.