Embedování umožní zobrazovat detail obálky přímo z vašeho systému, namísto prostředí DigiSignu. Vaši uživatelé tak ani nemusí mít uživatelský účet DigiSign.
Pro embedování je potřeba mít existující obálku (znát její ID). Pokud ještě obálku nemáte vytvoříte ji přes REST API nebo ve webovém rozhraní DigiSign.
Odkaz pro vytvoření embedovaného detailu obálky získáte provoláním endpointu Embed Envelope:
POST /api/envelopes/{{envelopeID}}/embedAby záskaná URL vedla do detailu obálky a co vše bude uživateli umožněno se nastavuje doplňujícími parametry v request body.
Nastavitelné parametry request body
1) target
V requestu pomocí parametru target určíte, že má odkaz vést do detailu obálky:
"target":"detail"
2) allowedActions
Pomocí parametru allowedActions lze zadat jaké všechny akce bude mít uživatel na obálce dostupné. Pokud se parametr v requestu nepošle, budou povoleny všechny dostupné akce.
Akce nad detailem obálky:
envelopeResend - umožní odeslat znovu obálku
envelopeCancel - umožní zrušit obálku
envelopeChangeArchivationSettings - umožní změnit dobu archivace obálky
recipientResend - umožní odeslat obálku znovu konkrétnímu příjemci
recipientEdit - umožní upravit příjemce
recipientDelete - umožní smazat příjemce
3) language
Parametrem language určíte, v jakém jazyce bude výsledná stránka uživateli zobrazena.
Aktuálně podporujeme následující jazykové mutace:
cs - čeština
sk - slovenština
en - angličtina
pl - polština
hu - maďarština
ro - rumunština
nl - nizozemština
Příklad requestu včetně parametrů:
POST /api/envelopes/3974d252-b027-46df-9fd8-ddae54bc9ab9/embed
{
"target": "detail",
"allowedActions": ["envelopeResend", "envelopeCancel", "recipientResend", "recipientEdit", "recipientDelete"],
"language": "en"
}
Response
Po odeslání requestu se v odpovědi vrátí URL. Platnost vygenerované URL je vždy 5 minut.
{
"hash": "154715c6978c4614ae69d88be591fcd5",
"url": "https://api.digisign.org/ee/15471...1fcd5",
"iat": 1629972916,
"exp": 1629973216,
}Provoláním vracené URL uživatele systému přesměrujete na požadovaný detail obálky.
Embedování je možné otevřít i do <iframe>.
Otevírání do <iframe> je momentálně sice možné, ale tuto metodu nedoporučujeme používat. Povolení iframe přidává bezpečnostní rizika a může se stát, že ho budeme nuceni v budoucnu zakázat.
Odchytávání Eventů
V rámci <iframe> nebo vyskakovacího okna se při konečných stavech (koncept uložen, koncept zahozen, obálka odeslána) v rámci javascriptu volá .postMessage() s objektem, ve kterém se nachází status
{
"status": "resend"
}tyto stavy je možné zachytit pomocí
window.addEventListener(‘message’, () => { //* your code *// });Seznam Eventů na Envelope Detail
canceled
correction
discarded
resend
Seznam Eventů recipenta na Envelope Detail
Při těchto akcích je kromě klíče status k dispozici také recipientId pro identifikaci, kterého recipienta se změna týká.
recipientResend
recipientRemove
recipientUpdate
Vyzkoušejte embedování bez programování
Pro vyzkoušení embedování bez nutnosti implementace nabízíme naše jedoduché demo (dostupné pouze z testovacího prostředí).