Документация

Освой TicketsX быстрее

Инструкции по настройке, полный справочник команд, Premium-функции и REST API в одном месте.

13

Справочник API

REST API TicketsX позволяет подключить внешние инструменты к системе тикетов твоего сервера. Создавай, закрывай и веди тикеты программно, без интерфейса Discord, ищи по всему архиву стенограмм и получай полный текст или HTML любого закрытого тикета.

REST API — возможность Premium. Токены API можно создавать и использовать только пока у сервера есть активная подписка Premium (см. страницу тарифов). Запросы с сервера без Premium отклоняются с кодом 402 и полем premium_required: true. Если Premium закончится, токены сохранятся, но перестанут работать до повторного подключения. Просматривать, отключать и отзывать их в панели управления можно в любой момент.

Базовый URLhttps://api.ticketsx.xyz
Bearer Token

Каждому запросу нужен токен API, переданный как Bearer-токен в заголовке Authorization. Токен действует только для одного сервера, и его права можно ограничить по действиям.

Authorization: Bearer <API_TOKEN>

Во всех путях ниже подставь вместо <guild_id> ID своего сервера Discord, а вместо <ticket_id> — ID нужного тикета.

Для всех тел POST-запросов обязателен Content-Type: application/json. Ответы 4xx содержат поле error в формате JSON. 401 означает, что токен недействителен, просрочен или отозван. 402 означает, что у сервера нет Premium (в ответе также есть premium_required: true). 403 означает, что токен отключён или ему не хватает нужного права. 429 означает, что сработало ограничение частоты (см. «Ограничения частоты и безопасность»), и содержит значение retry_after в секундах.