Dokumentasjon

Lær TicketsX raskere

Veiledninger, alle kommandoer, Premium-funksjoner og REST-API-et på ett sted.

13.1

Pålogging

API-nøkler lages og håndteres i sidemenyen til serveren i TicketsX-kontrollpanelet. Hver nøkkel hører til én server, og for å lage eller bruke en må serveren ha et aktivt Premium-abonnement.

Lage en nøkkel

  • Slå på Premium for serveren på siden Premium (siden API-tilgang lenker rett dit).
  • Åpne sidemenyen til serveren og gå til API-tilgang.
  • Gi nøkkelen et navn (for eksempel "Supportbot" eller "CRM-kobling").
  • Klikk på Lag nøkkel og kopier verdien som vises.
  • Lagre den et trygt sted for hemmeligheter; når du har lukket meldingen, kan du ikke se den igjen.

Hvis Premium går ut

Nøklene dine blir ikke slettet. Alle API-kall begynner å svare 402 med premium_required: true, og du kan ikke lage eller bytte nøkler før abonnementet er aktivt igjen. Du kan fortsatt se, slå av og trekke tilbake nøkler, så du kan rydde opp uansett. Behandle 402 i integrasjonen din på samme måte som 401: slutt å prøve på nytt, og si fra til et menneske.

Svar når serveren ikke har Premium
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Trekker du tilbake en nøkkel, slutter den å virke på alle endepunkter med én gang. Vil du unngå avbrudd, lag erstatteren først.

Bruke en nøkkel

Send nøkkelen som Bearer-hode ved hvert kall. Alle kall gjelder bare serveren der nøkkelen ble laget.

Eksempel på et pålogget kall
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets