Ověřování

Tokeny API se vytvářejí a spravují v bočním panelu serveru na nástěnce TicketsX. Každý token patří k jednomu serveru a k jeho vytvoření i použití potřebuje server aktivní předplatné Premium.

Vytvoření tokenu

Na stránce Premium zapněte pro server předplatné (stránka Přístup k API na ni vede přímo).
Otevřete boční panel serveru a přejděte na Přístup k API.
Pojmenujte token (třeba "Bot podpory" nebo "Napojení na CRM").
Klikněte na Vytvořit token a zkopírujte zobrazenou hodnotu.
Uložte ji do správce tajemství, po zavření oznámení už ji znovu neuvidíte.

Když Premium vyprší

Tokeny se nemažou. Každý požadavek na API začne vracet 402 s polem premium_required: true a vytváření i výměna tokenů se zablokuje, dokud předplatné zase nepoběží. Výpis, vypnutí i zneplatnění tokenů fungují dál, takže si pořádek uděláte za každé situace. Ve své integraci řešte 402 stejně jako 401: přestaňte opakovat pokusy a dejte vědět člověku.

Odpověď, když server nemá Premium

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

Zneplatnění tokenu ho okamžitě vyřadí na všech koncových bodech. Pokud si nemůžete dovolit výpadek, vytvořte si nejdřív náhradní token.

Použití tokenu

Token posílejte u každého požadavku v hlavičce Bearer. Všechny požadavky platí jen pro server, na kterém token vznikl.

Příklad ověřeného požadavku

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