Skilningur á uppbyggingu webhook-beiðna
Vefkrókar (e. webhooks) eru sjálfvirkar sendingar sem kerfi nota til að miðla gögnum til annarra kerfa jafnskjótt og atburður á sér stað. Þegar unnið er með samþættingar er mikilvægt að skilja nákvæmlega hvernig þessar beiðnir líta út þegar þær berast. Skoðari webhook-beiðna er hannaður til að hjálpa forriturum, tæknimönnum og þjónustufulltrúum að greina uppbyggingu slíkra beiðna á einfaldan hátt.
Með því að líma aðferð, hausa og meginmál tekinna gagna geturðu séð hvernig beiðnin er samsett, hvort hún inniheldur rétt snið og hvaða öryggisupplýsingar fylgja henni. Þetta flýtir fyrir greiningu á villum og auðveldar prófanir í staðbundnu þróunarumhverfi.
Hlutverk hausa í samskiptum vefkróka
Hausar (e. headers) gegna lykilhlutverki í samskiptum vefkróka þar sem þeir flytja lýsigögn um sjálfa beiðnina. Þeir tilgreina til dæmis hvers konar gögn er verið að senda og hvernig móttakarinn á að túlka þau.
Í þessu tól geturðu slegið inn allt að 200 hauslínur (að hámarki 100.000 stafir) þar sem hver lína fylgir sniðinu „Nafn: gildi“. Ef farið er yfir þessi mörk eða ef sniðið er rangt mun tólið sýna viðeigandi villuboð:
- Ef hausarnir eru of margir: „Það eru of margar hauslínur. Haltu beiðninni við 200 hausa eða færri.“
- Ef heildarlengd er yfir mörkum: „Hausarnir eru of langir fyrir þetta tól. Fjarlægðu ótengd eða endurtekin gildi.“
- Ef lína fylgir ekki réttu sniði: „
‹line›: Hauslína er ógild. Notaðu nafn: gildi.“
Mismunandi snið á meginmáli vefkróka
Meginmál (e. body) webhook-beiðna getur verið á ýmsum sniðum, en algengustu gerðirnar eru JSON og vefslóðakóðuð eyðublöð (e. URL-encoded form data). Til að tryggja nákvæma greiningu er mikilvægt að nota nákvæmlega hráa hlutann sem var tekinn áður en nokkur þáttun á sér stað á netþjóni.
Tólið styður meginmál allt að 1.000.000 stafir. Ef farið er yfir það birtast villuboðin: „Líkaminn er of langur fyrir þetta verkfæri. Haltu því undir 1.000.000 stöfum.“.
Skoðari webhook-beiðna greinir og meðhöndlar gögnin á eftirfarandi hátt:
- JSON: Gögnin eru þáttuð með
JSON.parseog endurraðað. Við þetta breytist upprunalegt bil og uppsetning reita. Ef gögnin líta út eins og JSON en innihalda villur birtist villan: „Líkaminn lítur út eins og JSON en ekki var hægt að flokka hann.“. - Vefslóðakóðuð gögn: Ef formgögnin innihalda ófullkomna kóðun birtast villuboðin: „Meginmál eyðublaðsins inniheldur ófullnægjandi prósentuskil.“.
- Önnur snið: Önnur meginmál haldast sem venjulegur texti án sérstakrar sniðsbreytingar. Ef ekkert meginmál er slegið inn sýnir úttakið „(tómt meginmál)“.
Undirskriftir og tímastimplar vefkróka
Öryggi vefkróka byggir oft á því að sendandinn undirritar beiðnina með dulmálslykli. Þetta er gert með því að bæta sérstökum undirskriftar- eða tímastimplahausum við beiðnina.
Tólið leitar í hausum beiðninnar að algengum heitum eins og signature, hmac, digest og þekktum tímastimplaheitum. Ef slíkir reitir finnast eru þeir dregnir út og sýndir undir „Undirskriftareitir“. Ef engir slíkir reitir finnast birtist textinn: „Engin algeng undirskrift eða vefhook tímastimpilshaus fannst.“.
Munurinn á skoðun og staðfestingu áreiðanleika
Mikilvægt er að gera greinarmun á því að finna undirskriftarhausa og því að staðfesta að beiðnin sé raunverulega ósvikin. Tólið reiknar ekki út HMAC, framkvæmir engar reikniritsskoðanir, ber ekki saman upprunaleg bæti meginmálsins, athugar ekki leynilykla eða tímamörk (e. replay window) og framkvæmir ekki staðfestingar sem tengjast tilteknum þjónustuveitendum.
Eins og fram kemur í kerfinu: „Það að finna undirskriftareit sanna ekki að beiðnin sé ósvikin — raunveruleg staðfesting krefst undirritunarreglna sendanda, leyndarmáls eða lykils og upprunalegu bæta beiðninnar.“.
Staðbundið cURL próf fyrir þróunaraðila
Ein gagnlegasta aðferðin við að prófa móttöku vefkróka á eigin tölvu er að nota skipanalínuverkfærið cURL. Þegar þú hefur slegið inn upplýsingar um beiðnina býr þetta tól sjálfkrafa til tilbúna cURL skipun sem er sérstaklega sniðin fyrir staðbundnar prófanir.
Þessi skipun er fastsett við að senda beiðnina á staðbundna vistfangið http://localhost:3000/webhooks. Með því að afrita þessa skipun geturðu endursent nákvæmlega sömu beiðni, með sömu hausum og meginmáli, beint á þróunarnetþjóninn þinn án þess að þurfa að kalla fram raunverulegan atburð hjá þjónustuveitunni.
Öryggi og vinnsla gagna
Þegar unnið er með viðkvæmar upplýsingar úr vefkrókum er mikilvægt að vita hvernig gögnin eru meðhöndluð. Öll vinnsla á þessari síðu fer eingöngu fram í þínum eigin vafra. Límda beiðni þín verður áfram í vafranum þínum. BroBroGo hleður því ekki upp eða vistar það.
Algengar spurningar
Getur þessi síða fengið svarhringingu á vefhook í beinni?
Nei. Límdu tekin beiðni hér til skoðunar. Síðan býr ekki til opinberan endapunkt, tekur á móti svarhringingum eða sendir útbúna prófunarbeiðni.
Hvaða vefhook líkamssnið get ég skoðað?
JSON- og vefslóðakóðuðar eyðublöð eru greindar og sniðnar. Aðrir hlutar haldast sem venjulegur texti svo tólið giskar ekki á XML, margþætt eða tvöfalt efni.
Sannar það að finna undirskriftareit að beiðnin sé ósvikin?
Nei. Tólið sýnir aðeins undirskriftir og tengda tímastimplahausa. Raunveruleg staðfesting þarf nákvæmar undirskriftarreglur sendanda, leynilegan eða opinberan lykil, og upprunalegu beiðnibætin.