Loo API-võtmed ja veebihaagid
Loo piiratud õigustega API-võtmeid Nola REST API jaoks ja saada allkirjastatud broneeringu- ja maksesündmusi oma lõpp-punkti, näiteks n8n-i või Zapierisse.
API-võtmed võimaldavad skriptil või automaatikal lugeda ja kirjutada sinu andmeid REST API kaudu. Veebihaagid saadavad sündmusi sinu serverisse, kui midagi juhtub. Mõlemad asuvad lehel Seaded → Integratsioonid.
Loo API-võti
- Ava Seaded → Integratsioonid ja keri jaotiseni API-võtmed.
- Jaotises Uus võti anna võtmele Nimi, mis näitab, kus seda kasutatakse, näiteks „n8n töövoog“.
- Märgi Õigused, mida võti vajab. Vali vähemalt üks.
- Klõpsa Loo.
- Kopeeri võti kohe rohelisest kastist. See algab prefiksiga
oh_live_ja seda kuvatakse ainult üks kord.
Saada see iga päringuga päises Authorization: Bearer oh_live_…. Lõpp-punktid, päringute sisud ja näited leiad lehelt REST API viide.
| Õigus | Märkeruut | Mida lubab |
|---|---|---|
bookings:read | Bookings, read | Kuva broneeringute nimekiri |
bookings:write | Bookings, write | Loo ja tühista broneeringuid |
availability:read | Availability, read | Vaata vabu aegu |
resources:read | Resources, read | Kuva oma ressursside nimekiri |
clients:read | Clients, read | Kuva klientide nimekiri |
clients:write | Clients, write | Loo kliente |
wallet:read | Wallet, read | Vaata rahakoti tehinguid |
Iga võti saab teha kuni 600 päringut minutis. Sellest rohkemate päringute korral vastab API staatusega 429.
Halda võtmeid
Võtmete tabelis näed iga võtme nime, esimesi märke, õigusi, väärtust Viimati kasutatud ja staatust. Nupp Tühista ligipääs lülitab võtme lõplikult välja. Õiguste muutmiseks loo uus võti ja tühista vana.
Lisa veebihaagi lõpp-punkt
- Ava lehel Seaded → Integratsioonid jaotis Veebihaagid ja otsi üles Uus lõpp-punkt.
- Kleebi oma URL. See peab olema täielik aadress, näiteks
https://your-n8n.example.com/webhook/nola. - Märgi Sündmused, mida soovid vastu võtta. Vali vähemalt üks.
- Klõpsa Lisa.
Nola saadab praegu neid sündmusi:
| Sündmus | Saadetakse, kui |
|---|---|
booking.created | Broneering luuakse: veebis, töötaja poolt või API kaudu |
booking.updated | Broneeringu staatus muutub, näiteks kinnitatuks või mitteilmunuks |
booking.cancelled | Broneering tühistatakse |
payment.succeeded | Veebimakse õnnestub |
Nimekirjas on ka extension.offered, extension.accepted ja class.enrolled. Saad neid tellida, kuid Nola ei saada neid veel välja.
Kuidas kohaletoimetamine töötab
Iga sündmus saadetakse POST-päringuna JSON-kehaga: event, createdAt ja data. Päised sisaldavad välja X-Nola-Event sündmuse nimega ja X-Nola-Signature kujul t=<timestamp>,v1=<signature>. Allkiri on HMAC-SHA256 väärtusest <timestamp>.<body>, mis on loodud lõpp-punkti salavõtmega. Kontrollimiskoodi näite leiad lehelt REST API viide. Rakendus veel salavõtit ei kuva, seega kui vajad seda allkirjade kontrollimiseks, võta ühendust toega.
Sinu lõpp-punkt peaks vastama staatusega 2xx. Kõik muud vastused loetakse ebaõnnestumiseks:
- Nola proovib uuesti kasvavate intervallidega (kuni tunnise vahega), kuni 8 katset iga sündmuse kohta.
- Pärast 20 järjestikust ebaõnnestunud katset lülitatakse lõpp-punkt välja ja selle staatus on Väljas koos ebaõnnestumiste arvuga. Tee oma server korda ja klõpsa seejärel Lülita sisse. Edukas kohaletoimetamine lähtestab loenduri.
Testimine ja tõrkeotsing
Igal lõpp-punkti real on järgmised toimingud:
- Saada test: kuvab teate „Test event sent“, kuid testsündmus (
test.ping) ei jõua praegu lõpp-punktideni. Testimiseks tee oma broneerimislehel broneering ja jälgi logi Kohaletoimetamise logi. - Lülita sisse või Lülita välja: pane kohaletoimetamine pausile ilma lõpp-punkti kustutamata.
- Kohaletoimetamise logi: iga kohaletoimetamine koos sündmuse, staatuse, vastusekoodi, katsete arvu ja ajaga. Kui kõik katsed on ära kasutatud, on kohaletoimetamisel nupp Proovi uuesti.
- Eemalda: kustutab lõpp-punkti.
Vana webhooki URL
Lõpp-punktide all asub Vana webhooki URL, mis on varasem ühe URL-iga seadistus. See võtab allkirjastamata broneeringusündmusi vastu sinu lõpp-punktidest eraldi. Kui kasutad seda endiselt, mine üle allkirjastatud lõpp-punktile ja tühjenda see väli.
Seotud teemad
Kas sellest lehest oli abi?
Ikka ei leia vastust?
Küsi Nolas AI Copilotilt või saada pöördumine Nola meeskonnale. Inimene vastab ühe tööpäeva jooksul.