Sat Sep 26 2020
...

Webhooks prihajajo v FastComments

! Ta članek vsebuje tehnično terminologijo

Kaj je novega

Z FastComments je zdaj mogoče poklicati API končno točko, kadarkoli se komentar doda, posodobi ali odstrani iz našega sistema.

To dosežemo z asinhronimi webhooki preko HTTP/HTTPS.

Kako to uporabljati

Najprej se pomaknite do administratorja Webhookov. To lahko dostopate preko Upravljanje podatkov -> Webhooki.

Od tam lahko določite končne točke za vsako vrsto dogodka komentarja.

Za vsako vrsto dogodka se prepričajte, da kliknete Pošlji testno nakladanje, da se prepričate, da ste pravilno nastavili integracijo. Za podrobnosti glejte naslednji razdelek "Testiranje".

Testiranje

V administratorju Webhookov so gumbi "Pošlji testno nakladanje" za vsak tip dogodka (Ustvari, Posodobi, Izbriši). Ustvari in Posodobi dogodki pošljejo dummy objekt WebhookComment, medtem ko testiranje Izbriši pošlje dummy telo zahteve z le ID-jem.

Test bo izvedel dva klica za preverjanje kode odgovora za "srečno" (pravilna API Ključ) in "žalostno" (neveljavna API ključ) scenarije.

Ko test pošlje neveljaven API ključ, bi morali vrniti statusno kodo 401, da test popolnoma uspe. Če pravilno ne preverite vrednosti žetona, boste videli napako, kot je:

Struktura objekta komentarja

/** * @typedef {Object} WebhookComment * @property {string} id * @property {string} urlId * @property {string} url * @property {string} userId * @property {string} commenterEmail * @property {string} commenterName * @property {string} comment * @property {string} commentHTML * @property {string} parentId * @property {DateString} date * @property {number} votes * @property {boolean} verified * @property {number} verifiedDate * @property {boolean} reviewed * @property {string} avatarSrc * @property {boolean} isSpam * @property {boolean} aiDeterminedSpam * @property {boolean} hasImages * @property {number} pageNumber * @property {boolean} approved * @property {string} locale */

Struktura dogodka "Ustvari"

Telo zahteve za dogodek "ustvari" je objekt WebhookComment.

Struktura dogodka "Posodobi"

Telo zahteve za dogodek "posodobi" je objekt WebhookComment.

Struktura dogodka "Izbriši"

Telo zahteve za dogodek "izbriši" je objekt WebhookComment, vendar vsebuje le id.

Zakaj oba, Ustvari in Posodobi, uporabljata HTTP PUT in ne POST?

Ker vse naše zahteve vsebujejo ID, ponavljanje iste zahteve Ustvari ali Posodobi ne bi smelo ustvariti novih objektov na vaši strani. To pomeni, da so ti klici idempotentni in bi morali biti PUT dogodki v skladu s specifikacijo HTTP.

Kako deluje

Vse spremembe objekta Komentar v sistemu sprožijo dogodek, ki konča na vrsti. To vrsto lahko spremljate v administratorju Webhookov, v primeru da vaš API preneha delovati. Če zahteva vašemu API-ju ne uspe, jo bomo ponovno vrnili v načrt. Ta načrt je 1 minuta * število poskusov. Če klic ne uspe enkrat, bo poskusil znova čez minuto. Če ne uspe dvakrat, bo nato čakal dve minuti in tako naprej. To je, da ne obremenjujemo vašega API-ja, če preneša delovati iz povezanih razlogov.

Varnost in API žeton

V glavi zahteve bomo poslali vaš API Secret v parametru imenovanem "token".

Če tega parametra ne preverite pravilno, vaša integracija ne bo označena kot preverjena. To je zaščitna ovira, da zagotovimo, da so vse integracije s FastComments varne.

Na koncu

Upamo, da boste integracijo FastComments Webhook enostavno razumeli in hitro nastavili.

Če imate dodatna vprašanja, se obrnite na stran za podporo strankam.

Na zdravje!

Sat Sep 26 2020...