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

Опануй TicketsX швидше

Посібники з налаштування, повний перелік команд, можливості Premium і REST API в одному місці.

13

Опис API

REST API TicketsX дає змогу поєднати сторонні інструменти із системою тікетів вашого сервера. Ви створюєте, закриваєте та ведете тікети з коду без інтерфейсу Discord, шукаєте в усьому архіві записів і забираєте повний текст або код HTML будь-якого закритого тікета.

REST API це можливість Premium. Ключі API можна створювати й використовувати лише доки сервер має чинну передплату Premium (див. сторінку цін). Запити від сервера без Premium відхиляються з кодом 402 і полем premium_required: true. Якщо Premium спливає, ваші ключі зберігаються, але перестають працювати, доки ви його не увімкнете знову. Тим часом ви все одно можете переглядати, вимикати й скасовувати їх у панелі керування.

Базова адресаhttps://api.ticketsx.xyz
Bearer Token

Кожен запит потребує ключа API, переданого як ключ Bearer у заголовку Authorization. Ключі діють для одного сервера, і їх можна обмежити для кожної дії окремо.

Authorization: Bearer <API_TOKEN>

В усіх шляхах нижче замініть <guild_id> на ідентифікатор вашого сервера Discord, а <ticket_id> на ідентифікатор потрібного тікета.

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