Skip to main content
Časť Webhooky v Nastavenia → Pre vývojárov umožňuje VEXiON cards oznamovať vášmu systému veci hneď, ako sa stanú. Je dostupná pre administrátorov. Váš softvér by sa inak musel API neustále pýtať „je už niečo nové?”. Webhook to obracia naruby: raz zaregistrujete adresu a vždy, keď sa niečo stane, zákazník sa zaregistruje, zaznamená sa transakcia, zmení sa karta, VEXiON cards pošle na túto adresu podpísaný POST v priebehu sekúnd. Žiadne opakované zisťovanie, žiadne zdržanie.
Záložka Webhooky: tabuľka koncových bodov s ich adresou, počtom udalostí, stavom (Zapnutý alebo Automaticky vypnutý) a dátumom vytvorenia, a tlačidlo Pridať koncový bod.

Nastavenia → Pre vývojárov → Webhooky

Pridanie koncového bodu

1

Otvorte záložku Webhooky

Prejdite do Nastavenia → Pre vývojárov a prepnite sa na záložku Webhooky, potom kliknite na Pridať koncový bod.
2

Zadajte svoju adresu

Vložte Adresu koncového bodu, ktorá bude prijímať udalosti. Musí to byť verejná HTTPS adresa, ktorá dokáže prijímať požiadavky POST, napríklad https://vasobchod.sk/webhooks/vexion.
3

Vyberte, ktoré udalosti prijímať

Zaškrtnite udalosti, ktoré vás zaujímajú, alebo zapnite Všetky udalosti a budete prijímať všetko.
4

Skopírujte podpisový tajný kľúč, jedenkrát

Kliknite na Pridať koncový bod. Váš podpisový tajný kľúč sa zobrazí iba raz, skopírujte si ho a uložte do svojho prijímača, budete ho potrebovať na overovanie podpisov.

Výber udalostí

Každá udalosť má názov v tvare subjekt.akcia, napríklad customer.created, transaction.created alebo card.updated. Sú zoskupené podľa subjektu (zákazník, karta, transakcia a podobne), takže môžete zaškrtnúť celú oblasť naraz. Zapnite Všetky udalosti a budete odoberať každú súčasnú aj budúcu udalosť, je to najjednoduchšia voľba a znamená, že vám nikdy neujde novo pridaný typ udalosti. Alebo ju nechajte vypnutú a zaškrtnite len konkrétne udalosti, ktoré vaša integrácia spracúva.
Dialóg Pridať webhookový koncový bod: pole Adresa koncového bodu, prepínač Všetky udalosti a typy udalostí ako zaškrtávacie políčka zoskupené podľa subjektu (zákazník, karta, vlastné pole, produkt, transakcia, notifikácia).

Pridanie koncového bodu a výber jeho udalostí

Presný zoznam typov udalostí aj tvar každej správy nájdete v API referencii k webhookom. Ako súvisí jedna udalosť so záznamom o doručení a s celoúčtovým prehľadom udalostí, vysvetľuje Udalosti, doručenia a koncové body nižšie.

Overovanie podpisov

Každá požiadavka, ktorú VEXiON cards odošle, je podpísaná podpisovým tajným kľúčom vášho koncového bodu. Váš prijímač by mal podpis prepočítať a porovnať ešte predtým, než správe dôveruje, práve to dokazuje, že požiadavka naozaj prišla z VEXiON cards a nebola pozmenená. Podrobný postup overenia nájdete v API referencii k webhookom.
Podpisový tajný kľúč sa zobrazí raz pri vytvorení koncového bodu a ešte raz, keď ho vymeníte (rotácia). Potom už ho nie je možné zobraziť. Ak ho stratíte, vytvorte rotáciou nový.

Výmena tajného kľúča

Otvorte koncový bod a zvoľte Vymeniť tajný kľúč, napríklad pravidelne alebo ak mohol uniknúť. Nový kľúč sa vygeneruje okamžite a starý funguje ešte 24 hodín, takže svoj prijímač stihnete aktualizovať bez straty jediného doručenia.

Doručenia a opakovania

Otvorte ktorýkoľvek koncový bod a uvidíte jeho Nedávne doručenia, jeden riadok na každý pokus o odoslanie udalosti na danú adresu, s typom udalosti, výsledkom a časom. Filtrujte podľa Všetky, Neúspešné alebo Doručené. Ak doručenie zlyhá, VEXiON cards ho automaticky opakuje s narastajúcimi odstupmi. Ktorékoľvek doručenie môžete aj ručne poslať znova tlačidlom Zopakovať.
Váš koncový bod by mal odpovedať kódom 2xx hneď, ako udalosť prijme, a pomalú prácu spraviť až potom. Rýchla odpoveď je to, čo označí doručenie ako Doručené; pomalá alebo chybová odpoveď sa berie ako zlyhanie a opakuje sa.

Zapnutý, vypnutý a automaticky vypnutý

Koncový bod je Zapnutý, kým prijíma udalosti. Kedykoľvek ho môžete v jeho ponuke Vypnúť a neskôr znova Zapnúť. Ak koncový bod dlho zlyháva, alebo jeho server oznámi, že adresa natrvalo zanikla, VEXiON cards ho nastaví na Automaticky vypnutý a prestane posielať. Opravte svoj prijímač a potom koncový bod znova zapnite.

Otestovanie koncového bodu

Tlačidlom Poslať testovaciu udalosť vyšlete na svoju adresu podpísanú vzorovú udalosť hneď, bez čakania na skutočnú. Vyberte konkrétny typ udalosti alebo pošlite predvolenú vzorku. Výsledok (kód odpovede a ako dlho trvala) sa zobrazí okamžite. Test nevytvorí záznam o doručení.

Udalosti, doručenia a koncové body

Tri úzko súvisiace pojmy sa ľahko zamieňajú. Nie sú to duplikáty, každý odpovedá na inú otázku: Jedna udalosť sa rozvetví na každý zapnutý koncový bod, ktorý ju odoberá, a každý taký pokus je jedno doručenie. V API je celoúčtový prehľad udalostí GET /v1/events; záznam pokusov pre jeden koncový bod je jeho zoznam doručení.

Ďalšie kroky

Vytvorte si API kľúč

Webhooky vám povedia, čo sa stalo; API kľúč vám umožní dáta naspäť čítať a meniť.

API referencia k webhookom

Zoznam udalostí, tvary správ a postup overenia podpisu.