13
Dokumentace API
REST API TicketsX vám umožní propojit vlastní nástroje se systémem tiketů na vašem serveru. Tikety zakládáte, zavíráte a spravujete z kódu bez rozhraní Discordu, prohledáváte celý archiv přepisů a stahujete úplný text nebo HTML kteréhokoli zavřeného tiketu.
REST API je funkce Premium. Tokeny API lze vytvářet a používat jen v době, kdy má server aktivní předplatné Premium (viz stránka s ceníkem). Požadavky ze serveru bez Premium se odmítají s kódem 402 a polem premium_required: true. Když Premium vyprší, stávající tokeny zůstanou, ale přestanou fungovat, dokud předplatné neobnovíte. Mezitím si je na nástěnce pořád můžete vypsat, vypnout i zneplatnit.
https://api.ticketsx.xyzKaždý požadavek vyžaduje token API předaný jako Bearer token v hlavičce Authorization. Token platí pro jeden server a lze ho omezit pro jednotlivé úkony.
Authorization: Bearer <API_TOKEN>Ve všech cestách ke koncovým bodům níže nahraďte <guild_id> ID svého serveru Discord a <ticket_id> ID příslušného tiketu.
Všechna těla požadavků POST potřebují Content-Type: application/json. Odpovědi 4xx obsahují pole JSON error; 401 znamená, že token je neplatný, vypršel nebo byl zneplatněn; 402 znamená, že server nemá Premium (odpověď nese také premium_required: true); 403 znamená, že je token vypnutý nebo mu chybí potřebné oprávnění; 429 znamená, že jste narazili na limit požadavků (viz Limity a bezpečnost) a obsahuje hodnotu retry_after v sekundách.