Tīmekļa āķi (webhooks): dokumentu notikumi jūsu sistēmā
Tīmekļa āķis sūta uz jūsu URL parakstītu JSON ziņojumu, kad dokumentu nosūta, atver, paraksta, pabeidz, noraida, atceļ vai tam beidzas termiņš. Vajadzīgs Pro; iestata īpašnieki un administratori.
Šis tulkojums ir vecāks par rakstu angļu valodā, tāpēc dažas detaļas var būt mainījušās. Lasīt angļu valodā
Šajā lapā
Tīmekļa āķis nosūta ziņojumu uz jūsu URL katru reizi, kad ar dokumentu kaut kas notiek, lai jūsu sistēma varētu uz to reaģēt. Tīmekļa āķi ir daļa no Pro: tie darbojas darbvietā, kamēr kādam no tās īpašniekiem ir Pro, un tos var pārvaldīt tikai īpašnieki un administratori. Katrai darbvietai ir savi tīmekļa āķi.
Tīmekļa āķa pievienošana
- Konta izvēlnē atveriet Iestatījumi un zīmols un pārejiet uz sadaļu Integrācijas.
- Nospiediet Pievienot tīmekļa āķi.
- Aizpildiet lauku Galapunkta URL. Tam jāsākas ar
https://un jābūt publiskam: adreses privātos tīklos, Sealsimple adreses un URL ar lietotājvārdu un paroli netiek pieņemti. - Ja vēlaties, aizpildiet Nosaukums, sadaļā Notikumi izvēlieties notikumus (sākumā atzīmēti visi) un nospiediet Pievienot tīmekļa āķi.
- Nokopējiet parādīto paraksta atslēgu (Paraksta atslēga) un nospiediet Sūtīt testa notikumu.
Darbvietā var būt līdz 10 tīmekļa āķiem.
Notikumi
document.sent: Dokuments nosūtītsdocument.viewed: Adresāts atvēra, vienreiz katram adresātamdocument.signed: Parakstītājs parakstīja, vienreiz katram parakstītājamdocument.completed: Pabeigts: visi parakstījadocument.declined: Noraidītsdocument.expired: Termiņš beidziesdocument.canceled: Atcelts
Ko mēs sūtām
POST pieprasījums ar JSON saturu: id (vienāds katrā mēģinājumā, lai varētu izlaist dublikātus), event, created_at, workspace_id, document ar id, title, status un url un notikumiem, kas attiecas uz vienu personu, — recipient ar name, email un role. Atceltam dokumentam ir statuss voided. Pats parakstītais PDF netiek sūtīts. Testa notikumam ir notikums test un izdomāts dokuments un parakstītājs.
Paraksta pārbaude
Katram pieprasījumam ir galvene Sealsimple-Signature, piemēram, t=1700000000,v1=…, līdzās Sealsimple-Event un Sealsimple-Delivery. Lai to pārbaudītu:
- Ņemiet neapstrādāto pieprasījuma saturu tieši tādu, kāds tas pienāca.
- Nolasiet no galvenes
t(Unix laiks sekundēs) unv1. - Aprēķiniet HMAC-SHA256 no
t, punkta un satura, kā atslēgu izmantojot visu paraksta atslēgu, mazo burtu heksadecimālā formā. - Pieņemiet pieprasījumu tikai tad, ja rezultāts ir vienāds ar
v1(salīdziniet konstantā laikā) untnav vecāks par dažām minūtēm.
Sadaļā Kā savienot vienums Paraksta pārbaude (Node.js) parāda to kā kodu ar pogu Kopēt kodu. Jauna atslēga nekavējoties aizstāj atslēgu, tāpēc uzreiz pēc tam atjauniniet savu pārbaudi.
Atkārtoti mēģinājumi, žurnāls un apturēšana
Atbildiet ar 2xx statusu 10 sekunžu laikā. Pretējā gadījumā mēs mēģinām vēlreiz vēlāk, kopā līdz 6 mēģinājumiem aptuveni diennakts laikā. Novirzīšanām mēs nesekojam, un atbilde 410 aptur mēģinājumus. Piegādes žurnāls rāda pēdējos 50 ziņojumus ar jūsu galapunkta atbildi, un Sūtīt vēlreiz nosūta kādu no tiem vēlreiz.
Pēc 20 neveiksmīgām piegādēm pēc kārtas mēs apturam tīmekļa āķi (Apturēts kļūdu dēļ) un nosūtām e-pastu darbvietas īpašniekiem. Salabojiet galapunktu, atkal ieslēdziet tīmekļa āķi un no žurnāla nosūtiet vēlreiz to, kas vajadzīgs. Tīmekļa āķi varat apturēt arī ar tā slēdzi: notikumi, kas notiek, kamēr tas ir apturēts, vēlāk netiek nosūtīti. Bez Pro tīmekļa āķi paliek, bet neko nesūta.