Nápověda

REST API

Přístup k Vašim akcím a objednávkám přes Bearer token. Aktuálně jen pro čtení.

  1. 1. Vygenerujte API klíč

    V Administrace → Nastavení → API klíč klikněte na Vygenerovat API klíč. Klíč se zobrazí jednou — zkopírujte si ho. Později se vám zobrazí už jen jeho prefix pro identifikaci.

    Pokud klíč unikne, klikněte na Vygenerovat nový — starý klíč se okamžitě zneplatní.

  2. 2. Volání API

    API je read-only a scoped na jednoho tenanta. Klíč posílejte v hlavičce Authorization:

    curl https://app.ticketflow.cz/api/v1/events \
      -H "Authorization: Bearer tfk_..."
  3. 3. Koncové body

    • GET /api/v1/events — seznam akcí (stránkovaný, filtry: from, to).
    • GET /api/v1/events/{id} — detail akce.
    • GET /api/v1/orders — seznam objednávek (filtry: eventId, status, from, to).
    • GET /api/v1/orders/{id} — detail objednávky včetně Fakturoid odkazu, pokud existuje.
    • GET /api/v1/docs — kompletní OpenAPI 3.0 spec.
  4. 4. Omezení

    API je v1 — read-only. Zápis (vytváření objednávek, editace akcí) plánujeme v další verzi. Pokud potřebujete zápis dříve, ozvěte se nám — můžeme přidat scope na klíč.

Tip pro vývojáře: OpenAPI spec na /api/v1/docs můžete hodit do openapi-generator a nechat si vygenerovat TypeScript / Python / Go klienta.