Siirry sisältöön
ThrilTietopankki

Julkinen API ja webhookit

Omat järjestelmänne hakevat varaukset, palveluvaraukset, asiakkaat, maksut ja tapahtumat Thrilistä CRM:ään, raportointityökaluun tai verkkosivuillenne, ja webhookit kertovat niille, kun jokin muuttuu.

Thril lisää julkisen API:n yrityksellenne pyynnöstä. Ottakaa yhteyttä Thrilin tukeen. Myös webhookit, työnkulkujen Lähetä webhook -askel mukaan lukien, tarvitsevat sen.

Thrilin julkisen API:n avulla oma kehittäjänne tai integraatiokumppaninne voi käyttää yrityksenne tietoja Thrilissä omista järjestelmistänne. Webhookit toimivat toiseen suuntaan: Thril lähettää järjestelmillenne viestin, kun jokin muuttuu.


API:n käyttökohteita

  • Oma raportointi. Hakekaa maksut ja hyvitykset raportointityökaluun tai taulukkoon ja raportoikaa niin kuin hallitus tai kirjanpitäjä haluaa.
  • Varaukset markkinoinnin seurantaan. Lukekaa, mikä kampanja toi kunkin varauksen, ilmoittautumisen ja oston: omien linkkienne UTM-parametrit, mainosklikkaus ja sivusto, jolta asiakas tuli. Tämä vaatii kampanjaseurannan.
  • Ajan tasalla pysyvä CRM. Hakekaa asiakkaanne ja heidän jäsenyytensä CRM:ään. Webhookit kertovat CRM:lle, kun uusi asiakas liittyy, kun jäsenyys myönnetään ja kun jäsenyys on päättymässä.
  • Aikataulunne omilla verkkosivuillanne. Näyttäkää tapahtumanne, kurssinne, turnauksenne ja vapaat ajat Thrilistä verkkosivuilla, joita ylläpidätte itse.
  • Kausivuorot toisesta järjestelmästä. Seuran tai koulun järjestelmä varaa viikoittaisen vakiovuoron koko kaudeksi sovittuun hintaan.
  • Lahjakortit ja kampanjakoodit omista työkaluistanne. Antakaa maksuton lahjakortti palkinnoksi tai hyvitykseksi valituksesta, tai luokaa kampanjakoodi kumppanin kampanjaan.
  • Hinnat samassa tahdissa toisen järjestelmän kanssa. Lukekaa ja muuttakaa resurssienne hinnoittelusääntöjä.

API:n tiedot ja toiminnot

API lukee toimipisteenne, resurssit, vapaat ajat ja hinnat, varaukset ja vakiovuorot, palvelut ja palveluvaraukset, tapahtumat, kurssit ja turnaukset osallistujineen, asiakkaat, maksut ja hyvitykset, ostojen ja varausten kampanjat, lahjakortit, saldolataukset ja kampanjakoodit. Sillä voi varata vakiovuoroja, antaa lahjakortteja, luoda kampanjakoodeja ja muuttaa resurssien hinnoittelusääntöjä.

API:n asiakkaat ovat ihmisiä, joilla on Thril-tili. Vapaat ajat tulevat sellaisina kuin liikuntapaikkanne ne näkee. Verkkosivu, joka näyttää ne, soveltaa varausikkunat, jäsenyyssäännöt ja alennukset itse. Asiakkaat tekevät yksittäiset varaukset, tapahtumailmoittautumiset ja maksut Thrilissä. API:n kautta tehdyistä varauksista, lahjakorteista ja kampanjakoodeista ei lähde asiakkaalle viestiä, ja järjestelmänne toimittaa lahjakortin koodin.

Yrityksenne saa Thrililtä yhden API-tunnisteen. Se ulottuu yrityksenne kaikkiin toimipisteisiin. Käsitelkää sitä kuin salasanaa, sillä kuka tahansa, jolla tunniste on, voi lukea asiakkaidenne tiedot. Pyyntöjen määrälle on päiväkohtainen raja.

Kehittäjänne löytää kuvauksen jokaisesta pyynnöstä ja webhookista osoitteesta api-public.thril.fi/docs.

Samalla tunnisteella voi yhdistää myös Clauden, ChatGPT:n ja muut tekoälyavustajat tietoihinne ilman kehittäjää. Lue lisää sivulta Thril Claudessa, ChatGPT:ssä ja muissa tekoälyavustajissa.

