SignNow EU (Preview)
SignNow umožňuje zabezpečené, vyhovující a auditované pracovní postupy eSignature pro firmy, právní, personální, zdravotnické a finanční týmy. Odesílání a sledování žádostí o podpis v pořadí na základě role, předem vyplněných polí dokumentu a správa skupin dokumentů pomocí konektoru SignNow.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Centrum nápovědy |
| URL | https://support.signnow.com/ |
| integrations@pdffiller.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | DaDaDocs |
| Internetová stránka | https://signnow.com |
| Zásady ochrany osobních údajů | https://www.signnow.com/privacy_policy |
| Kategorie | Produktivita; Personální |
SignNow EU Connector
SignNow umožňuje zabezpečené, vyhovující a auditované pracovní postupy eSignature pro firmy, právní, personální, zdravotnické a finanční týmy. Odesílání a sledování žádostí o podpis v pořadí na základě role, předem vyplněných polí dokumentu a správa skupin dokumentů pomocí konektoru SignNow.
Pre-requisites
Abyste mohli pokračovat, budete potřebovat účet EU SignNow (zvolte na přihlašovací obrazovce SERVER EU) a předplatné rozhraní SignNow API.
Nasazení ukázky
Nejprve aktualizujte hodnotu clientId v apiProperties.json vlastními.
Spusťte následující příkazy a postupujte podle pokynů:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
Podporované akce a triggery
Další podrobnosti najdete v dokumentaci .
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Nahradit příjemce ve skupině dokumentů pozvat |
Tato akce nahradí příjemce pozvánky ve skupině dokumentů jejím ID pozvánky. Pro každý dokument můžete také nastavit vypršení platnosti pozvánky, připomenutí, znovu přiřadit oprávnění a možnosti odmítnutí. |
| Nahrazení příjemců v pozvánce na dokument |
Tato akce nahrazuje příjemce v pozvánce dokumentu na základě jejich rolí. Umožňuje také aktualizovat nastavení pozvání, jako je typ ověřování, dny vypršení platnosti a další pokročilé parametry pro každou roli. |
| Nahrát dokument |
Nahrání dokumentu do SignNow |
| Odstranit dokument |
Odstranění dokumentu z SignNow |
| Odstranit vloženou pozvánku dokumentu |
Tato akce odstraní vloženou pozvánku k dokumentu. |
| Odstranit vloženou pozvánku skupiny dokumentů |
Tato akce odstraní vloženou pozvánku pro konkrétní skupinu dokumentů. |
| Pozvat k podepsání dokumentu |
Tato akce vytvoří a odešle pozvánku na pole pro podepsání dokumentu. |
| Pozvat k podepsání skupiny dokumentů |
Tato akce vytvoří pozvánku k podepsání skupiny dokumentů. Můžete nakonfigurovat vícekrokový pracovní postup, ve kterém různí příjemci fungují ve skupině dokumentů v různých fázích. |
| Předvyplnění hodnot inteligentních polí skupiny dokumentů |
Automatické naplnění inteligentních polí v dokumentech konkrétními hodnotami |
| Předvyplnění hodnot inteligentního pole |
Předvyplnění hodnot inteligentního pole pro zadaný dokument |
| Předvyplnění hodnot polí dokumentu (Preview) |
Automatické naplnění vyplnitelných polí v dokumentu konkrétními hodnotami |
| Předvyplnění hodnot polí dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte hodnoty polí dokumentu předběžného vyplňování .
|
| Předvyplnění hodnot polí skupiny dokumentů |
Automatické naplnění vyplnitelných polí v dokumentech konkrétními hodnotami |
| Stáhnout dokument |
Stažení dokumentu z SignNow |
| Vygenerovat vložený odkaz na pozvánku ve skupině dokumentů |
Tato akce vygeneruje odkaz na vloženou pozvánku skupiny dokumentů. |
| Vygenerovat vložený odkaz pozvat na dokument |
Tato akce vygeneruje odkaz na vloženou pozvánku dokumentu. |
| Vytvoření dokumentu ze šablony |
Vygenerování dokumentu z vybrané šablony |
| Vytvoření skupiny dokumentů z více souborů |
Vytvoření skupiny dokumentů nahráním více souborů jako řetězců s kódováním Base64 |
| Vytvoření skupiny dokumentů ze šablony skupiny |
Vytvoření skupiny dokumentů z vybrané šablony skupiny |
| Vytvoření vložené pozvánky skupiny dokumentů |
Tato akce vytvoří vloženou pozvánku k podepisování pro skupinu dokumentů. Po vytvoření pozvánky vygenerujte vložený podpisový odkaz. |
| Vytvořit podpisový odkaz |
Vygenerujte odkaz na dokument a sdílejte ho, aby byl dokument podepsaný. |
| Vytvořit vloženou pozvánku k dokumentu |
Tato akce vytvoří vloženou pozvánku k podepisování dokumentu. Po vytvoření pozvánky vygenerujte vložený podpisový odkaz. |
| Vytvořit vložený odkaz pro odesílání dokumentů |
Tato akce vygeneruje vložený odesílající odkaz pro konkrétní dokument, který umožňuje uživatelům třetích stran připravit a odeslat dokument k podpisu. |
| Vytvořit vložený odkaz pro odesílání skupiny dokumentů |
Tato akce vygeneruje vložený odesílající odkaz pro konkrétní skupinu dokumentů, což umožňuje uživatelům třetích stran připravit a odeslat skupinu dokumentů k podpisu. |
| Zastaralé – pozvání k podepsání |
Akce je zastaralá. Pozvání ostatních k vyplnění a podepsání dokumentu |
| Zastaralé – Pozvání k podepsání skupiny dokumentů |
Akce je zastaralá. Pozvání ostatních k vyplnění a podepsání skupiny dokumentů |
| Zastaralé – Rozšířená pozvánka na dokument |
Akce je zastaralá. Žádost o pozvání s ručně definovaným schématem Umožňuje nastavit pozvání pro dokument, který se v budoucnu vygeneruje. |
| Zrušit pozvání |
Zrušení pozvánky podpisu |
| Získání informací o dokumentu |
Získejte vlastnosti dokumentu, jako je název, ID, data vytvoření nebo aktualizace atd. |
| Získání polí dokumentu (Preview) |
Načtení hodnot z vyplnitelných polí v dokumentu |
| Získání polí dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte možnost Získat pole dokumentu .
|
| Získání schématu dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Získat schéma dokumentu .
|
| Získání seznamu dokumentů |
Načtení seznamu dokumentů uživatele |
| Získání skupin dokumentů |
Načtení seznamu skupin dokumentů uživatele |
| Získání skupiny dokumentů |
Načtení seznamu skupin dokumentů uživatele |
| Získání stavu pozvání dokumentu |
Tato akce načte informace o pozvánce na dokument, včetně stavu každého kroku a akce. |
| Získání stavu pozvání skupiny dokumentů |
Tato akce načte informace o pozvánce skupiny dokumentů, včetně stavu každého kroku a akce. |
Nahradit příjemce ve skupině dokumentů pozvat
Tato akce nahradí příjemce pozvánky ve skupině dokumentů jejím ID pozvánky. Pro každý dokument můžete také nastavit vypršení platnosti pozvánky, připomenutí, znovu přiřadit oprávnění a možnosti odmítnutí.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
|
ID pozvánky
|
invite_id | True | string |
ID pozvánky skupiny dokumentů |
|
ID kroku
|
step_id | string |
ID kroku pozvánky z pozvánky skupiny dokumentů |
|
|
Příjemce, který se má nahradit
|
recipient_to_update | string |
E-mail příjemce, který se má nahradit |
|
|
Nový příjemce
|
new_recipient | string |
E-mail nového příjemce |
|
|
Dny vypršení platnosti
|
expiration_days | integer |
V kolika dnech vyprší platnost pozvánky; Max. 30 dní |
|
|
Upomínka
|
reminder | integer |
V kolika dnech se má podepisující posílat připomenutí; Max. 30 dní |
|
|
ID dokumentu
|
document_id | True | string |
ID dokumentu ze skupiny dokumentů |
|
Povolit přeposílání
|
allow_forwarding | boolean |
Jestli chcete příjemcům povolit opětovné přiřazení této pozvánky na jinou e-mailovou adresu, nebo ne. Možné hodnoty: False – není povoleno. Pravda - povoleno. |
|
|
Povolit odmítnutí podpisem
|
decline_by_signature | boolean |
Definuje, zda se má u polí podpisu zobrazit možnost Odmítnout podepsat. True: zobrazit možnost odmítnutí; False: skrytí možnosti odmítnutí |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
status | string |
Stav nahrazení příjemců |
Nahrazení příjemců v pozvánce na dokument
Tato akce nahrazuje příjemce v pozvánce dokumentu na základě jejich rolí. Umožňuje také aktualizovat nastavení pozvání, jako je typ ověřování, dny vypršení platnosti a další pokročilé parametry pro každou roli.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
Role
|
role | True | string |
Jméno role příjemce, který se má nahradit |
|
Nový e-mail
|
True | string |
Nový e-mail příjemce |
|
|
Role
|
role | True | string |
Název role, který vyžaduje další parametry pozvání |
|
Dny vypršení platnosti
|
expiration_days | integer |
V kolika dnech vyprší platnost pozvánky. Max. 30 dní |
|
|
Povolit odmítnutí podpisem
|
decline_by_signature | boolean |
Definuje, zda se má u polí podpisu zobrazit možnost Odmítnout podepsat. True: zobrazit možnost odmítnutí; False: skrytí možnosti odmítnutí |
|
|
Upomínka
|
reminder | integer |
Kolik dní chcete příjemci poslat připomenutí. Max. 30 dní |
|
|
Typ ověřování
|
authentication_type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Ověřovací heslo
|
authentication_password | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
Telefon pro ověřování
|
authentication_phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Zpráva SMS pro ověření
|
authentication_sms_message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru podepisující obdrží výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite unlock code: 123456". Příklad: Zadejte heslo {password} pro odemknutí dokumentu. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
náhrady
|
replacements | array of object |
Podrobnosti o nových příjemcích |
|
Nové ID pozvánky
|
replacements.new_invite_id | string |
ID pozvánky nového pole |
|
Role
|
replacements.role | string |
Jméno role příjemce, který byl nahrazen |
|
Nový e-mail
|
replacements.new_email | string |
Nový e-mail příjemce |
Nahrát dokument
Nahrání dokumentu do SignNow
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
File
|
file | True | file |
Soubor k nahrání |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
Odstranit dokument
Odstranění dokumentu z SignNow
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
status | string |
Stav odebrání dokumentu |
Odstranit vloženou pozvánku dokumentu
Tato akce odstraní vloženou pozvánku k dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
Odstranit vloženou pozvánku skupiny dokumentů
Tato akce odstraní vloženou pozvánku pro konkrétní skupinu dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
Pozvat k podepsání dokumentu
Tato akce vytvoří a odešle pozvánku na pole pro podepsání dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
Email
|
string |
E-mailová adresa příjemce |
||
|
E-mailová skupina
|
email_group | string |
Skupina uživatelů, kteří by měli pozvánku přijmout. Když některý z uživatelů dokument podepíše, považuje se za dokončený. Musí se použít s pokročilým parametrem "e-mailové skupiny". Vyžaduje se, pokud není přidán e-mail nebo pozvánka na telefon, ale nelze ho použít současně s některým z těchto parametrů. |
|
|
Pozvat na telefon
|
phone_invite | string |
Telefonní číslo příjemce. Požadováno pro pozvání prostřednictvím SMS |
|
|
Role
|
role | True | string |
Název role příjemce. např. Podepisující 1, Podepisující 2 |
|
Objednávka
|
order | True | integer |
Pořadí podepisování. Podpisové pořadí definuje posloupnost, ve které musí příjemci podepsat nebo vyplnit dokument. Jakmile všichni příjemci v kroku objednávky dokončí podepisování, dokument pokračuje k dalšímu kroku objednávky (např. 2, 3). Stejnou podepisující objednávku může sdílet více příjemců. |
|
Role
|
role | True | string |
Název role příjemce, který se používá pro mapování pokročilých parametrů |
|
Předvyplnění názvu podpisu
|
prefill_signature_name | string |
Předem vyplněný text v poli podpisu, který je k dispozici pro úpravy podepisující osoby |
|
|
Požadovaný název přednastavení podpisu
|
required_preset_signature_name | string |
Předem vyplněný text pole podpisu, uzamčený pro úpravy příjemcem. Nelze použít s předvyplněním názvu podpisu nebo vyžadovat nový podpis. |
|
|
Vyžadovat nový podpis
|
force_new_signature | boolean |
Definuje, jestli podepisující člověk může použít uložený podpis. False – podepisující může použít uložený podpis; True – podepisující uživatel musí vytvořit nový podpis. |
|
|
Povolit přeposílání
|
reassign | boolean |
Definuje, jestli příjemce může přeposlat pozvánku na jinou e-mailovou adresu. "true": příjemce může pozvánku přeposlat; "false": Příjemce nemůže přeposlat pozvánku. |
|
|
Povolit odmítnutí podpisem
|
decline_by_signature | boolean |
Definuje, zda se má u polí podpisu zobrazit možnost Odmítnout podepsat. True – zobrazit možnost odmítnutí; false – skrytí možnosti odmítnutí |
|
|
Odeslat připomenutí ve dnech X
|
remind_after | integer |
X dní po pozvánce dostane e-mail s připomenutím (od 1 do 179 dnů). Musí být kratší než počet dnů do vypršení platnosti. |
|
|
Připomenutí v X dnech před vypršením platnosti
|
remind_before | integer |
X dní před vypršením platnosti obdrží e-mail s připomenutím (od 1 do 179 dnů). Musí být kratší než počet dnů do vypršení platnosti. |
|
|
Odeslat připomenutí každých X dnů
|
remind_repeat | integer |
Recepient obdrží e-mail s připomenutím každé x dny po odeslání pozvánky (od 1 do 7 dnů). |
|
|
Dny do vypršení platnosti
|
expiration_days | integer |
V X dnech vyprší platnost pozvánky (od 3 do 180 dnů) |
|
|
Typ ověřování
|
authentication_type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Ověřovací heslo
|
password | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
Telefon pro ověřování
|
phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Zpráva SMS pro ověření
|
authentication_sms_message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru podepisující obdrží výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite unlock code: 123456". Příklad: Zadejte heslo {password} pro odemknutí dokumentu. |
|
|
Předmět
|
subject | string |
Vlastní předmět e-mailu pro příjemce |
|
|
Message
|
message | string |
Vlastní e-mailová zpráva příjemce |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Po dokončení a podepsání všech požadovaných polí se podepisující uživatel přesměruje na tento identifikátor URI. |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
|
|
Identifikátor URI pro odmítnutí přesměrování
|
decline_redirect_uri | string |
Odkaz, který se otevře po odmítnutí dokumentu příjemcem |
|
|
Zavřít identifikátor URI přesměrování
|
close_redirect_uri | string |
Odkaz, který se otevře, když příjemce klikne na Uložit průběh a dokončí později během podpisové relace nebo zavření v režimu zobrazení |
|
|
Is Finish Redirect Canceled
|
is_finish_redirect_canceled | boolean |
Určuje, jestli je nastavení přesměrování dokončení pro organizaci zrušeno. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Zrušit přesměrování zavření
|
is_close_redirect_canceled | boolean |
Určuje, jestli je pro organizaci zrušeno nastavení přesměrování průběhu ukládání. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Zrušit přesměrování odmítnutí
|
is_decline_redirect_canceled | boolean |
Určuje, jestli je nastavení přesměrování odmítnutí zrušeno pro organizaci. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Jazyk
|
language | string |
Určuje jazyk podpisové relace a e-maily s oznámením pro podepisující osoby. Možné hodnoty: En pro angličtinu, Es pro španělštinu a Fr pro francouzštinu. Pokud není nastavený, jazyk je určen jazykem vašeho účtu SignNow. |
|
|
Email
|
True | string |
E-mailová adresa prohlížeče |
|
|
Role
|
role | True | string |
Název role čtenáře |
|
Objednávka
|
order | True | integer |
Celé číslo: pořadí odesílání počínaje číslem 1 |
|
Role
|
role | True | string |
Název role čtenáře. Používá se k mapování rozšířených parametrů. |
|
Předmět
|
subject | string |
Vlastní předmět e-mailu pro diváka |
|
|
Message
|
message | string |
Vlastní e-mailová zpráva pro prohlížeč |
|
|
Email
|
True | string |
E-mailová adresa schvalovatele |
|
|
Role
|
role | True | string |
Název role schvalovatele |
|
Objednávka
|
order | True | integer |
Pořadí přijetí žádosti o schválení |
|
Role
|
role | True | string |
Název role schvalovatele Používá se k mapování rozšířených parametrů. |
|
Dny vypršení platnosti
|
expiration_days | integer |
Počet dní před vypršením platnosti pozvánky |
|
|
Message
|
message | string |
Vlastní e-mailová zpráva pro schvalovatele |
|
|
Předmět
|
subject | string |
Vlastní předmět e-mailu pro schvalovatele |
|
|
Typ ověřování
|
authentication_type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Heslo
|
password | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
telefon
|
phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Zpráva SMS pro ověření
|
authentication_sms_message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru podepisující obdrží výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite unlock code: 123456". Příklad: Zadejte heslo {password} pro odemknutí dokumentu. |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Adresa URL, která se otevře po schválení dokumentu schvalovatelem |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
|
|
Od
|
from | string |
E-mailová adresa odesílatele Můžete použít jenom e-mail přidružený k vašemu účtu SignNow (přihlašovací e-mail). Pokud necháte prázdné, nastaví se automaticky. |
|
|
ID
|
id | string |
ID e-mailové skupiny Jedinečný identifikátor 40 znaků, který se musí vytvořit předem |
|
|
Název
|
name | string |
Název skupiny. Použijte ho v poli E-mailová skupina podepisující osoby > . |
|
|
Email
|
string |
E-mailová adresa, která by měla dostat pozvánku |
||
|
Email
|
string |
E-mailová adresa, která by měla dostat pozvánku |
||
|
Název
|
name | string |
Název kroku |
|
|
Email
|
string |
E-mailová adresa příjemce kopie |
||
|
Step
|
step | integer |
Pořadí odeslání od 1 |
|
|
Předmět
|
subject | string |
Předmět e-mailu pro všechny příjemce |
|
|
Message
|
message | string |
E-mailová zpráva pro všechny příjemce |
|
|
Předmět CC
|
cc_subject | string |
Předmět e-mailu CC pro všechny příjemce kopie |
|
|
Kopie zprávy
|
cc_message | string |
E-mailová zpráva CC pro všechny příjemce kopie |
|
|
Podpis QES
|
signature | string |
Typ QES. Možné hodnoty: 'Eideasy', 'Nom151'. Používá se k vyžádání podpisů QES od podepisujících. Všichni podepisující osoby v pozvánce musí používat stejný typ podpisu. Pokud chcete vytvořit pozvánku pomocí QES, musí uživatel patřit do organizace s povoleným QES. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
status | string |
Stav |
Pozvat k podepsání skupiny dokumentů
Tato akce vytvoří pozvánku k podepsání skupiny dokumentů. Můžete nakonfigurovat vícekrokový pracovní postup, ve kterém různí příjemci fungují ve skupině dokumentů v různých fázích.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
|
Objednávka
|
order | True | integer |
Pořadí podepsání kroku: 1 – příjemci nejprve podepisují skupinu dokumentů, skupina dokumentů se odešle na 2,3 atd. Několik příjemců může mít stejné pořadí podepisování. |
|
Email
|
string |
E-mailová adresa příjemce |
||
|
E-mailová skupina
|
email_group | string |
Skupina kontaktů příjemců |
|
|
Název role
|
role_name | True | string |
Jméno role příjemce v dokumentu (lze použít k identifikaci polí v dokumentu přiřazeného tomuto konkrétnímu příjemci). |
|
Činnost
|
action | True | string |
Povolená akce s dokumentem Možné hodnoty: Zobrazit, Podepsat, Schválit |
|
ID dokumentu
|
document_id | True | string |
ID dokumentu, u kterého se vyžadují akce od tohoto příjemce |
|
Požadovaný název přednastavení podpisu
|
required_preset_signature_name | string |
Předem vyplněný text pole podpisu, uzamčený pro úpravy příjemcem |
|
|
Povolit přeposílání
|
allow_reassign | boolean |
Definuje, jestli příjemce může přeposlat pozvánku na jinou e-mailovou adresu. "true": příjemce může pozvánku přeposlat; "false": Příjemce nemůže přeposlat pozvánku. |
|
|
Povolit odmítnutí podpisem
|
decline_by_signature | boolean |
Definuje, zda se má u polí podpisu zobrazit možnost Odmítnout podepsat. True: zobrazit možnost odmítnutí; False: skrytí možnosti odmítnutí |
|
|
Typ ověřování
|
type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Heslo
|
value | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
telefon
|
phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Message
|
message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru podepisující obdrží výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite unlock code: 123456" |
|
|
MerchantId
|
merchant_id | string |
ID obchodního účtu přidaného do vaší organizace |
|
|
Měna
|
currency | string |
Požadovaná měna platby |
|
|
Množství
|
amount | string |
Požadovaná částka platby |
|
|
URI
|
redirect_uri | string |
Po dokončení a podepsání všech požadovaných polí se podepisující uživatel přesměruje na tento identifikátor URI. |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
|
|
Identifikátor URI pro odmítnutí přesměrování
|
decline_redirect_uri | string |
Odkaz, který se otevře po odmítnutí dokumentu příjemcem |
|
|
Zavřít identifikátor URI přesměrování
|
close_redirect_uri | string |
Odkaz, který se otevře, když podepisující správce klikne na Uložit průběh a dokončí později během podpisové relace nebo zavření v režimu zobrazení. |
|
|
Is Finish Redirect Canceled
|
is_finish_redirect_canceled | boolean |
Určuje, jestli je nastavení přesměrování dokončení pro organizaci zrušeno. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Zrušit přesměrování zavření
|
is_close_redirect_canceled | boolean |
Určuje, jestli je pro organizaci zrušeno nastavení přesměrování průběhu ukládání. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Zrušit přesměrování odmítnutí
|
is_decline_redirect_canceled | boolean |
Určuje, jestli je nastavení přesměrování odmítnutí zrušeno pro organizaci. True – přesměrování je zrušeno; False – přesměrování zůstane aktivní. |
|
|
Jazyk
|
language | string |
Určuje jazyk podpisové relace a e-maily s oznámením pro podepisující osoby. Možné hodnoty: En pro angličtinu, Es pro španělštinu a Fr pro francouzštinu. Pokud není nastavený, jazyk je určen jazykem vašeho účtu SignNow. |
|
|
Objednávka
|
order | True | integer |
Pořadí podepsání kroku: 1 – příjemci nejprve podepisují skupinu dokumentů, skupina dokumentů se odešle na 2,3 atd. Několik příjemců může mít stejné pořadí podepisování. |
|
Email
|
True | string |
E-mailová adresa příjemce |
|
|
E-mailová skupina
|
email_group | string |
Skupina kontaktů příjemců |
|
|
Předmět
|
subject | string |
Vlastní předmět e-mailu pro příjemce |
|
|
Message
|
message | string |
Vlastní e-mailová zpráva příjemce |
|
|
Dny do vypršení platnosti
|
expiration_days | integer |
V x dnech vyprší platnost pozvánky (od 3 do 180 dnů) |
|
|
Odeslat připomenutí ve dnech X
|
remind_after | integer |
X dní po pozvánce dostane e-mail s připomenutím (od 1 do 179 dnů). Musí být kratší než dny vypršení platnosti. |
|
|
Připomenutí v X dnech před vypršením platnosti
|
remind_before | integer |
X dní před vypršením platnosti obdrží e-mail s připomenutím (od 1 do 179 dnů). Musí být kratší než dny vypršení platnosti. |
|
|
Odeslat připomenutí každých X dnů
|
remind_repeat | integer |
Recepient obdrží e-mail s připomenutím každé x dny po odeslání pozvánky (od 1 do 7 dnů). |
|
|
identifikační číslo
|
id | string |
ID e-mailové skupiny Jedinečný identifikátor 40 znaků, který se musí vytvořit předem |
|
|
Název
|
name | string |
Název skupiny. Použijte ji v e-mailové skupině Pozvat kroky > . |
|
|
Email
|
string |
E-mailová adresa, která by měla dostat pozvánku |
||
|
Email
|
string |
E-mailová adresa příjemce, který obdrží e-mail o dokončení |
||
|
Zakázat přílohu dokumentu
|
disable_document_attachment | boolean |
Zda zakázat odesílání příloh dokumentu s e-mailem pro dokončení. Možné hodnoty: False – povolení přílohy dokumentu, True – zakázání přílohy dokumentu |
|
|
Předmět
|
subject | string |
Vlastní předmět e-mailu pro dokončení |
|
|
Message
|
message | string |
Vlastní zpráva pro e-mail o dokončení |
|
|
Podepsat jako sloučené
|
sign_as_merged | boolean |
Pokud je pravda, umožňuje uživateli rozhraní API odeslat pozvánku, která se otevře jako sloučená skupina dokumentů v jednom dokumentu. |
|
|
Časové razítko klienta
|
client_timestamp | integer |
Časové razítko pozvánky skupiny dokumentů |
|
|
Email
|
string |
E-mailová adresa, která by měla dostat pozvánku |
||
|
Podpis QES
|
signature | string |
Typ QES. Možné hodnoty: 'Eideasy', 'Nom151'. Používá se k vyžádání podpisů QES od podepisujících. Všichni podepisující osoby v pozvánce musí používat stejný typ podpisu. Pokud chcete vytvořit pozvánku pomocí QES, musí uživatel patřit do organizace s povoleným QES. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | string |
ID pozvánky skupiny dokumentů |
|
Odkaz Čekající na pozvání
|
pending_invite_link | string |
Odkaz čekající na pozvání |
Předvyplnění hodnot inteligentních polí skupiny dokumentů
Automatické naplnění inteligentních polí v dokumentech konkrétními hodnotami
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_group_id | True | string |
Zadání šablony skupiny dokumentů pro získání polí z |
|
ID skupiny dokumentů
|
doc_group_id | True | string |
Zadání jedinečného ID skupiny dokumentů |
|
pole
|
fields | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID skupiny dokumentů
|
id | DocumentGroupId |
Jedinečné ID skupiny dokumentů |
Předvyplnění hodnot inteligentního pole
Předvyplnění hodnot inteligentního pole pro zadaný dokument
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Zadání šablony dokumentu pro získání polí z |
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
|
pole
|
fields | dynamic |
Předvyplnění hodnot polí dokumentu (Preview)
Automatické naplnění vyplnitelných polí v dokumentu konkrétními hodnotami
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Zadání šablony dokumentu pro získání polí z |
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
|
pole
|
fields | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
Předvyplnění hodnot polí dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte hodnoty polí dokumentu předběžného vyplňování .
Předvyplnění hodnot a vlastností polí
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Zadání šablony dokumentu pro získání polí z |
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
|
pole
|
fields | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
Předvyplnění hodnot polí skupiny dokumentů
Automatické naplnění vyplnitelných polí v dokumentech konkrétními hodnotami
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_group_id | True | string |
Zadání šablony skupiny dokumentů pro získání polí z |
|
ID skupiny dokumentů
|
doc_group_id | True | string |
Zadání jedinečného ID skupiny dokumentů |
|
pole
|
fields | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID skupiny dokumentů
|
id | DocumentGroupId |
Jedinečné ID skupiny dokumentů |
Stáhnout dokument
Stažení dokumentu z SignNow
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | True | string |
Zadejte jedinečné ID dokumentu nebo vyberte dokument ze seznamu. |
|
Formát
|
mode | string |
Výběr formátu dokumentu ke stažení |
Návraty
- response
- binary
Vygenerovat vložený odkaz na pozvánku ve skupině dokumentů
Tato akce vygeneruje odkaz na vloženou pozvánku skupiny dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
|
ID vložené pozvánky skupiny dokumentů
|
invite_id | True | string |
ID vložené pozvánky skupiny dokumentů z akce Vytvořit vloženou pozvánku skupiny dokumentů |
|
Email
|
True |
E-mailová adresa příjemce |
||
|
Vypršení platnosti propojení
|
link_expiration | integer |
Určuje, kolik minut bude odkaz aktivní. Platný rozsah:15–45 minut |
|
|
Vypršení platnosti relace
|
session_expiration | integer |
Určuje, kolik minut bude podpisová relace aktivní. Platný rozsah:15–1440 minut |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vložený odkaz pozvat
|
link | string |
Odkaz na vloženou pozvánku skupiny dokumentů |
Vygenerovat vložený odkaz pozvat na dokument
Tato akce vygeneruje odkaz na vloženou pozvánku dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
ID pozvánky pole
|
field_invite_id | True | string |
Vložené ID pozvánky z akce Vytvořit vloženou pozvánku dokumentu |
|
Vypršení platnosti propojení
|
link_expiration | integer |
Určuje, kolik minut bude odkaz aktivní. Platný rozsah:15–45 minut |
|
|
Vypršení platnosti relace
|
session_expiration | integer |
Určuje, kolik minut bude podpisová relace aktivní. Platný rozsah:15–1440 minut |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Link
|
data.link | string |
Vygenerovaný vložený odkaz na pozvánku pro dokument |
Vytvoření dokumentu ze šablony
Vygenerování dokumentu z vybrané šablony
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Šablona dokumentu
|
doc_id | True | string |
Výběr šablony ze seznamu |
|
Název dokumentu
|
document_name | string |
Zadejte nový název souboru dokumentu. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
Vytvoření skupiny dokumentů z více souborů
Vytvoření skupiny dokumentů nahráním více souborů jako řetězců s kódováním Base64
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název skupiny dokumentů
|
group_name | True | string |
Zadejte název skupiny dokumentů. |
|
Název dokumentu
|
name | True | string |
Název dokumentu s příponou: Report.pdf, Letter.docx atd. |
|
Obsah souboru
|
content | True | string |
Řetězec s kódováním Base64 představující obsah dokumentu |
Návraty
Vytvoření skupiny dokumentů ze šablony skupiny
Vytvoření skupiny dokumentů z vybrané šablony skupiny
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Šablona skupiny
|
doc_group_id | True | string |
Ze seznamu vyberte šablonu skupiny. |
|
Název skupiny dokumentů
|
group_name | string |
Zadejte nový název skupiny dokumentů. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID skupiny dokumentů
|
id | DocumentGroupId |
Jedinečné ID skupiny dokumentů |
Vytvoření vložené pozvánky skupiny dokumentů
Tato akce vytvoří vloženou pozvánku k podepisování pro skupinu dokumentů. Po vytvoření pozvánky vygenerujte vložený podpisový odkaz.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
|
Objednávka
|
order | True | integer |
Krok pořadí podepisování. Všichni podepisující osoby přiřazené ke konkrétnímu |
|
Email
|
True | string |
E-mailová adresa příjemce |
|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
Role
|
role | string |
Role příjemce v dokumentu Role by neměly být zadány pro akci zobrazení. |
|
|
Činnost
|
action | True | string |
Akce vyžadovaná příjemcem v dokumentu Povolené hodnoty: 'sign', 'view' |
|
Objednávka
|
order | True | string |
Krok podepsání objednávky |
|
Email
|
True | string |
E-mailová adresa příjemce |
|
|
Jazyk
|
language | string |
Určuje jazyk podpisové relace a e-maily s oznámením pro podepisující osoby. Možné hodnoty: En pro angličtinu, Es pro španělštinu a Fr pro francouzštinu. Pokud není nastavený, jazyk je určen jazykem vašeho účtu SignNow. |
|
|
Křestní jméno
|
first_name | string |
Jméno příjemce |
|
|
Příjmení
|
last_name | string |
Příjmení příjemce |
|
|
Požadovaný název přednastavení podpisu
|
required_preset_signature_name | string |
Předem vyplněný text pole podpisu, uzamčený pro úpravy příjemcem |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Odkaz, který se otevře po dokončení podpisové relace |
|
|
Identifikátor URI pro odmítnutí přesměrování
|
decline_redirect_uri | string |
Odkaz, který se otevře, když příjemce odmítne podepsat dokument |
|
|
Zavřít identifikátor URI přesměrování
|
close_redirect_uri | string |
Odkaz, který se otevře, když příjemce klikne na Uložit průběh a dokončí později během podpisové relace nebo zavření v režimu zobrazení |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
|
|
Typ doručení
|
delivery_type | string |
Definuje způsob odeslání pozvánky. |
|
|
Vypršení platnosti propojení
|
link_expiration | integer |
Kolik minut vyprší platnost pozvánky e-mailu. Dá se použít jenom v případě, že delivery type=email. Platný rozsah: 15–43200 minut |
|
|
Vypršení platnosti relace
|
session_expiration | integer |
Kolik minut vyprší platnost podpisové relace. Pokud se pro tuto pozvánku vygeneruje odkaz, resetuje se vypršení platnosti relace. Platí pouze v případě, že akce Delivery type=email a 'sign' (Podepsat) Platný rozsah: 15–1440 minut |
|
|
Typ ověřování
|
authentication_type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Ověřovací heslo
|
authentication_password | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
Telefon pro ověřování
|
authentication_phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Zpráva SMS pro ověření
|
authentication_sms_message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru podepisující obdrží výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite unlock code: 123456". Příklad: Zadejte heslo {password} pro odemknutí dokumentu. |
|
|
Podpis QES
|
signature | string |
Typ QES. Možné hodnoty: 'Eideasy', 'Nom151'. Používá se k vyžádání podpisů QES od podepisujících. Všichni podepisující osoby v pozvánce musí používat stejný typ podpisu. Pokud chcete vytvořit pozvánku pomocí QES, musí uživatel patřit do organizace s povoleným QES. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pozvánky
|
id | string |
ID vytvořené vložené pozvánky |
Vytvořit podpisový odkaz
Vygenerujte odkaz na dokument a sdílejte ho, aby byl dokument podepsaný.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | True | string |
Zadejte jedinečné ID dokumentu nebo vyberte dokument ze seznamu. |
|
pole
|
fields | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
URL
|
url_no_signup | string |
Podpisový odkaz |
Vytvořit vloženou pozvánku k dokumentu
Tato akce vytvoří vloženou pozvánku k podepisování dokumentu. Po vytvoření pozvánky vygenerujte vložený podpisový odkaz.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
E-mail podepisující osoby
|
True |
E-mailová adresa příjemce |
||
|
Role
|
role | True | string |
Jméno role příjemce, například Podepisující 1 (role prohlížeče se nepodporují) |
|
Objednávka
|
order | True | integer |
Pořadí podepisování |
|
Pojmenovat vzorec
|
name_formula | string |
Vzorec pro vygenerování dokončeného názvu dokumentu pomocí předpony (libovolného textu) a dat pole s možností vyplnění Příklad: Contract|signer_name|signed_date, kde "Kontrakt" je předpona a "signer_name" a "signed_date" jsou názvy vyplnitelných polí. |
|
|
Role
|
role | True | string |
Jméno role příjemce, například Podepisující 1 (role prohlížeče se nepodporují) |
|
Jazyk
|
language | string |
Určuje jazyk podpisové relace a e-maily s oznámením pro podepisující osoby. Možné hodnoty: En pro angličtinu, Es pro španělštinu a Fr pro francouzštinu. Pokud není nastavený, jazyk je určen jazykem vašeho účtu SignNow. |
|
|
Křestní jméno
|
first_name | string |
Jméno příjemce |
|
|
Příjmení
|
last_name | string |
Příjmení příjemce |
|
|
Požadovaný název přednastavení podpisu
|
required_preset_signature_name | string |
Předem vyplněný text pole podpisu, uzamčený pro úpravy příjemcem. Nelze použít s prefill_signature_name nebo force_new_signature. |
|
|
Předvyplnění názvu podpisu
|
prefill_signature_name | string |
Řetězec s názvem podpisu, který se zobrazí, když podepisující klikne na pole podpisu. Podepisující může podpis upravit. |
|
|
Vyžadovat nový podpis
|
force_new_signature | boolean |
Definuje, jestli podepisující může použít uložený podpis, nebo ne. Pokud je nastavená hodnota true, podepisující musí přidat nový podpis. Pokud je nastavená hodnota false, může podepisující znaménko použít uložený podpis. |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Odkaz, který se otevře po dokončení podpisové relace |
|
|
Identifikátor URI pro odmítnutí přesměrování
|
decline_redirect_uri | string |
Odkaz, který se otevře, když příjemce odmítne podepsat dokument |
|
|
Zavřít identifikátor URI přesměrování
|
close_redirect_uri | string |
Odkaz, který se otevře, když příjemce klikne na Uložit průběh a dokončí později během podpisové relace nebo zavření v režimu zobrazení |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
|
|
Typ ověřování
|
authentication_type | string |
Typ ověřování použitý pro ověřování příjemce během podpisové relace. Povolené hodnoty: "Heslo", "Telefonní hovor" a "Sms" |
|
|
Ověřovací heslo
|
authentication_password | string |
Heslo nastavené pro ověřování podepisující osoby. Požadováno pro typ ověřování Heslo |
|
|
Telefon pro ověřování
|
authentication_phone | string |
Telefonní číslo použité k ověření podepisující osoby. Vyžaduje se pro typ ověřování "Telefonní hovor" a "Sms". Příklad: +1XXXXXXXXXXX |
|
|
Zpráva SMS pro ověření
|
authentication_sms_message | string |
Vlastní zpráva SMS odeslaná podepisující sadě obsahující zástupný symbol {password}. Používá se s typem ověřování Sms. Bez tohoto parametru obdrží podepisující uživatel výchozí sms s automaticky vygenerovaným heslem (odemknout kód) – "SignNow document invite code: 123456" Example: Enter the password {password} to unlock your document |
|
|
Typ doručení
|
delivery_type | string |
Definuje způsob odeslání pozvánky. |
|
|
Vypršení platnosti propojení
|
link_expiration | integer |
Kolik minut vyprší platnost pozvánky e-mailu. Dá se použít jenom v případě, že delivery type=email. Platný rozsah: 15–43200 minut |
|
|
Vypršení platnosti relace
|
session_expiration | integer |
Kolik minut vyprší platnost podpisové relace. Pokud se pro tuto pozvánku vygeneruje odkaz, resetuje se vypršení platnosti relace. Platí pouze v případě, že akce Delivery type=email a 'sign' (Podepsat) Platný rozsah: 15–1440 minut |
|
|
Podpis QES
|
signature | string |
Typ QES. Možné hodnoty: 'Eideasy', 'Nom151'. Používá se k vyžádání podpisů QES od podepisujících. Všichni podepisující osoby v pozvánce musí používat stejný typ podpisu. Pokud chcete vytvořit pozvánku pomocí QES, musí uživatel patřit do organizace s povoleným QES. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
data
|
data | array of object |
Data |
|
identifikační číslo
|
data.id | string |
ID vytvořené vložené pozvánky |
|
Email
|
data.email | string |
E-mail příjemce |
|
Role ID
|
data.role_id | string |
ID role příjemce |
|
Objednávka
|
data.order | integer |
Pořadí podpisů příjemců |
|
Stav
|
data.status | string |
Stav vložené pozvánky |
Vytvořit vložený odkaz pro odesílání dokumentů
Tato akce vygeneruje vložený odesílající odkaz pro konkrétní dokument, který umožňuje uživatelům třetích stran připravit a odeslat dokument k podpisu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
|
Typ
|
type | string |
Určuje odesílající krok, ve kterém se má odkaz otevřít. Možné hodnoty: Pozvat: otevře stránku Odeslat pozvánku pro dokument, kde uživatel může přidat e-maily podepisující osoby, předmět, zprávu atd. Dokument: otevře dokument v editoru a přidá vyplnitelná pole a otevře stránku Odeslat pozvánku. |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Stránka, která se otevře po nastavení vloženého odesílání Vyžaduje se, pokud je přidán cíl přesměrování. |
|
|
Vypršení platnosti propojení
|
link_expiration | integer |
Určuje, kolik minut bude odkaz aktivní. Povolený rozsah: 15 až 45 minut. Uživatelé na úrovni správce můžou nastavit dobu trvání maximálně 43200 minut. |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
Odkaz na odesílající vložený dokument |
Vytvořit vložený odkaz pro odesílání skupiny dokumentů
Tato akce vygeneruje vložený odesílající odkaz pro konkrétní skupinu dokumentů, což umožňuje uživatelům třetích stran připravit a odeslat skupinu dokumentů k podpisu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
|
Typ
|
type | string |
Určuje krok odeslání, ve kterém má vložený odkaz otevřít: "manage" – otevře odkaz na stránce Přidat dokumenty do skupiny dokumentů; "edit": otevře odkaz v editoru; 'send-invite': otevře odkaz na stránce Odeslat pozvánku. |
|
|
Identifikátor URI přesměrování
|
redirect_uri | string |
Stránka, která se otevře po nastavení vloženého odesílání Vyžaduje se, pokud je přidán cíl přesměrování. |
|
|
Vypršení platnosti propojení
|
link_expiration | integer |
Určuje, kolik minut bude odkaz aktivní. Povolený rozsah: 15 až 45 minut. Uživatelé na úrovni správce můžou nastavit dobu trvání maximálně 43200 minut. |
|
|
Cíl přesměrování
|
redirect_target | string |
Určuje, zda se má identifikátor URI přesměrování otevřít na nové kartě v prohlížeči nebo na stejné kartě po podepsání relace. Možné hodnoty: "Na nové kartě" – otevře odkaz na nové kartě, "Na stejné kartě" – otevře odkaz na stejné kartě. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
Odkaz na odesílající vloženou skupinu dokumentů |
Zastaralé – pozvání k podepsání
Akce je zastaralá. Pozvání ostatních k vyplnění a podepsání dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Určete, jestli se mají načíst dokumenty nebo šablony. |
|
Dokument
|
template_id | True | string |
Výběr šablony ze seznamu |
|
body
|
body | True | dynamic |
Návraty
- response
- object
Zastaralé – Pozvání k podepsání skupiny dokumentů
Akce je zastaralá. Pozvání ostatních k vyplnění a podepsání skupiny dokumentů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Určete, jestli se mají načíst skupiny dokumentů nebo šablony skupin. |
|
Skupina dokumentů
|
template_group_id | True | string |
Ze seznamu vyberte skupinu dokumentů. |
|
body
|
body | True | dynamic |
Návraty
- response
- object
Zastaralé – Rozšířená pozvánka na dokument
Akce je zastaralá. Žádost o pozvání s ručně definovaným schématem Umožňuje nastavit pozvání pro dokument, který se v budoucnu vygeneruje.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | True | string |
Zadejte ID dokumentu. |
|
Název
|
role | string |
Název podepisující osoby |
|
|
E-mail
|
Zadání e-mailu pro podepisující osoby |
|||
|
Telefonní číslo (pozvání přes SMS)
|
phone_invite | string |
Zadejte telefonní číslo příjemce +XXXXXXXXXX. Vyžaduje se pro pozvání prostřednictvím SMS. |
|
|
Objednávka
|
order | integer |
Nastavení pořadí podepisování pro více podepisujících |
|
|
Individuální předmět
|
subject | string |
Přidání přizpůsobeného předmětu pro podepisujícího |
|
|
Přizpůsobená zpráva
|
message | string |
Přidání přizpůsobené zprávy pro podepisujícího |
|
|
Typ autentizace
|
authentication_type | string |
Ověření identity uživatele pomocí hesla, SMS nebo telefonního hovoru |
|
|
Heslo
|
password | string |
Nastavení hesla pro typ ověřování Heslo |
|
|
telefon
|
phone | string |
Zadejte telefonní číslo +XXXXXXXXXXXX pro typ ověřování Telefon nebo SMS. |
|
|
Dny do vypršení platnosti
|
expiration_days | integer |
Oznámení o tom, kolik dní vyprší platnost pozvánky |
|
|
Odeslat připomenutí v
|
reminder | integer |
Počet dní po odeslání pozvánky, aby se automaticky odeslalo s připomenutím e-mailu |
|
|
Odeslat připomenutí každých X dnů
|
remind_repeat | integer |
Příjemce dostane e-mail s připomenutím každých nastavených dnů. |
|
|
Povolit přeposílání
|
reassign | boolean |
Povolit podepisující osobě delegovat podepisování na někoho jiného |
|
|
Zobrazit odmítnutí podpisu
|
decline_by_signature | boolean |
Pokud příjemce odmítl podepsat dokument, označte pole podpisu jako Odmítnout podepsat. |
|
|
titulek
|
cc | string |
Čárkami oddělené e-maily, které budou v pozvánce zkopírovány z uhlíku |
|
|
Předmět
|
subject | string |
Zadejte předmět. |
|
|
Message
|
message | string |
Napište zprávu. |
|
|
Odeslání e-mailu všem stranám po dokončení
|
on_complete | string |
Při podpisu dokumentu dostanou všichni účastníci e-mail s oznámením. |
Návraty
- response
- object
Zrušit pozvání
Zrušení pozvánky podpisu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | True | string |
Zadání ID dokumentu pro zrušení pozvánky podpisu |
Návraty
- response
- object
Získání informací o dokumentu
Získejte vlastnosti dokumentu, jako je název, ID, data vytvoření nebo aktualizace atd.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Určete, jestli se mají načíst dokumenty nebo šablony. |
|
ID dokumentu
|
doc_id | True | string |
Zadejte jedinečné ID dokumentu nebo vyberte dokument ze seznamu. |
Návraty
- Body
- DocumentProperties
Získání polí dokumentu (Preview)
Načtení hodnot z vyplnitelných polí v dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Zadání šablony dokumentu pro získání polí z |
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
Návraty
Získání polí dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Získat pole dokumentu .
Získání hodnot polí dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Zadání šablony dokumentu pro získání polí z |
|
ID dokumentu
|
doc_id | True | string |
Zadání jedinečného ID dokumentu |
Návraty
Získání schématu dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Získat schéma dokumentu .
Získání schématu dokumentu OpenAPI
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
doc_id | string |
Zadání jedinečného ID dokumentu |
|
|
Filtr typů polí
|
select | string |
Oddělte středníkem, jaké typy polí chcete načíst. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vlastnosti
|
properties | object |
Získání seznamu dokumentů
Načtení seznamu dokumentů uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template | boolean |
Určete, jestli se mají načíst dokumenty nebo šablony. |
|
|
Zahrnout výchozí šablonu
|
includeDefaultTemplate | boolean |
Určete, jestli se má výchozí šablona přidat do seznamu šablon. |
Návraty
- response
- array of DocumentProperties
Získání skupin dokumentů
Načtení seznamu skupin dokumentů uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Určete, jestli se mají načíst skupiny dokumentů nebo šablony skupin. |
|
Omezení
|
limit | integer |
Celkový počet vrácených položek (mezi 1 a 50) |
|
|
Posun
|
offset | integer |
Posun první položky v kolekci (na základě nuly) pro vrácení |
Návraty
Získání skupiny dokumentů
Načtení seznamu skupin dokumentů uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Šablona skupiny
|
doc_group_id | True | string |
Ze seznamu vyberte šablonu skupiny. |
|
Template
|
template | True | boolean |
Určete, jestli se má načíst skupina dokumentů nebo šablona skupiny. |
Návraty
Získání stavu pozvání dokumentu
Tato akce načte informace o pozvánce na dokument, včetně stavu každého kroku a akce.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
id | True | string |
ID dokumentu |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Dokument byl odmítnut.
|
is_document_declined | boolean |
Hodnota True, pokud podepisující nebo schvalovatel odmítl dokument, v opačném případě nepravda |
|
steps
|
steps | array of object |
Postup |
|
Podpisová objednávka
|
steps.signing_order | integer |
Pořadí podepisování |
|
E-mail příjemce
|
steps.signer_email | string |
E-mailová adresa příjemce |
|
Název role
|
steps.role_name | string |
Název role příjemce |
|
Typ akce
|
steps.action_type | string |
Akce vyžadovaná příjemcem v dokumentu Možné hodnoty: Sign, View, Approve nebo FreeFormSign |
|
ID pozvánky
|
steps.invite_id | string |
ID pozvánky |
|
Stav
|
steps.status | string |
Stav podepisování. Možné hodnoty: 'created', 'pending', 'fulfilled', 'canceled', 'skipped' |
|
Odmítnuto
|
steps.declined | boolean |
Vrátí hodnotu true, pokud příjemce tohoto kroku odmítl dokument. |
|
Důvod odmítnutí
|
steps.decline_reason | string |
Zpráva poskytnutá příjemcem při odmítnutí dokumentu |
|
Vytvořené
|
steps.created | integer |
Datum vytvoření kroku |
|
Updated
|
steps.updated | integer |
Datum poslední aktualizace stavu kroku |
Získání stavu pozvání skupiny dokumentů
Tato akce načte informace o pozvánce skupiny dokumentů, včetně stavu každého kroku a akce.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID skupiny dokumentů
|
id | True | string |
ID skupiny dokumentů |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pozvánky skupiny dokumentů
|
document_group_invite_id | string |
ID pozvánky skupiny dokumentů |
|
Stav skupiny dokumentů
|
status | string |
Stav podepisování skupiny dokumentů Možné hodnoty: "created", 'pending', 'fulfilled', 'canceled' |
|
E-mail vlastníka
|
owner_email | string |
E-mailová adresa vlastníka skupiny dokumentů |
|
Zamítnutá skupina dokumentů
|
is_document_declined | boolean |
Vrátí hodnotu true, pokud některý dokument ve skupině odmítne podepisující nebo schvalovatele; v opačném případě vrátí hodnotu false. |
|
steps
|
steps | array of object |
Postup |
|
ID kroku
|
steps.step_id | string |
ID kroku z pozvánky skupiny dokumentů |
|
Podpisová objednávka
|
steps.signing_order | integer |
Pořadí podepisování |
|
ID dokumentu
|
steps.document_id | string |
ID dokumentu |
|
Název dokumentu
|
steps.document_name | string |
Název dokumentu |
|
E-mail podepisující osoby
|
steps.signer_email | string |
E-mailová adresa příjemce |
|
Název role
|
steps.role_name | string |
Název role příjemce |
|
Typ akce
|
steps.action_type | string |
Akce vyžadovaná příjemcem v dokumentu Možné hodnoty: Sign, View, Approve nebo FreeFormSign |
|
ID pozvánky kroku
|
steps.invite_id | string |
ID kroku pozvánky |
|
Stav
|
steps.status | string |
Stav podepisování kroku |
|
Odmítnuto
|
steps.declined | boolean |
True, pokud příjemce v tomto kroku odmítl dokument. |
|
Důvod odmítnutí
|
steps.decline_reason | string |
Zpráva poskytnutá příjemcem při odmítnutí dokumentu |
|
Vytvořené
|
steps.created | integer |
Datum vytvoření kroku |
|
Updated
|
steps.updated | integer |
Datum poslední aktualizace stavu kroku |
Aktivační události
| Spuštění toku u události dokumentu (Preview) |
Vyberte událost, na které se má aktivovat: nová nebo aktualizovaná pozvánka podpisu; když někdo vytvoří, aktualizuje, dokončí nebo odstraní dokument |
| Zahájení toku u události dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte tok zahájení u události dokumentu .
|
Spuštění toku u události dokumentu (Preview)
Vyberte událost, na které se má aktivovat: nová nebo aktualizovaná pozvánka podpisu; když někdo vytvoří, aktualizuje, dokončí nebo odstraní dokument
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Event
|
event | True | string |
Vyberte událost, která by měla aktivovat tok. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Event
|
meta.event | string |
Událost dokumentu, která způsobila trigger |
|
ID dokumentu
|
content.document_id | string |
Jedinečné ID cílového dokumentu, které způsobilo událost. |
|
Název dokumentu
|
content.document_name | string |
Název cílového souboru dokumentu bez přípony |
Zahájení toku u události dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte tok zahájení u události dokumentu .
Aktivační událost můžete vytvořit pro jednu z těchto událostí: vytvoření dokumentu, aktualizace dokumentu, odstranění dokumentu, dokončení dokumentu, vytvoření pozvánky, aktualizace pozvánek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Event
|
event | True | string |
Vyberte událost, která by měla aktivovat tok. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
meta.timestamp | integer |
Datum a čas, kdy došlo k události (formát časového razítka unixu). |
|
Event
|
meta.event | string |
Událost dokumentu, která způsobila trigger |
|
ID dokumentu
|
content.document_id | string |
Jedinečné ID cílového dokumentu, které způsobilo událost. |
|
Název dokumentu
|
content.document_name | string |
Název cílového souboru dokumentu bez přípony |
Definice
DocumentProperties
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
|
Název dokumentu
|
document_name | string |
Název souboru dokumentu bez přípony |
|
Počet stránek
|
page_count | integer |
Počet stránek v dokumentu |
|
Vytvořené
|
created | integer |
Datum a čas vytvoření dokumentu ve formátu unixového časového razítka |
|
Updated
|
updated | integer |
Datum a čas aktualizace dokumentu ve formátu unixového časového razítka |
|
Název šablony
|
original_filename | string |
Název souboru šablony s příponou (pokud existuje) |
|
ID šablony
|
origin_document_id | string |
ID dokumentu šablony (pokud existuje) |
|
Je šablona
|
template | boolean |
true if document is template. |
|
Stav dokumentu
|
status | string |
Stav dokumentu |
DocumentGroupsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
document_groups
|
document_groups | array of DocumentGroupProperties | |
|
Celkový počet skupin dokumentů
|
document_group_total_count | integer |
Celkový počet skupin dokumentů v účtu SignNow |
DocumentGroupProperties
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID skupiny dokumentů
|
group_id | DocumentGroupId |
Jedinečné ID skupiny dokumentů |
|
Název skupiny dokumentů
|
group_name | string |
Název skupiny dokumentů |
|
Documents
|
documents | array of DocumentGroupDocumentProperties |
Documents |
DocumentGroupDocumentProperties
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | DocumentId |
Jedinečné ID dokumentu |
|
Název dokumentu
|
document_name | string |
Název souboru dokumentu bez přípony |
|
ID šablony
|
origin_document_id | string |
ID dokumentu šablony (pokud existuje) |
CreateDocumentGroupFromFilesResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název skupiny dokumentů
|
group_name | string |
Název skupiny dokumentů |
|
ID skupiny dokumentů
|
group_id | string |
ID skupiny dokumentů |
|
dokumenty
|
documents | array of object | |
|
ID dokumentu
|
documents.id | DocumentId |
Jedinečné ID dokumentu |
|
Název dokumentu
|
documents.name | string |
Název dokumentu |
Id dokumentu
DocumentGroupId
objekt
Toto je typ "object".
binární
Toto je základní datový typ Binary.