Koppel jouw website met Tickoweb

Dankzij OpenAPI kan je ticket shop (of registration) kanalen  ophalen uit Tickoweb en vervolgens publiceren op jouw website. In dit artikel kan je alles lezen hoe je deze koppeling tot stand kan brengen.

Credentials

Voor de koppeling heb je een een url en een API-key nodig.
API-key: Deze kan je aanvragen via support@tickoweb.be

API Endpoints

Onderstaand schema beschrijft de verschillende stappen die je moet doorlopen, en dus ook welke API endpoints gebruikt moeten worden, om alle data op te halen uit Tickoweb. Lees verder voor meer info per stap. 

Get all events

Ontvang een lijst van events die gepubliceerd kunnen worden, rekening houdend met volgende parameters:

  • dateStartAfter: gebruik "nu" voor evenementen die vandaag of na vandaag starten

  • dateEndBefore: gebruik "nu" voor evenementen die vandaag eindigen

  • visibleOnPortal: ontvang enkel die evenementen die gemarkeerd staan om gepubliceerd te worden op het portaal

  • tags: ontvang enkel de evenementen die getagged zijn met een specifieke tag

Get channels

  • eventId: ontvang enkel de kanalen voor het desbetreffende evenement

Get one channel

  • channelId: haal alle informatie op van het desbetreffende kanaal

Ga enkel verder wanneer: 
  • het type Channel_Sale is
  • de status Live is
  • hideChannelSelector false is (dit wordt gebruikt om kanalen te verbergen, privé te maken zoals bijvoorbeeld bij een afgeschermde voorverkoop)

Channel status

Controleer de status van een kanaal met {channelUrl}/status.json. Een json-bestand staat gepubliceerd op deze pagina, met daarin info over de beschikbaarheid van tickets en welke tickets er verkocht worden. De belangrijkste waarde om te controleren is products_available om te bepalen of een "tickets"-knop moet getoond worden.
Er is ook info te zien over de prijs van producten. Zo kan je bijvoorbeeld een knop "Koop" tonen wanneer tickets moeten aangekocht worden, en "Reserveer" wanneer ze gratis zijn. Lees meer over status.json.