Versions Compared

Old Version 2

changes.mady.by.user Zuzana Vankeova

Saved on

compared with

New Version 3

changes.mady.by.user Zuzana Vankeova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Propojení s iSmlouvou 

Výhodou propojení aplikací a služeb s iSmlovou je jeho jednoduchost, celý proces zahrnuje 3 kroky.

...

  • Ve vaší Aplikaci je/ se přidá informace o průběhu vytvoření a ověření dokumentů

...

Předání podkladů

Podporujeme dva způsoby předávání podkladů při integraci:

...

Více viz Jak se předávají podklady k podepisování?

Navrhovatel vs. smluvní strany

Při podepisování a tedy i předávání podkladů přes API je třeba odlišit:

  • Navrhovatel - Je tvůrce podepisovaného dokumentu a tedy musí mít účet v iSmlouvě. Může a nemusí být smluvní stranou, např. u realitních makléřů. Chodí mu zpět notifikace o tom, kdo dokument podepsal, odmítl podepsat apod. Může dokument zrušit. Nový dokument vidí v Odeslaných dokumentech.  Ve variantě integrace "Jediný servisní účet" je právě tento účet tvůrcem dokumentu, který ale nepodepisuje.

  • Smluvní strana - Může a nemusí mít účet v iSmlouvě. Dokument může podepsat a odmítnout. Pokud má účet v iSmlouvě, nový dokument vidí v Odeslaných dokumentech, pokud je zároveň navrhoatelem nebo v Přijatých dokumentech, pokud nikoliv.

Existence účtu na službě iSmlouva

Člověk podepisující resp. schvalující dokument může a nemusí  mít účet v iSmlouvě. Z hlediska volání API je to jedno, liší se ale chování služby, resp. její uživatelské rozhraní před zobrazením dokumentu k podpisu. Po kliknutí na notifikační SMS a e-mail, člověku, který: 

  • nemá účet v iSmlouvě - se ukáže rovnou dokument k podepsání, až po podpisu se mu nabídne, zda si chce zřídit účet v iSmlouvě,

  • již má účet v iSmlouvě - se ukáže přihlašovací obrazovka iSmlouvy a po přihlášení má přístup k dokumentu k podepsání.

Scénáře podepisování

Ač se to na první pohled nezdá, existuje více různých variant podepisování resp. schvalování dokumentu, které lze navíc kombinovat pro různé zúčastněné strany:

...

  • Na vědomí - Člověku se odesílá SMS a e-mail s odkazem na podepsaný dokument, resp. informace o jeho odmítnutí či expiraci, nijak se k dokumentu nevyjadřuje.

  • Podepisuje jen PINem - Člověku se odesílá notifikační SMS a e-mail, kromě schválení zadává PIN pro 2faktorovou funkcionalizaci. 

  • Podepisuje první / poslední / v pořadí - Aktuálně notifikační SMS a e-mail odejde vždy všem stranám najednou. Tím se API liší od uživatelského rozhraní, kdy v rámci přípravy nejprve podepisuje navrhovatel a pat teprve protistrany. Pořadí podepisování půjde nastavovat.

Předání výsledků

Zpětným voláním

Součástí předávání podkladů pro podpis jsou i tři URL adresy  tzv. “webhooků” pro každou hodnotu výsledku:

...

Více viz Jak získám výsledek předání podkladů pro podpis

Autentikace

Jediný servisní účet v iSmlouvě

...

Připravujeme i možnost osobních API klíčů či autentikaci přes Oauth2 apod.

Jak zajistit propojení

Integrace iSmlouvy na jiný systém může být zajištěna různými způsoby. Integraci může zajistit:

  • Tým iSmlouva s využitím integrační službywww.Integromat.com. Při malé náročnosti je v poplatku za využití integrace/API i zprovoznění integrace, při větší náročnosti je v poplatku časový a finanční odhad rozsahu prací.

  • Implementátor systému či integrací u daného uživatele přes integrační služby Integromat , MS Power Automate / Flow a podobně nebo přímým voláním API iSmlouvy.  Dostane k tomu od iSmlouvy všechny podklady (viz tyto stránky) a podporu.

  • Interní IT uživatel přes integrační služby Integromat , MS Power Automate / Flow a podobně  nebo přímým voláním API iSmlouvy.  Dostane k tomu od iSmlouvy všechny podklady (viz tyto stránky) a podporu.

Info

Stručný tahák - Co si ujasnit před integrací iSmlouvy s vaším systémem

  1. Odkud se vezmou kontaktní údaje na podepisující? - Jméno, Příjmení, email, telefon (ten není povinný, ale pak ho uživatel musí zadat sám, aby mu přišla SMS a on mohl být ověřen).

  2. Co se bude to posílat? - Hotový dokument PDF/DOCX/HTML/XSLX nebo jaký vzor a parametry pro něj.

  3. Jak se vyvolá akce podpisování? - Akce v menu na relevantním záznamu, nastavení nějakého custom pole na hodnotu "Odeslat k podpisu” apod.

  4. Kde uživateli ukážu výsledek podpisu? - Stav podepisování / výsledný dokument případně celou historii podepisování (viz kontrolní list)

  5. Jak se umístí podpisy? - Nejjednodušší je statické umístění na přesné souřadnice (nyní pro formuláře), umístění na konci dokumentu (lze doplnit brzy: iSmlouva vloží podpis, jméno, příjmení, místo , čas ), dynamické umístění podpisu (cílový stav, placeholdery pro podpisy v dokumentu, vyžaduje flexibilitu určení např. více smluvních stran, za každou stranu podepisuje více lidí).

  6. Jak se předávají výsledky zpět? - Preferovanou variantou je webhook volající aktivně integrovaný systému s výsledkem podepisování. Alternativně se lze z integrovaného systému periodicky ptát na výsledek podepisování.

  7. Jaká bude vazba mezi uživateli a pracovními prostory iSmlouvy? - Nejjednodušší scénář: Na iSmlouvě jen zavedený servisní účet pro celý integrovaný systém nebo jeho jednotlivé koncové firemní zákazníky. Ten se při volání API uvádí jako navrhovatel dokumentu, který pouze "schvaluje" (nic se nikde nezaškrtává). Pokud má podepisovat někdo z firmy, je pak uveden jako jedna z podepisujících stran, přijde mu email a SMS. Pro každého zákazníka je vytvořen na iSmlouvě pracovní prostor, kde jsou jeho dokumenty a který má svůj API klíč používaný pří vládání dokumentů do jeho prostoru přes API. Další scénáře jsou možné.

  8. Kdo bude platit? - Bud měsíční vyúčtování koncovému zákazníkovi zasílá provozovatel integrovaného systému a nakupuje kredity u iSmlouvy za velkoobchodní cenu, anebo koncový zákazník platí iSmlouvě a provozovatel integrovaného systému posílá měsíční fakturu na provizi. V oboru případech iSmlouva dodá počet kreditů po workspacech / zákaznících za měsíc.