13
Описание на API
С REST API на TicketsX свързвате свои инструменти със системата за тикети на сървъра си. Създавате, затваряте и управлявате тикети от код, без да минавате през Discord, търсите в целия архив от записи и изтегляте пълния текст или HTML кода на всеки затворен тикет.
REST API е възможност от Premium. Ключове за API се създават и ползват само докато сървърът има активен абонамент Premium (вижте страницата с цените). Заявките от сървър без Premium се отказват с 402 и полето premium_required: true. Ако Premium изтече, ключовете ви се пазят, но спират да работят, докато не го включите отново. Междувременно пак можете да ги преглеждате, изключвате и отменяте от таблото.
https://api.ticketsx.xyzВсяка заявка се нуждае от ключ за 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 в секунди.