Documentação

Aprenda o TicketsX mais rápido

Guias de configuração, a referência completa dos comandos, os recursos Premium e a API REST num só lugar.

13.1

Autenticação

Os tokens de API são criados e gerenciados pela barra lateral do servidor no painel do TicketsX. Cada token está ligado a um único servidor, e o servidor precisa de uma assinatura Premium ativa para criar ou usar um.

Criar um token

  • Ative o Premium para o servidor pela página Premium (a página Acesso à API leva direto para lá).
  • Abra a barra lateral do servidor e vá em Acesso à API.
  • Dê um nome ao token (por exemplo "Bot de suporte" ou "Sincronização de CRM").
  • Clique em Criar token e copie o valor mostrado.
  • Guarde em um cofre de segredos; você não poderá vê-lo de novo depois de fechar o aviso.

Se o Premium vencer

Seus tokens não são apagados. Todas as requisições à API passam a retornar 402 com premium_required: true, e criar ou renovar tokens fica bloqueado até a assinatura voltar a ficar ativa. Listar, desativar e revogar continua funcionando para você conseguir organizar mesmo assim. Trate o 402 na sua integração como trata o 401: pare de tentar de novo e avise uma pessoa.

Resposta quando o servidor não tem Premium
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Revogar um token o invalida na hora em todos os endpoints. Crie um substituto antes se não quiser interrupção.

Usar um token

Envie o token como cabeçalho Bearer em toda requisição. Todas as requisições valem só para o servidor que criou o token.

Exemplo de requisição autenticada
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets