Събития за документи към вашата система чрез уебхукове
Уебхукът изпраща подписано JSON съобщение до ваш URL, когато документ е изпратен, отворен, подписан, завършен, отказан, изтекъл или анулиран. Изисква Pro; настройва се от собственици и администратори.
Този превод е по-стар от статията на английски, затова някои подробности може да са се променили. Прочетете версията на английски
На тази страница
Уебхукът изпраща съобщение до ваш URL адрес всеки път, когато нещо се случи с документ, така че собствената ви система да може да реагира. Уебхуковете са част от Pro: работят в работно пространство, докато някой от собствениците му има Pro, и само собствениците и администраторите могат да ги управляват. Всяко работно пространство има свои уебхукове.
Добавяне на уебхук
- Отворете Настройки и фирмен стил в менюто на акаунта и отидете в Интеграции.
- Натиснете Добавяне на уебхук.
- Въведете URL адрес на крайната точка. Той трябва да започва с
https://и да е публичен: адреси в частни мрежи, собствените адреси на Sealsimple и URL адреси с потребителско име и парола се отхвърлят. - Добавете Име, ако желаете, изберете Събития (в началото всички са отметнати) и натиснете Добавяне на уебхук.
- Копирайте показания Таен ключ за подписване и натиснете Изпращане на тестово събитие.
Едно работно пространство може да има до 10 уебхука.
Събития
document.sent: Документът е изпратенdocument.viewed: Отворен от получател, веднъж за всеки получателdocument.signed: Подписан от подписващ, веднъж за всеки подписващdocument.completed: Завършен: всички подписахаdocument.declined: Отказанdocument.expired: Изтекълdocument.canceled: Анулиран
Какво изпращаме
POST с JSON тяло: id (едно и също при всеки опит, така че да можете да пропускате дубликати), event, created_at, workspace_id, document с id, title, status и url, а при събития за един човек – recipient с name, email и role. Анулираният документ има състояние voided. Самият подписан PDF не се изпраща. Тестовото събитие има събитие test и измислени документ и подписващ.
Проверка на подписа
Всяка заявка има заглавка Sealsimple-Signature от вида t=1700000000,v1=…, заедно със Sealsimple-Event и Sealsimple-Delivery. За да я проверите:
- Вземете необработеното тяло на заявката точно както е пристигнало.
- Прочетете
t(Unix време в секунди) иv1от заглавката. - Изчислете HMAC-SHA256 на
t, точка и тялото, с целия си таен ключ за подписване като ключ, в шестнадесетичен запис с малки букви. - Приемете заявката само ако резултатът е равен на
v1(сравнявайте за постоянно време) иtе отпреди най-много няколко минути.
В раздела Как да свържете частта Проверка на подписа (Node.js) показва това като код, с бутон Копиране на кода. Нов ключ заменя ключа на мига, затова обновете проверката си веднага след това.
Повторни опити, дневникът и пауза
Отговорете със статус 2xx в рамките на 10 секунди. В противен случай опитваме отново по-късно, общо до 6 опита за около денонощие. Пренасочванията не се следват, а отговор 410 спира опитите. Дневник на доставките показва последните 50 съобщения с отговора на крайната ви точка, а Повторно изпращане изпраща някое от тях отново.
След 20 неуспешни доставки подред поставяме уебхука на пауза (На пауза след грешки) и изпращаме имейл на собствениците на работното пространство. Отстранете проблема с крайната точка, включете уебхука отново и изпратете повторно нужното от дневника. Можете също да поставите уебхук на пауза с превключвателя му: събитията, които се случат, докато е на пауза, не се изпращат по-късно. Без Pro уебхуковете остават, но не изпращат нищо.