...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Princip propojení se Signi
Výhodou propojení aplikací a služeb se Signi je jeho jednoduchost, celý proces zahrnuje 3 kroky.
...
Varianty použití Signi API
Předání podkladů
Podporujeme dva způsoby předávání podkladů při integraci:
...
Výchozí rozsah služeb Signi zahrnuje pouze předávání dokumentů. Použití vzorů je placené rozšíření.
Přístup ke stránkám pro podepsání
Jsou tří základní cesty :
Distanční podepsání - Podepisujícím po zavolání end pointu pro podpis dokumentu či vzoru Signi odesílá e-mailová notifikace s odkazem na stránky pro podepsání. Pokud je uvedeno tel. číslo, může odcházet i SMS notifikace. Je to obdoba standardního odeslání dokumentu k podpisu přes uživatelské rozhraní Signi.
Podpis v integrované aplikaci - End point pro podpis dokumentu vrací URL pro podpis jednotlivých podepisujících, viz Jak získám výsledek předání podkladů pro podpis, a integrovaná aplikace zobrazí odpovídající odkazy, rámce apod. pro podpis jednotlivých osob. Pozor, pokud je podepisujících více, musí mít všichni svůj prostor k podpisu. Je to obdoba podpisu na jednom zařízení přes uživatelské rozhraní Signi.
Signi jako fronta práce - Integrovaná apliakce zakládá do Signi dokumenty ve stavu rozpracováno a uživatelé “v poli” používají Signi jako svojí aplikaci s frontou své práce, odkud berou dokumenty a postupně je s pritistranami podepisují.
Více viz Jaké jsou způsoby podepsání z integrované aplikace?
Předává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:
podepsáno - signed,
odmítnuto - rejected,
neověřeno - expired
kdy jeden z nich se vyvolá v okamžiku, kdy daný stav nastane.
Průběžným ověřováním stavu
Někdy lze webhooky v integrovaném systému obtížně implementovat.
Místo toho je možné se dotazovat na aktuální stav dokumentu, a to periodicky, anebo např. při otevření detailu souvisejícího záznamu v integrovaném systému.
Toto se může hodit např. pro on-premise provozovaná řešení, která nejsou viditelná mimo firemní síť, tj. webhook nelze zrealizovat.
Více viz Jak získám výsledek předání podkladů pro podpis
Autentikace
Jediný servisní účet v Signi
...
Připravujeme i možnost osobních API klíčů či autentikaci přes Oauth2 apod.
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 Signi a právo přístupu do daného workspace / pracovního prostoru v Signi. 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 Protistrany - Může a nemusí mít účet v Signi. Dokument může podepsat a odmítnout. Pokud má účet v Signi, nový dokument vidí v Odeslaných dokumentech (pokud je zároveň navrhovatelem), nebo v Přijatých dokumentech (pokud není navrhovatelem).
Při integraci přes API je nejjednoudušší scénář Jediný servisní účet (viz výše). V tomto případě je automaticky navrhovatelem resp. autorem dokumentů vždy vlastník pracovního prostoru Signi, do kterého se posílá dokument k podpisu přes API. Ten na dokumentu nikde nefiguruje, ani ho nepodepisuje, ani ho neschvaluje. Podepisující či schvalovatelé, ať z firmy navrhovatele či mimo ni jsou smluvními stranami.
Existence účtu na službě Signi
Člověk podepisující, resp. schvalující dokument může a nemusí mít účet v Signi. Z hlediska volání API je to jedno, liší se pouze chování služby, resp. její uživatelské rozhraní před zobrazením dokumentu k podpisu.
Mohou tedy nastat 2 situace:
uživatel nemá účet v Signi - po kliknutí na link v notifikační SMS / e-mailu se mu ukáže rovnou dokument k podepsání; až po podpisu se mu nabídne, zda si chce zřídit účet v Signi,
uživatel již má účet v Signi - po kliknutí na link v notifikační SMS / e-mailu se mu ukáže přihlašovací obrazovka Signi 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:
...
Podepisuje - má podpis na dokumentu - s tím, že rypů podpisů je více
Schvaluje - jen potvrdí souhlas s dokumentem, podpis není vidět
...
Podepisují nejdříve navrhovatelé a pak protistrany
Záleží na pořadí podepisujících
Přístup ke stránkám pro podepsání
Jsou dvě základní cesty :
Distanční podepsání - Podepisujícím po zavolání end pointu pro podpis dokumentu či vzoru Signi odesílá e-mailová notifikace s odkazem na stránky pro podepsání. Pokud je uvedeno tel. číslo, může odcházet i SMS notifikace. Je to obdoba standardního odeslání dokumentu k podpisu přes uživatelské rozhraní Signi.
Podpis na jednom zařízení - End point pro podpis dokumentu vrací URL pro podpis jednotlivých podepisujících, viz Jak získám výsledek předání podkladů pro podpis, a integrovaná aplikace zobrazí odpovídající odkazy, rámce apod. pro podpis jednotlivých osob. Pozor, pokud je podepisujících více, musí mít všichni svůj prostor k podpisu. Je to obdoba podpisu na jednom zařízení přes uživatelské rozhraní Signi.
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:
podepsáno - signed,
odmítnuto - rejected,
neověřeno - expired
kdy jeden z nich se vyvolá v okamžiku, kdy daný stav nastane.
Průběžným ověřováním stavu
Někdy lze webhooky v integrovaném systému obtížně implementovat.
Místo toho je možné se dotazovat na aktuální stav dokumentu, a to periodicky, anebo např. při otevření detailu souvisejícího záznamu v integrovaném systému.
Toto se může hodit např. pro on-premise provozovaná řešení, která nejsou viditelná mimo firemní síť, tj. webhook nelze zrealizovat.
...
Jak zajistit propojení
Integrace Signi na jiný systém může být zajištěna různými způsoby. Integraci může zajistit:
...