Embedování umožní spravovat a/nebo odesílat 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é editace obálky získáte provoláním endpointu Embed Envelope:
POST /api/envelopes/{{envelopeID}}/embedKam přesně získaná URL povede a co vše bude moci uživatel upravovat se nastavuje nepovinnými parametry v request body.
Nastavitelné parametry request body
Žádný z parametrů není povinný, je tedy možné poslat i request s prázdným body. V takovém případě se aplikují výchozí hodnoty - výsledná stránka tak povede do editace obálky, bude v češtině a budou na ní povoleny všechny akce.
1) target
V requestu lze pomocí parametru target určit, kam má odkaz směřovat:
edit - editace obálky (výchozí)
tags - umísťování polí
Pro embedování editace nebo umísťování polí musí být obálka ve stavu koncept (draft), nebo korekce (correction).
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 editací / umístěním polí obálky:
signatureTagManipulation - umožní změnit umístění pole Podpis
approvalTagManipulation - umožní změnit umístění pole Schválení
attachmentTagManipulation - umožní změnit umístění pole Příloha
documentTagManipulation - umožní změnit umístění pole Osobní doklad
dateOfSignatureTagManipulation - zumožní měnit umístění pole Datum podpisu
radioButtonTagManipulation - umožní změnit umístění pole Přepínací pole
textTagManipulation - umožní změnit umístění pole Text
checkboxTagManipulation - umožní změnit umístění pole Zaškrtávací pole
envelopeSend - umožní odeslat obálku
documentReplace - umožní vyměnit dokument v kroku umisťování polí
documentRename - umožní změnit název dokumentu v kroku umisťování polí
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": "edit",
"allowedActions": ["signatureTagManipulation ", "envelopeSend ", "documentRename "],
"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ý krok editace / umístění polí 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": "sent"
}tyto stavy je možné zachytit pomocí
window.addEventListener(‘message’, () => { //* your code *// });Seznam Eventů v editační částí
sent
saved
discarded
logout
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í).