Webhook-pyyntöjen rakenteen ymmärtäminen
Webhook-pyynnöt ovat automaattisia viestejä, joita järjestelmät lähettävät tapahtuman tapahtuessa. Jotta vastaanottava sovellus voi käsitellä nämä viestit oikein, kehittäjän on ymmärrettävä pyynnön tarkka rakenne. Webhook-pyyntöjen tarkistin on työkalu, jonka avulla voit liittää kaapatun webhook-pyynnön menetelmän, otsikot ja rungon tarkastellaksesi sen muotoilua ja luodaksesi kopioitavan cURL-komennon paikallista testausta varten.
Kun webhook-pyyntö vastaanotetaan, se koostuu kolmesta pääosasta:
- Menetelmä: HTTP-metodi, jolla pyyntö lähetetään (kuten POST, PUT, PATCH, GET tai DELETE).
- Otsikot: Avain-arvo-pareja, jotka välittävät metatietoa, kuten sisällön tyypin tai turvallisuuteen liittyviä allekirjoituksia.
- Runko (Body): Varsinainen tapahtumadata, joka on usein JSON-muodossa tai URL-koodattuna lomaketietona.
Tämän rakenteen analysointi auttaa API-kehittäjiä, integraatioinsinöörejä, asiakaspalvelun edustajia ja automaation ylläpitäjiä varmistamaan, että vastaanotettu data vastaa odotettua muotoa.
Syötteet ja niiden rajoitukset
Työkalu vastaanottaa kolme pääasiallista syötettä, joita koskevat tarkat tekniset rajat:
- Menetelmä: Valitaan valmiista luettelosta, joka sisältää vaihtoehdot POST, PUT, PATCH, GET ja DELETE.
- Otsikot: Syötetään muodossa "Name: value", yksi otsikko riviä kohden. Otsikoita voi olla enintään 200 ei-tyhjää riviä, ja niiden kokonaispituus saa olla enintään 100 000 merkkiä.
- Runko: Palvelimelle lähetetty tarkka raakarunko sellaisena kuin se on kaapattu ennen minkäänlaista palvelinpuolen jäsentämistä. Rungon enimmäispituus on 1 000 000 merkkiä.
Jos syötteet ylittävät nämä rajat tai ovat virheellisiä, työkalu näyttää jonkin seuraavista virheilmoituksista:
- Jos otsikkorivi ei vastaa vaadittua muotoa, näytetään virhe
‹line›: Otsikkorivi on virheellinen. Käytä nimeä: arvo.. - Jos otsikoiden määrä ylittää rajan:
Otsikkorivejä on liian monta. Pidä pyyntö 200 otsikkoa tai vähemmän.. - Jos otsikoiden kokonaispituus on liian suuri:
Otsikot ovat liian pitkiä tälle työkalulle. Poista toisiinsa liittymättömät tai toistuvat arvot.. - Jos runko ylittää kokorajan:
Runko on liian pitkä tälle työkalulle. Pidä se alle 1 000 000 merkin pituisena.. - Jos yrität tarkastaa tyhjää pyyntöä:
Liitä ensin vähintään yksi otsikko tai pyynnön tekstiosa..
Webhook-rungon muotoilu ja käsittely säännöt
Työkalu tunnistaa ja muotoilee automaattisesti JSON-muotoiset sekä URL-koodatut (form-encoded) pyynnön rungot. Muut runkotyypit näytetään sellaisenaan pelkkänä tekstinä.
JSON-runkojen käsittelyssä käytetään JavaScriptin sisäänrakennettua JSON.parse-funktiota. Tämä tarkoittaa, että alkuperäinen tyhjä tila, rivivälit ja kenttien alkuperäinen järjestys menetetään uudelleenmuotoilun yhteydessä. Jos runko näyttää JSON-muodolta mutta sisältää syntaksivirheitä, työkalu antaa virheilmoituksen Runko näyttää JSONilta, mutta sitä ei voitu jäsentää.. Jos URL-koodattu lomakkeen runko on virheellinen, näytetään virhe Lomakkeen runko sisältää epätäydellisen prosenttiosuuden..
Jos pyynnön runko on kokonaan tyhjä, tuloskentässä näytetään teksti (tyhjä runko).
Allekirjoitukset ja aikaleimat otsikoissa
Monet webhook-lähettäjät lisäävät pyyntöihin turvaominaisuuksia, kuten kryptografisia allekirjoituksia ja aikaleimoja, joiden avulla vastaanottaja voi varmistaa viestin alkuperän. Työkalu tunnistaa yleisimmät allekirjoitus- ja aikaleimaotsikot niiden nimien perusteella (kuten signature, hmac, digest ja yleiset aikaleimanimet).
Jos tällaisia otsikoita löytyy, ne luetellaan tuloksissa. Jos mitään tunnistettavaa allekirjoitus- tai aikaleimaotsikkoa ei havaita, työkalu näyttää ilmoituksen Yhteistä allekirjoitusta tai webhook-aikaleiman otsikkoa ei löytynyt..
On tärkeää huomata ero allekirjoituksen havaitsemisen ja sen todellisen todentamisen välillä. Allekirjoituskentän löytyminen ei todista pyynnön aitoutta – todellinen varmistus vaatii lähettäjän allekirjoitussäännöt, salaisuuden tai avaimen sekä pyynnön alkuperäiset tavut. Työkalu ei laske HMAC-tiivisteitä, suorita kryptografisia algoritmeja, tarkista pyynnön alkuperäisiä tavuja, käsittele salaisuuksia, valvo replay-aikaikkunoita tai tee palveluntarjoajakohtaisia tarkistuksia.
Paikallinen testaus cURL-komennolla
Yksi webhook-kehityksen parhaista käytännöistä on testata vastaanottavaa sovellusta paikallisesti ennen sen siirtämistä tuotantoon. Työkalu auttaa tässä luomalla syötettyjen tietojen pohjalta valmiin, komentoriville kopioitavan cURL-testikomennon.
Tämä luotu cURL-komento on kiinteästi asetettu osoittamaan paikalliseen osoitteeseen http://localhost:3000/webhooks. Komento sisältää kaikki määrittämäsi otsikot oikein suojattuina sekä pyynnön raakarungon, jolloin voit helposti simuloida webhook-lähetyksen omalla kehityskoneellasi.
Tietosuoja ja käsittely
Kun käytät työkalua, kaikki syöttämäsi tiedot käsitellään paikallisesti. Liitetty pyyntösi pysyy selaimessasi. BroBroGo ei lataa tai tallenna sitä. Käsittely tapahtuu kokonaan käyttäjän omassa verkkoselaimessa.
Usein kysytyt kysymykset
Voiko tämä sivu vastaanottaa live-webhook-soittopyynnön?
Ei. Liitä tallennettu pyyntö tähän tarkastettavaksi. Sivu ei luo julkista päätepistettä, vastaanota takaisinsoittoja tai lähetä luotua testipyyntöä.
Mitä webhook-runkomuotoja voin tarkistaa?
JSON- ja URL-koodatut lomaketekstit tunnistetaan ja alustetaan. Muut tekstit pysyvät pelkkänä tekstinä, joten työkalu ei arvaa XML-, moniosa- tai binaarisisältöä.
Todistaako allekirjoituskentän löytäminen pyynnön aitouden?
Ei. Työkalu näyttää vain allekirjoituksen ja siihen liittyvät aikaleimaotsikot. Todellinen vahvistus vaatii lähettäjän tarkat allekirjoitussäännöt, salaisen tai julkisen avaimen ja alkuperäiset pyyntötavut.