πŸ” Come attivare le API

Due semplici passaggi per iniziare a generare ticket via API.

Crea la tua API Key

L'API Key Γ¨ la tua chiave di autenticazione per tutte le chiamate API. Viene generata una sola volta e deve essere conservata in modo sicuro. Se hai piΓΉ applicativi che gestiscono i tuoi ticket via API puoi gestire chiavi API separate.

Come ottenerla:

  1. Apri l'app TicketQR
  2. Vai su Profilo β†’ Chiavi API
  3. Clicca su "+" per creare una nuova chiave API
  4. Assegna un nome identificativo (es. "WooCommerce Store")
  5. Copia e salva la chiave generata (verrΓ  mostrata solo questa volta e non sarΓ  piΓΉ recuperabile in seguito!)

Abilita l'API per l'evento

Ogni evento deve essere abilitato singolarmente per ricevere richieste API. Questo ti permette di scegliere quali eventi sono accessibili dall'esterno.

Come abilitarla:

  1. Apri l'app TicketQR
  2. Seleziona l'evento desiderato dalla lista ed entra in dettaglio
  3. Clicca su "Abilita API"
  4. VerrΓ  generato un Event Token univoco che identifica quel singolo evento
  5. Copia l'endpoint mostrato (contiene il token)
⚠️ Importante: L'Event Token è specifico per quell'evento. Ogni evento ha il suo token univoco per motivi di sicurezza.

⚑ Metodi API disponibili

Tutte le API REST utilizzano autenticazione tramite header X-API-Key

GET
/events

Lista eventi attivi

Ottieni la lista di tutti gli eventi futuri e in corso che hanno l'API abilitata. Non richiede Event Token, solo l'API Key.

GET
/events/{eventToken}

Informazioni evento

Recupera i dettagli di un evento specifico: titolo, data, luogo, posti disponibili e configurazione API.

POST
/events/{eventToken}/tickets

Crea ticket

Genera uno o piΓΉ biglietti per l'evento. Puoi includere nome e email del partecipante, scegliere la lingua (IT/EN) e decidere se inviare automaticamente il ticket via email con PDF allegato.

GET
/events/{eventToken}/tickets

Lista ticket evento

Ottieni tutti i ticket generati per un evento, con stato di validazione, dati partecipante e timestamp di ingresso/uscita.

GET
/events/{eventToken}/tickets/print/{ticketId}

Download PDF ticket

Scarica il PDF del biglietto con QR code, dati evento e branding dell'organizzazione. Ideale per sistemi che non inviano email automatiche.

πŸ“š Documentazione tecnica completa

Esplora, testa e integra le API con la nostra documentazione interattiva Swagger.

πŸ“–

Swagger UI Interattivo

Testa le API direttamente dal browser, visualizza esempi di richieste/risposte e genera snippet di codice per la tua integrazione.

πŸš€ Apri documentazione interattiva

⚑ Base URL Development: https://apidev.ticketqr.it/api/v1

πŸ’‘ Consiglio: La documentazione Swagger include esempi pratici. Perfetta per sviluppatori che vogliono integrare rapidamente TicketQR nei propri sistemi.

πŸ’‘ Casi d'uso comuni

Esempi di come puoi usare le API per automatizzare la gestione dei biglietti.

πŸ›’

WooCommerce / E-commerce

Genera automaticamente biglietti quando un utente completa un acquisto sul tuo store online. Il ticket viene inviato via email con il PDF allegato.

πŸ“

Form di registrazione

Collega i tuoi Google Forms, Typeform o form custom. Quando qualcuno si iscrive all'evento, riceve automaticamente il biglietto digitale.

πŸ”„

Sistemi CRM / ERP

Integra TicketQR nel tuo gestionale aziendale per emettere biglietti ai clienti, fornitori o dipendenti per eventi corporate.

🎟️

Piattaforme di ticketing

Usa TicketQR come backend per la tua piattaforma di vendita biglietti, gestendo la generazione e validazione tramite API.

πŸ” How to activate the APIs

Two simple steps to start generating tickets via API.

Create your API Key

The API Key is your authentication key for all API calls. It is generated only once and must be stored securely. If you have multiple applications managing your tickets via API you can manage separate API keys.

How to get it:

  1. Open the TicketQR app
  2. Go to Profile β†’ API Keys
  3. Click "+" to create a new API key
  4. Assign an identifying name (e.g. "WooCommerce Store")
  5. Copy and save the generated key (it will only be shown this once and cannot be retrieved later!)

Enable the API for the event

Each event must be individually enabled to receive API requests. This allows you to choose which events are accessible from outside.

How to enable it:

  1. Open the TicketQR app
  2. Select the desired event from the list and open its detail
  3. Click "Enable API"
  4. A unique Event Token will be generated that identifies that single event
  5. Copy the displayed endpoint (it contains the token)
⚠️ Important: The Event Token is specific to that event. Each event has its own unique token for security reasons.

⚑ Available API methods

All REST APIs use authentication via X-API-Key header

GET
/events

List active events

Get the list of all future and ongoing events that have the API enabled. Does not require an Event Token, only the API Key.

GET
/events/{eventToken}

Event information

Retrieve the details of a specific event: title, date, location, available seats and API configuration.

POST
/events/{eventToken}/tickets

Create ticket

Generate one or more tickets for the event. You can include the participant's name and email, choose the language (IT/EN) and decide whether to automatically send the ticket via email with the PDF attached.

GET
/events/{eventToken}/tickets

Event ticket list

Get all tickets generated for an event, with validation status, participant data and entry/exit timestamps.

GET
/events/{eventToken}/tickets/print/{ticketId}

Download ticket PDF

Download the ticket PDF with QR code, event data and organization branding. Ideal for systems that do not send automatic emails.

πŸ“š Complete technical documentation

Explore, test and integrate the APIs with our interactive Swagger documentation.

πŸ“–

Interactive Swagger UI

Test the APIs directly from your browser, view request/response examples and generate code snippets for your integration.

πŸš€ Open interactive documentation

⚑ Base URL Development: https://apidev.ticketqr.it/api/v1

πŸ’‘ Tip: The Swagger documentation includes practical examples. Perfect for developers who want to quickly integrate TicketQR into their systems.

πŸ’‘ Common use cases

Examples of how you can use the APIs to automate ticket management.

πŸ›’

WooCommerce / E-commerce

Automatically generate tickets when a user completes a purchase on your online store. The ticket is sent via email with the PDF attached.

πŸ“

Registration forms

Connect your Google Forms, Typeform or custom forms. When someone registers for the event, they automatically receive the digital ticket.

πŸ”„

CRM / ERP systems

Integrate TicketQR into your business management system to issue tickets to customers, suppliers or employees for corporate events.

🎟️

Ticketing platforms

Use TicketQR as a backend for your ticket sales platform, managing generation and validation through APIs.