Varaukset ja niiden osallistujat

API:ssa jokaisessa varauksessa on lista sen osallistujista. Varauksen omistaja teki varauksen, maksaja maksaa osuutensa jaetusta maksusta, ja osallistuja osallistuu maksamatta. Jokaisesta osallistujasta näkyy osallistumisen tila, kutsuttu tai hyväksytty, hänen osuutensa maksun tila ja hänelle merkitty hinta. Osallistuja on yksi näistä:

  • Asiakas, jolla on Thril-tili. Hänestä näkyvät nimi, sähköpostiosoite, puhelinnumero ja yrityksenne kirjaama markkinointilupa. Asiakkaan käyttäjätunniste pysyy samana kaikissa liikuntapaikoissa ja yrityksissä. Järjestelmänne voi käyttää sitä pysyvänä asiakastunnisteena.
  • Vieras, joka on nimetty varaukseen ja jolla ei ole Thril-tiliä.
  • Yritysasiakas, jota yrityksenne laskuttaa.
  • Avoin paikka, johon ei ole nimetty ketään.

Varauslistassa ovat myös ajat, jotka tapahtumat, golfkilpailut, palveluvaraukset ja lisäpalvelut vievät resursseiltanne. Näin ovi- tai valojärjestelmä voi seurata kaikkea, mitä resurssille on varattu. Jokaisella varauksella on tyyppi: asiakkaan varaus, henkilökunnan varaus, vakiovuoro, avoin peli tai aika, jonka tapahtuma, golfkilpailu, palveluvaraus tai lisäpalvelu vie. Kun varaus pitää resurssia tapahtumalle, kilpailulle tai palveluvaraukselle, osallistujat ja hinta näkyvät tapahtumassa, kilpailussa tai palveluvarauksessa.

Varauslistaa voi rajata toimipisteen, resurssin, tyypin, vakiovuorosarjan, tilan, aikavälin ja asiakkaan mukaan. Kun listan rajaa asiakkaan käyttäjätunnisteella, se palauttaa kaikki varaukset, joissa asiakas on missä tahansa roolissa. Yksittäisen varauksen voi hakea myös sen tunnisteella. Listassa ovat mukana myös perutut varaukset peruutuksen syineen. Maksut haetaan omalla pyynnöllään. Varauksen maksussa näkyy varaus, josta se maksettiin. API:n varauksissa ei ole tietoa läsnäolosta tai sisäänkirjautumisesta.

Palveluvaraukset

API:ssa jokaisesta palveluvarauksesta näkyvät varattu palvelu ja kesto, palvelun antava työntekijä, varauksen tehnyt asiakas tai vieras, aika, hinta alennuksineen ja arvonlisäveroineen sekä se, onko varaus maksettu. Listaa voi rajata toimipisteen, tilan, maksun tilan, aikavälin ja asiakkaan mukaan, ja siinä ovat mukana myös perutut varaukset peruutuksen syineen. Palveluvarauksen maksussa näkyy palveluvaraus, josta se maksettiin. Palvelut haetaan omalla pyynnöllään, ja niistä näkyvät kestot, joille palvelun voi varata, ja kestojen hinnat.


Webhookit

Webhook on viesti, jonka Thril lähettää omassa järjestelmässänne olevaan osoitteeseen, kun jotain tapahtuu. Kehittäjänne määrittää vastaanottavat osoitteet API:n kautta ja valitsee, mitkä muutokset kukin saa:

  • varaus tehty, muutettu tai peruttu sekä vakiovuorosarja tehty, muutettu tai peruttu
  • osallistuja liittynyt tapahtumaan tai poistunut siitä sekä tapahtuma tai turnaus peruttu
  • uusi asiakas liittynyt yritykseenne
  • jäsenyys myönnetty asiakkaalle tai jäsenyys päättymässä

Webhookit työnkuluista

Työnkulun Lähetä webhook -askel kertoo järjestelmillenne, että asiakas, varaus, lasku tai jäsenyys on edennyt työnkulussa siihen kohtaan. Nimeätte tapahtuman ja valitsette arvot, jotka se välittää, esimerkiksi asiakkaan sähköpostiosoitteen ja jäsenyyden nimen. CRM voi silloin aloittaa oman jatkotoimensa samasta kohdasta.

Tällä sivulla