Розпізнавання

Ключі API створюють і ведуть у бічному меню сервера в панелі керування TicketsX. Кожен ключ прив'язаний до одного сервера, а щоб його створити чи використати, сервер має мати чинну передплату Premium.

Створення ключа

Увімкніть Premium для сервера на сторінці Premium (сторінка Доступ до API веде просто туди).
Відкрийте бічну панель сервера й перейдіть до Доступ до API.
Дайте ключу назву (наприклад "Бот підтримки" або "Зв'язок із CRM").
Натисніть Створити ключ і скопіюйте показане значення.
Збережіть його в сховищі таємниць; після закриття повідомлення ви більше його не побачите.

Якщо Premium спливає

Ваші ключі не видаляються. Кожен запит до API починає повертати 402 з premium_required: true, а створення й заміна ключів заблоковані, доки передплата не запрацює знову. Перегляд, вимкнення та скасування ключів працюють і далі, тож навести лад ви можете за будь-яких умов. У своєму поєднанні обробляйте 402 так само, як 401: припиніть повторні спроби й сповістіть людину.

Відповідь, коли сервер не має Premium

{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

Скасування ключа одразу знеструмлює його на всіх кінцевих точках. Якщо перерва небажана, спершу створіть ключ на заміну.

Використання ключа

Надсилайте ключ як заголовок Bearer у кожному запиті. Усі запити стосуються лише того сервера, на якому ключ створено.

Приклад розпізнаного запиту

curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets