Webhookid, serverist serverisse postbackid ja REST API

Kolm viisi TapTime’i ühendamiseks teiste süsteemidega, kõik ühe pealkirja all. Neid saab hallata ainult ettevõtte omanik. Vestlusteavituste ning Zapieri, Make’i, n8n-i või Pipedreami kohta vaata nende eraldi juhendeid — need kasutavad samu sündmusi.

Paneel Integratsioonid Webhookid ja API

Kasuta	Millal
Webhook	Sinu süsteem või CRM peab saama teada igast broneeringu, tellimuse või püsikliendiprogrammi muudatusest koos kõigi üksikasjadega.
Postback	Reklaamivõrgustik, partnerprogramm või jälgimisteenus andis sulle postback-URL-i, mida iga konversiooni korral kutsuda.
REST API	Sinu süsteem soovib broneeringuid tuua siis, kui talle sobib, või neid kinnitada ja tühistada.

Sündmused, mida saad saata

Sündmus	Millal
booking.requested	Külaline küsis broneeringut, mis ootab sinu kinnitust
booking.confirmed	Broneering on kinnitatud
booking.cancelled	Külaline või ettevõte tühistas
booking.no_show	Külaline ei tulnud
booking.completed	Külastus on lõppenud
order.placed	Külalise tellimus jõudis sinuni (sinu lehelt või laua QR-koodi kaudu)
order.paid	Mis tahes tellimus maksti, ka kassas
loyalty.member_joined	Klient sai programmis oma esimese templi
loyalty.stamp_added	Lisati tempel
loyalty.reward_issued	Kaart täideti ja selle preemia väljastati
loyalty.reward_redeemed	Preemia anti üle

Webhookid

1
Lisa webhook
Kleebi oma lõpp-punkti https-aadress ja vali sündmused — broneeringud, tellimused, püsikliendid või kõik.
2
Saada test
Näidissündmus saadetakse kohe ja näidatakse sinu lõpp-punkti antud vastust.
3
Kontrolli allkirja
Igal päringul on päis TapTime-Signature: t=<time>,v1=<HMAC-SHA256 of “t.body” with your signing secret> — ehk aeg ja HMAC-SHA256 stringist „t.body“, arvutatud sinu allkirjastamise saladusega. Võrdle seda enne, kui päringut usaldad.

Sisu on JSON: sündmuse ID, tüüp ja aeg ning kogu broneering, tellimus või püsikliendikaart väljal data.booking, data.order või data.loyalty — koos külalise, aja, laua, teenuse või toodete, oleku ja päritoluga (UTM-sildid ja kliki-ID-d).

Vasta mis tahes 2xx olekuga. Kõike muud proovitakse uuesti 8 korda umbes ööpäeva jooksul.
Igal sündmusel on ID: kui saad selle kaks korda, eira teist.
Vasta 410 Gone ja TapTime lõpetab selle sündmuse kordamise.
Ümbersuunamisi ei järgita ja privaatvõrkude aadressid lükatakse tagasi.

Serverist serverisse postbackid

Kleebi postback-URL, mille jälgimisteenus sulle andis, ja klõpsa kohatäitjatel, et lisada broneeringu andmed, näiteks https://tracker.example/postback?cid={click_id}&payout={value}&status={status}. Saadaval on muu hulgas kohatäitjad {click_id}, {event}, {booking_id}, {value}, {currency}, {party_size}, {utm_source}, {utm_campaign}, {gclid} ja {fbclid}. Jälgimisteenuse kliki-ID jõuab broneeringuni, kui sinu broneerimislingis on parameeter click_id, clickid või subid.

REST API

1
Loo API-võti
Anna sellele nimi ja vali „Ainult lugemine“ või lugemine ja kirjutamine, et lubada broneeringute kinnitamist, tühistamist ja mitteilmumiste märkimist.
2
Kopeeri see kohe
Võtit näidatakse üks kord. Hoia seda oma serveris — mitte kunagi veebilehel ega rakenduses.
3
Kutsu API-t
Saada see päisena Authorization: Bearer <key> aadressile https://api.tapti.me/v1/company.

Päring	Tagastab
GET /v1/company	Ettevõtte, kellele võti kuulub
GET /v1/company/reservations, /appointments	Broneeringud, filtreeritud parameetritega status, branchId, from, to või updatedSince, 100 lehe kohta
GET /v1/company/reservations/{id}	Ühe broneeringu
POST /v1/company/reservations/{id}/status	Muudab olekut (kirjutusõigusega võtmed)
GET /v1/company/orders, /orders/{id}	Tellimused koos toodete ja summadega, filtreeritud parameetritega status, source, fulfilment, from, to või paidSince
GET /v1/company/loyalty/programs, /cards, /rewards	Püsikliendiprogrammid, liikmete kaardid ja nende teenitud preemiad
GET /v1/company/events?after={cursor}	Kõik broneeringute, tellimuste ja püsikliendiprogrammi sündmused järjekorras — päri seda regulaarselt, et olla sünkroonis; ainult osa jaoks lisa type=order,loyalty
POST /v1/company/webhooks, DELETE /v1/company/webhooks/{id}	Tellib URL-ile sündmused ja tühistab tellimuse — seda kasutavad Zapieri, Make’i, n8n-i ja Pipedreami rakendused

Kui midagi ebaõnnestub

Iga lõpp-punkti saatmislogi näitab selle viimast 25 saatmist koos olekukoodi ja sinu süsteemi antud vastusega. Ebaõnnestunud saatmisi korratakse automaatselt; „Saada uuesti“ kordab ühte kohe.

Korduma kippuvad küsimused

Kas webhooki saab saata Zapierisse või Make’i?

Jah — kasuta jaotist „Integratsioonid → Automatiseerimine“, mis kontrollib, et aadress kuulub platvormile, ja näitab selle enda samme. Loo „Catch hook“ (Zapier), „Custom webhook“ (Make), Webhook-sõlm (n8n) või HTTP-päästik (Pipedream), kleebi selle aadress ja vajuta „Saada test“, et tööriist väljad ära õpiks.

Kaotasin oma allkirjastamise saladuse.

Omanik saab selle lõpp-punkti juures uuesti nähtavaks teha või selle vahetada. Vahetamine loob kohe uue saladuse ja vana lakkab töötamast.

Kas see artikkel oli kasulik?

Kas see ei vastanud küsimusele?

Kirjuta meile ja nimeta leht, millel olid. Iga sõnumi loeb päris inimene ja vastab samas keeles, milles kirjutasid.

Kirjuta meile