API novinky srpen

Vypnutí notifikací odesílateli obálky (API only)

Přes API je možné u obálek nastavit, že se nemají odesílateli posílat žádné notifikace (např. notifikace o dokončení podpisu, blížící se expiraci, chybě ověření atd.). Nastavuje se na úrovni obálky/šablony přes properties, parametr channelForSender=none. Ve výchozím nastavení notifikace chodí.

Vypnutí notifikací pro příjemce

Každý odesilatel dostává notifikace o změnách stavu obálek. Hromadní odesilatelé (uživatel API) je ale nepotřebují, jsou jen “technickým” odesilatelem. notifikace jim můžete vypnout pomocí. Podrobnější informace a nastavení v nápovědě.

Umístění formulářových polí na placeholder uprostřed slova

Pokud se umisťují formulářová pole obálky přes API pomocí placeholderů, jsou nyní vyhledávány výskyty tohoto placeholderu i uprostřed slov, nemusí tedy stát samostatně. Např. na placeholder=placeholder najde takto:

• textplaceholder

• teplaceholderxt

• placeholdertext

Placeholdery hledají všechny výskyty v dokumentech

Byl vytvořen nový endpoint pro hromadné vložení formulářových polí do obálky za pomoci placeholderu.

/api/envelopes/{envelope}/tags/by-placeholder

Tento endpoint funguje obdobně jako klasické vložení tagu s tím rozdílem, že není třeba určovat konkrétní dokument, prohledá totiž všechny dokumenty v obálce a na všechny výskyty placeholderu vloží požadované pole.

Webhooky

Možnost OAuth2 zabezpečení na webhook

U nastavení webhooku je nově možné zadat autorizační metodu OAuth 2.0. Během tvorba webhooku stačí zaškrtnou checkbox pro aktivaci a vyplnit požadovaná data pro autorizaci. Při posílání webhooku tak bude nutné, aby se prošlo takto nastaveným zabezpečním, v opačném případě webhook neprojde.

Upozornění na deaktivaci webhooku

Pokud uživatelům dlouhodobě neprochází zadané webhooky zasíláme nyní nejprve upozornění o možné deaktivaci tohoto webhooku s výzvou k opravě.

Pokud i následujících 7 dní po odeslání upozornění nebylo úspěšně doručeno více než 75% událostí webhooku, bude tento webhook automaticky deaktivován a uživateli odeslán email s informací o provedené deaktivaci.

Podmínky pro deaktivace webhooku:

• Za posledních 7 dní se nepodařilo doručit více než 75 % událostí.

• Datum vytvoření webhooku je starší než 7 dní

Nastavení platnosti embedovaného odkazu (API only)

Při získávání embedovaného odkazu pro podpis přes API je nově možné určit vlastní expiraci tohoto odkazu, parametrem expireAt s přesným datem a časem expirace. Maximální doba doba expirace je 365 dní a je omezeno časem expirace samotné obálky.

Definování failureURL (API)

Pro endpoint vygenerování embedded podpisové URL je nově možné zadat i atribut failureUrl, který udává na jakou URL bude klient vrácen v případě, že během podepisování nastane nějaká chyba (chyby ověření, uzamčená obálka, použití chybného certifikátu…). Nastane-li takováto chyba, bude zároveň do URL pro přesměrování přidán parametr s chybou tedy např. error=lockedError.

Filtrování obálek podle vlastníka

Výpis obálek lze filtrovat podle vlastníka obálky. Vlastníkem se rozumí uživatel Digisign, který je vyplněn v atributu Sender na obálce (přes API si mohou nastavit jakéhokoliv uživatele z organizace, přes selfcare se vždy převezme uživatel, který obálku založil, tedy shoduje se s createdBy). Pro úplnost: filtr Vytvořil je dle createdBy (uživatel který inicioval vytvoření obálky), filtr Odeslal dle sentBy (uživatel, který dal obálku odeslat).