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

Научи TicketsX по-бързо

Ръководства за настройка, пълният списък с команди, функциите на Premium и REST API на едно място.

13.1

Удостоверяване

Ключовете за 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