Siųskite dokumentų įvykius į savo sistemą (webhook)
Žiniatinklio kablys (webhook) siunčia pasirašytą JSON pranešimą jūsų URL, kai dokumentas išsiunčiamas, atidaromas, pasirašomas, užbaigiamas, atmetamas, pasibaigia ar atšaukiamas. Reikia Pro.
Šis vertimas senesnis už straipsnį anglų kalba, todėl kai kurios detalės galėjo pasikeisti. Skaityti anglų kalba
Šiame puslapyje
Žiniatinklio kablys (webhook) kaskart, kai su dokumentu kas nors nutinka, siunčia pranešimą jūsų URL, kad jūsų sistema galėtų sureaguoti. Žiniatinklio kabliai yra Pro dalis: jie veikia darbo srityje, kol vienas iš jos savininkų turi Pro, o valdyti juos gali tik savininkai ir administratoriai. Kiekviena darbo sritis turi savo.
Žiniatinklio kablio pridėjimas
- Paskyros meniu atidarykite Nustatymai ir prekės ženklas ir eikite į Integracijos.
- Paspauskite Pridėti žiniatinklio kablį.
- Lauke Galinio taško URL įveskite adresą. Jis turi prasidėti
https://ir būti viešas: privačių tinklų adresai, pačios Sealsimple adresai ir URL su naudotojo vardu ir slaptažodžiu atmetami. - Jei norite, užpildykite Pavadinimas, skiltyje Įvykiai pasirinkite įvykius (iš pradžių pažymėti visi) ir paspauskite Pridėti žiniatinklio kablį.
- Nukopijuokite pasirodžiusį raktą (Parašo raktas) ir paspauskite Siųsti bandomąjį įvykį.
Darbo srityje gali būti iki 10 žiniatinklio kablių.
Įvykiai
document.sent: Dokumentas išsiųstasdocument.viewed: Gavėjas atidarė, vieną kartą kiekvienam gavėjuidocument.signed: Pasirašantysis pasirašė, vieną kartą kiekvienam pasirašančiajamdocument.completed: Užbaigta: visi pasirašėdocument.declined: Atmestadocument.expired: Baigėsi terminasdocument.canceled: Atšaukta
Ką siunčiame
POST užklausą su JSON turiniu: id (toks pats kiekvieno bandymo metu, todėl galite praleisti dublikatus), event, created_at, workspace_id, document su id, title, status ir url, o įvykiuose, susijusiuose su vienu asmeniu, – recipient su name, email ir role. Atšaukto dokumento būsena – voided. Pats pasirašytas PDF nesiunčiamas. Bandomojo įvykio event reikšmė yra test, o dokumentas ir pasirašantysis – išgalvoti.
Parašo tikrinimas
Kiekvienoje užklausoje yra antraštė Sealsimple-Signature, pvz., t=1700000000,v1=…, šalia Sealsimple-Event ir Sealsimple-Delivery. Norėdami ją patikrinti:
- Paimkite neapdorotą užklausos turinį tiksliai tokį, koks jis atėjo.
- Iš antraštės nuskaitykite
t(Unix laikas sekundėmis) irv1. - Apskaičiuokite
t, taško ir turinio HMAC-SHA256, kaip raktą naudodami visą savo parašo raktą, ir užrašykite jį mažosiomis raidėmis šešioliktainiu formatu. - Priimkite užklausą tik tada, jei rezultatas lygus
v1(naudokite pastovaus laiko palyginimą) irtyra ne senesnis nei kelios minutės.
Skiltyje Kaip prijungti dalyje Parašo tikrinimas (Node.js) tai parodyta kodu su mygtuku Kopijuoti kodą. Naujas raktas iš karto pakeičia raktą, todėl iškart po to atnaujinkite savo tikrinimą.
Pakartotiniai bandymai, žurnalas ir pristabdymas
Atsakykite 2xx būsenos kodu per 10 sekundžių. Kitaip bandysime dar kartą vėliau – iš viso iki 6 bandymų maždaug per parą. Peradresavimų nesekame, o atsakymas 410 sustabdo bandymus. Pristatymų žurnalas rodo paskutinius 50 pranešimų su jūsų galinio taško atsakymu, o Siųsti dar kartą išsiunčia pranešimą pakartotinai.
Po 20 nesėkmingų pristatymų iš eilės žiniatinklio kablį pristabdome (Pristabdytas dėl klaidų) ir el. paštu pranešame darbo srities savininkams. Sutvarkykite galinį tašką, vėl įjunkite žiniatinklio kablį ir iš žurnalo pakartotinai išsiųskite tai, ko reikia. Žiniatinklio kablį galite pristabdyti ir jo jungikliu: įvykiai, įvykę jam esant pristabdytam, vėliau nesiunčiami. Be Pro žiniatinklio kabliai lieka, bet nieko nesiunčia.