API gebruiken

Met de TicketSoft API kun je gegevens uit TicketSoft ophalen en checkoutlinks aanmaken vanuit externe systemen. De API is beschikbaar via /api en gebruikt JSON. Voor een breder overzicht van koppelingen, automatisering en externe workflows kun je ook de functiepagina integraties en automatisering bekijken.

API-sleutels beheren

In het administratiepaneel ga je naar API-sleutels. Daar kun je:

actieve API-sleutels bekijken;
een nieuwe API-sleutel genereren;
een sleutel direct na aanmaken kopiëren;
een sleutel intrekken;
ingetrokken sleutels terugzien met aanmaak- en intrekdatum;
de technische API-documentatie openen via https://ticketsoft.nl/api/docs.

Bij het genereren vul je een naam in. Gebruik een herkenbare naam, bijvoorbeeld de naam van de koppeling of leverancier.

Een API-sleutel wordt maar een keer volledig getoond: direct na het genereren. Bewaar de sleutel veilig. Als je hem kwijt bent, trek je de oude sleutel in en maak je een nieuwe aan.

Authenticatie

De API gebruikt de Authorization header. De sleutel geeft toegang tot de organisatie waarvoor de sleutel is aangemaakt.

Authorization: Bearer <api-sleutel>
Accept: application/json
Content-Type: application/json

Beschikbare endpoints

Endpoint	Methode	Gebruik
`/api/events`	GET	Haalt evenementen van de organisatie op.
`/api/event/{id}/orders`	GET	Haalt bestellingen van een evenement op.
`/api/order/{id}`	GET	Haalt een uitgebreide bestelling op.
`/api/cart`	POST	Maakt een winkelwagen aan en geeft een checkoutlink terug.

De interactieve documentatie op https://ticketsoft.nl/api/docs toont de technische request- en responsevelden.

Evenementen ophalen

GET /api/events geeft evenementen terug met onder andere:

id en uuid;
naam en omschrijving;
ticketshop-URL;
verkoopbaarheid;
datum en tijd;
locatie, inclusief online of hybride locatiegegevens;
branding;
tickettypen.

Per tickettype zie je onder andere uuid, naam, omschrijving, prijs, capaciteit, verkochte en resterende aantallen, minimum en maximum per bestelling, verkoopperiode, type, zichtbaarheid, toegangscode-indicatie, branding en ticketgroep.

Bestellingen van een evenement ophalen

GET /api/event/{id}/orders geeft een compacte lijst van bestellingen voor een evenement. Je kunt filteren op aanmaakdatum:

GET /api/event/59/orders?createdAt[gte]=2025-06-01T00%3A00%3A00%2B02%3A00
GET /api/event/59/orders?createdAt[lt]=2025-07-01T00%3A00%3A00%2B02%3A00

Gebruik ISO 8601-datums. Let op dat een plusteken in de tijdzone URL-encoded moet worden. De compacte orderlijst bevat onder andere:

bestelnummer;
aanmaakdatum;
betaalstatus;
gedeeltelijk terugbetaald of volledig terugbetaald;
ticketprijs, servicekosten, transactiekosten en totaalprijs;
taal;
ordertype: Online, Door of Guest;
klantgegevens;
evenementnaam.

Een bestelling ophalen

GET /api/order/{id} geeft een uitgebreide bestelling terug. De response bevat naast de algemene bestelgegevens ook:

klantgegevens;
evenementgegevens;
verzonden e-mails en statussen;
afrekenvelden;
tickets;
ticketvelden;
scan-historie;
betalingen;
facturen en factuurregels.

Ticketstatussen in de API zijn:

Status	Betekenis
`PendingPayment`	Ticket hoort bij een nog niet betaalde bestelling.
`Available`	Ticket is geldig.
`Used`	Ticket is gebruikt.
`Revoked`	Ticket is ingetrokken.

E-mailstatussen kunnen onder andere Delivery, Open, Click, Bounce en SpamComplaint zijn.

Winkelwagen en checkoutlink aanmaken

POST /api/cart maakt een winkelwagen aan en geeft een checkoutUrl terug. Gebruik dit wanneer een externe website of applicatie een selectie tickets wil klaarzetten en de bezoeker daarna door TicketSoft wil laten afrekenen. Voorbeeld:

{
  "eventUuid": "00000000-0000-0000-0000-000000000000",
  "tickets": [
    {
      "ticketUuid": "11111111-1111-1111-1111-111111111111",
      "amount": 2
    }
  ]
}

TicketSoft controleert bij het aanmaken:

of het evenement bij de API-sleutel hoort;
of het evenement verkoopbaar is;
of minimaal een ticket is opgegeven;
of het ticket via de API bestelbaar is;
of het aantal voldoet aan minimum en maximum;
of het evenement nog niet is afgelopen;
of er genoeg voorraad is;
of de verkoopperiode van het ticket actief is.

De checkoutlink verwijst naar de juiste vervolgstap. Als ticketvelden verplicht zijn, gaat de bezoeker eerst naar de ticketveldenpagina. Als er producten zonder groep beschikbaar zijn, kan de link naar de productstap gaan. Anders gaat de link naar de winkelwagen.

Veilig werken met API-sleutels

Maak per koppeling een aparte sleutel.
Geef sleutels herkenbare namen.
Deel sleutels niet in e-mails of openbare repositories.
Trek een sleutel direct in wanneer een koppeling stopt of een sleutel mogelijk gelekt is.
Gebruik de technische documentatie op https://ticketsoft.nl/api/docs om request- en responsevelden te controleren.

Aan de slag

Evenement & ticketshop

Dashboard & verkoop

Kortingscodes

Overzichtspagina's

Bestellingen & e-mails

Scannen & toegang

Rapportage & uitbetalingen

Team & beveiliging

TicketSwap

API

API-sleutels beheren

Authenticatie

Beschikbare endpoints

Evenementen ophalen

Bestellingen van een evenement ophalen

Een bestelling ophalen

Winkelwagen en checkoutlink aanmaken

Veilig werken met API-sleutels

​API-sleutels beheren

​Authenticatie

​Beschikbare endpoints

​Evenementen ophalen

​Bestellingen van een evenement ophalen

​Een bestelling ophalen

​Winkelwagen en checkoutlink aanmaken

​Veilig werken met API-sleutels

API-sleutels beheren

Authenticatie

Beschikbare endpoints

Evenementen ophalen

Bestellingen van een evenement ophalen

Een bestelling ophalen

Winkelwagen en checkoutlink aanmaken

Veilig werken met API-sleutels