Hvað er webhook og hvernig notarðu það?

Webhooks leyfa vefforritum að hafa samskipti með því að nota sérsniðnar svarhringingar.

Notkun vefhóka gerir vefforritum kleift að eiga sjálfvirk samskipti við önnur vefforrit.

Ólíkt hefðbundnum kerfum þar sem eitt kerfi (viðfangsefni) heldur áfram að skoða annað kerfi (áheyrnarfulltrúa) fyrir sum gögn, leyfa vefhókar áhorfandanum að ýta sjálfkrafa gögnum inn í kerfi viðfangsefnisins hvenær sem atburður á sér stað.

Þetta útilokar þörfina á stöðugu eftirliti viðfangsefnisins. Webhooks starfa alfarið á netinu og því verða öll samskipti milli kerfa að fara fram í formi HTTP skilaboða.

Notkun vefhóka

Webhooks treysta á tilvist kyrrstæðra vefslóða sem benda á API í kerfi viðfangsefnisins sem þarf að láta vita þegar atburður á sér stað í kerfi áhorfandans. Dæmi um þetta væri vefforrit sem er hannað til að safna og stjórna öllum pöntunum á Amazon reikningi notanda. Í þessari atburðarás virkar Amazon sem áheyrnarfulltrúi og sérsniðin pöntunarstjórnun vefappsins virkar sem viðfangsefnið.

Í stað þess að láta sérsniðna vefappið hringja reglulega í Amazon API til að athuga hvort pöntun hafi verið búin til, myndi vefhook sem búin var til í sérsniðnu vefappinu gera Amazon kleift að senda sjálfkrafa pöntun sem nýlega var búin til í vefappinu í gegnum skráða vefslóð. Þess vegna, til að hægt sé að nota vefhooks, verður viðfangsefnið að hafa tilgreindar vefslóðir sem taka við tilkynningum um atburði frá áhorfandanum. Þetta dregur úr verulegu álagi á hlutinn þar sem HTTP símtöl eru aðeins gerð á milli tveggja aðila þegar atburður á sér stað.

Kerfi sem byggir á skoðanakönnunum vs kerfi sem byggir á vefhókum

Þegar áheyrnarfulltrúinn hefur hringt í vefhook viðfangsefnisins getur viðfangsefnið gripið til viðeigandi aðgerða með þessum nýlega innsendum gögnum. Venjulega eru webhooks gerðar með POST beiðnum á tiltekna vefslóð. POST beiðnir gera þér kleift að senda viðbótarupplýsingar til hlutarins. Að auki er einnig hægt að nota það til að bera kennsl á fjölda ýmissa mögulegra viðburða í stað þess að búa til sérstakar vefhook-slóðir fyrir hvern viðburð.

Webhook verkflæði

Til að innleiða vefkróka á heimleið á forritið þitt þarftu að framkvæma eftirfarandi grunnskref:

• Sýndu API endapunkt á forritaþjóninum þínum sem tekur við og vinnur úr HTTP POST símtölum
• Veittu mögulegum nethook notendum aðgang að þessum endapunkti. API endapunkturinn kallar á gagnagjafaforrit þegar viðeigandi skilyrði eru uppfyllt.
• Vinndu úr POST gögnunum og skilaðu svari til vefhooksímtalsins til að gefa til kynna stöðuna. Þetta skref gæti verið til staðar eða ekki.

Webhooks vs API

Bæði webhooks og API hafa það að markmiði að koma á samskiptum milli forrita. Hins vegar eru nokkrir áberandi kostir og gallar við að nota Webhooks yfir API til að ná samþættingu forrita.

Webhooks hafa tilhneigingu til að vera betri lausnir ef eftirfarandi atriði skipta meira máli fyrir innleitt kerfi:

• Ef gögnin eru oft uppfærð á þjóninum, hafa webhooks tilhneigingu til að vera betri lausnir þar sem óþarfa API símtöl frá viðskiptavininum til þjónsins eru eytt. Samkvæmt resthooks.com fara 98,5% API kannana til spillis.
• Webhooks gera betri lausnir fyrir kerfi sem krefjast nánast rauntímauppfærslu gagna. API kannanir keyra venjulega með ákveðnu millibili sem getur komið í veg fyrir að lifandi gögn séu uppfærð. Með webhooks eru uppfærslur sendar frá þjóninum til viðskiptavinarins um leið og webhooks er ræst.

Notkun API ætti að vera valinn yfir webhooks í sumum öðrum aðstæðum.

Atriði sem þarf að huga að

Mikilvægu atriðin sem þarf að hafa í huga við notkun API á Webhooks eru:

• Notkun API gerir þér kleift að sérsníða betur hvenær á að skoða gögn frá netþjóni og einnig hversu mikið af gögnum á að skoða frá þjóninum. Magn gagna sem á að kanna er stjórnað af API könnunarstærð. Með webhooks ákveður þjónninn almennt gögnin og hvenær þau eru send.
• Fyrir kerfi með mjög breytileg gögn (eins og rauntímakerfi, IoT kerfi osfrv.), gæti API-undirstaða skoðanakönnun verið betri kostur þar sem fyrir hvert API símtal eru miklar líkur á nothæfum svörum.
• Það er mögulegt fyrir gögn sem send eru frá netþjóni, í gegnum vefhook, að vera algjörlega hunsuð af viðskiptavininum ef REST endapunktarnir eru ótengdir. Ef þjónninn hefur ekki kerfi til að reyna aftur slíka misheppnaða ýtingu tapast gagnauppfærslur algjörlega.

Til að takast á við möguleikann á að tapa gögnum sem send eru frá netþjóni þegar nettengingin fer í nettengingu geturðu notað viðburðarskilaboðaröð til að geyma þessi símtöl. Dæmi um palla sem veita slíka virkni eru ma Kanína MQ o Simple Queue Service (SQS) frá Amazon. Báðar eru hannaðar til að virka sem milligönguskilaboðageymslur sem forðast möguleika á að missa af nethringi.

Ercole Palmeri