sproof Sign (Preview)

Pomocí sproof Sign můžete automatizovat bezpečné pracovní postupy elektronického podpisu pro dokumenty PDF a DOCX. Organizace můžou vytvářet žádosti o podpis s jedním nebo více dokumenty, přiřazovat příjemce a podpisové role, sledovat stav, stahovat dokončené soubory PDF a odstraňovat dokumenty. Účet sproof Sign, plán, který podporuje vybrané akce a typy podpisů, a je vyžadován platný token rozhraní API.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate kromě 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)
Logické aplikace	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Azure Government oblastí      – Azure oblasti Čína      - 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)
Automatizace napájení	Premium	Všechny oblasti Power Automate kromě 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	Podpora rozhraní API
URL	https://sproof.com
Email	support@sproof.com

Metadata konektoru
Vydavatel	sproof GmbH
Internetová stránka	https://www.sproof.com/en/sign/
Zásady ochrany osobních údajů	https://www.sproof.com/en/privacy-policy-app/
Kategorie	Produktivita; Obsah a soubory

Sproof Sign

Přehled

Sproof Sign umožňuje organizacím automatizovat pracovní postupy elektronického podpisu pro dokumenty PDF a DOCX. Konektor může vytvářet žádosti o podpis jednoho dokumentu nebo obálky s více dokumenty, přiřazovat příjemce a podpisové role, načítat stav žádosti, stahovat dokončené dokumenty a odstraňovat dokumenty.

Předpoklady

Abyste mohli konektor používat, potřebujete:

• Účet sproof Sign.
• Plán sproof Sign plan with API access and support for the required actions and signature types.
• Platný token podpisového rozhraní API

Autentizace

Konektor používá ověřování pomocí tokenu rozhraní API. Vytvořte připojení zadáním platného tokenu podpisového rozhraní API přidruženého k vašemu účtu. Zabezpečte token a nahraďte ho, pokud dojde k odvolání nebo opětovnému vygenerování tokenu.

Podporované akce

• Vytvoření žádosti o podpis – Vytvoří žádost o jeden dokument nebo obálku obsahující více dokumentů. Příjemce, podpisové role, podpisové pořadí, pozice podpisu a další nastavení pozvánky je možné nakonfigurovat.
• Vytvoření žádosti o podpis pomocí zástupných symbolů – Vytvoří požadavek pomocí zástupných symbolů uložených v nahraném dokumentu. Informace o příjemci a pozice podpisu se z těchto zástupných symbolů extrahují.
• Získání stavu žádosti – Načte aktuální stav a podpisový stav žádosti o podpis pomocí ID člena.
• Získat dokument – stáhne dokument jako binární PDF nebo jako PDF kódovaný v base64.
• Odstranit dokument – Odstraní dokument nebo odebere přístup člena v závislosti na zadaném ID člena, roli člena a tom, jestli dokument patří do obálky.

Známá omezení a požadavky

• Vstupní dokumenty musí být zadány jako obsah PDF nebo DOCX kódovaný ve formátu Base64.
• Obálka může obsahovat maximálně 25 dokumentů.
• Název obálky se vyžaduje při odeslání více než jednoho dokumentu.
• Požadavky založené na zástupných symbolech vyžadují v nahraném dokumentu správně formátované zástupné symboly.
• U požadavků založených na zástupných symbolech se příjemci a pozice podpisu získávají z dokumentu, nikoli ručně.
• Dostupné akce, typy podpisů a poskytovatelé závisí na připojeném účtu a plánu signatury.
• Chování odstranění dokumentu závisí na tom, jestli zadané ID člena patří odesílateli nebo příjemci a jestli je dokument součástí obálky.

Podpora

Pokud potřebujete podporu konektoru nebo rozhraní API, obraťte se na support@sproof.com.

Vytvoření připojení

Konektor podporuje následující typy ověřování:

Default	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

název	Typ	Description	Povinné
token	securestring	"token" für diese API	Pravdivé

Akce

Odstranit dokument	Odstraní dokument nebo odebere přístup člena k němu v závislosti na tom, jestli daný memberId dokument patří odesílateli nebo příjemci a jestli je dokument součástí obálky. Dokumenty v obálce Parametr all dotazu nemá žádný vliv na dokumenty v obálce. S odesílatelem memberId: Jeden dokument se odstraní pro odesílatele a všechny příjemce. Dokument se odebere z obálky. S příjemcem memberId: Všechny dokumenty v obálce jsou pro příjemce odebrány. Příjemce je označený jako declined u všech dokumentů, které byly pro příjemce odstraněny. Dokumenty zůstanou k dispozici pro všechny ostatní členy dokumentu. Jednotlivé dokumenty S odesílatelem memberId a all=true: Dokument se odstraní pro odesílatele a všechny příjemce. S odesílatelem memberId a all=false: Dokument se odstraní jenom pro odesílatele. Dokument zůstane k dispozici ostatním příjemcům dokumentu. S příjemcem memberId: Příjemce je v dokumentu označený jako declined . Dokument zůstane k dispozici pro všechny ostatní členy dokumentu.
Vytvoření žádosti o podpis	Toto je nová žádost o vytvoření podpisu. Kromě vytvoření jedné pozvánky na dokument teď podporuje vytváření obálek a nahrávání více dokumentů najednou při odesílání pozvánek.
Vytvoření žádosti o podpis pomocí zástupných symbolů	Vytvoří žádost o podpis pomocí zástupných symbolů uložených v nahraném dokumentu. Příjemci a pozice podpisu se extrahují z dokumentu.
Získání dokumentu	Získejte podepsaný dokument jako binární řetězec nebo řetězec kódovaný kódem Base64.
Získání stavu žádosti	Získejte stav žádosti o podpis. Vrátí objekt JSON dokumentu nebo chybu. Parametr je vrácen žádostí o příspěvek v dokumentu a je přidružený k e-mailu odesílatele.

Odstranit dokument

ID operace:

DeleteDocument

Odstraní dokument nebo odebere přístup člena k němu v závislosti na tom, jestli daný memberId dokument patří odesílateli nebo příjemci a jestli je dokument součástí obálky.

Dokumenty v obálce

Parametr all dotazu nemá žádný vliv na dokumenty v obálce.

S odesílatelem memberId:

• Jeden dokument se odstraní pro odesílatele a všechny příjemce.
• Dokument se odebere z obálky.

S příjemcem memberId:

• Všechny dokumenty v obálce jsou pro příjemce odebrány.
• Příjemce je označený jako declined u všech dokumentů, které byly pro příjemce odstraněny.
• Dokumenty zůstanou k dispozici pro všechny ostatní členy dokumentu.

Jednotlivé dokumenty

S odesílatelem memberId a all=true:

• Dokument se odstraní pro odesílatele a všechny příjemce.

S odesílatelem memberId a all=false:

• Dokument se odstraní jenom pro odesílatele.
• Dokument zůstane k dispozici ostatním příjemcům dokumentu.

S příjemcem memberId:

• Příjemce je v dokumentu označený jako declined .
• Dokument zůstane k dispozici pro všechny ostatní členy dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID člena	memberId	True	string	ID člena
Odstranit pro všechny příjemce	all		boolean	Relevantní pouze pro jednotlivé dokumenty, pokud zadané memberId dokumenty patří odesílateli. Pokud je nastavená hodnota true, dokument se odstraní pro odesílatele a všechny příjemce. Pokud je nastavená hodnota false, dokument se odstraní jenom pro odesílatele a zůstane dostupný ostatním příjemcům. Tento parametr nemá žádný vliv na dokumenty v obálce (výchozí = true) nebo v případě, že zadaný memberId parametr patří příjemci.

Návraty

response

DeleteDocumentResponse

Vytvoření žádosti o podpis

ID operace:

CreateSignatureRequest

Toto je nová žádost o vytvoření podpisu. Kromě vytvoření jedné pozvánky na dokument teď podporuje vytváření obálek a nahrávání více dokumentů najednou při odesílání pozvánek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
e-mail	email	True	string	E-mail odesílatele Musí patřit členu vašeho plánu.
firstName	firstName	True	string	Jméno odesílatele.
lastName	lastName		string	Příjmení odesílatele.
role	role		string	Role odesílatele ve všech dokumentech.
e-mail	email		string	E-mail příjemce
firstName	firstName		string	Jméno příjemce.
lastName	lastName		string	Příjmení příjemce.
doNotSendEmails	doNotSendEmails		boolean	Pokud není nastavená žádná true e-mailová adresa, odešle se příjemci.
customId	customId		string	Pokud je e-mailová adresa příjemce v okamžiku pozvání neznámá . To funguje jenom v případě, že pozvete příjemce (ne pro přípravu tras) a chcete použít fastlane. Umožňuje customId předem vygenerovat jedinečný podpisový odkaz pro příjemce před odesláním pozvánky. Musí být jedinečný alfanumerický řetězec s nejméně 70 znaky. Poznámka: Vlastní ID lze použít pouze k vytvoření odkazu příjemce na dokument. Nejde ho použít pro jiné požadavky místo id člena. Podrobnosti o vytváření adres URL najdete v tématu Otevření dokumentu s vlastním ID.
useFastlane	useFastlane		boolean	Pokud je nastaveno na true podepisující osoby, dostane v e-mailu s pozvánkou odkaz Fastlane.
phoneNumber	phoneNumber		string	Telefonní číslo tohoto příjemce Používá se k ověření sms. (např: +43 699 1234 1234).
privateMessage	privateMessage		string	Soukromá zpráva pro tohoto konkrétního příjemce.
inPersonMode	inPersonMode		boolean	Pokud je tato možnost povolená, příjemce žádosti o podpis bude muset dokument podepsat osobně a nebude odeslán žádný e-mail. Tento režim je k dispozici pouze pomocí typu podpisu SES.
signatureTypes	signatureTypes		array of string	Typy podpisů, které jsou pro tohoto příjemce povolené. Možnosti: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
klíčové slovo	tag		string	Tato značka určuje zprostředkovatele identity, který se použije pro proces podepisování. Vyberte si z předdefinované sady podporovaných poskytovatelů. Poznámka1: Někteří zprostředkovatelé jsou k dispozici pouze pro určité typy podpisů, například onetimeqes budou vyžadovat "signatureType" : ["qualifiedPlusIdent"] Poznámka 2: Při použití sproof-qualified jako výchozího poskytovatele musí příjemce mít aktivní sproofní účet s aktivní licencí User+ .
canChange	canChange		boolean	Logická hodnota označující, jestli má pozvaný příjemce mít možnost změnit zprostředkovatele podpisu
Země	country		string	Výchozí země, pokud je nastavená na všechny hodnoty, vrátí se chyba s informacemi o tom, které země jsou pro zvolenou značku poskytovatele k dispozici.
splatné datum	dueDate		YYYY-MM-DD	Datum, do kterého lze dokument podepsat. Toto datum splnění se zobrazí příjemci v e-mailu s pozvánkou a zobrazuje se také v části podrobností dokumentu na řídicím panelu. Slouží jako konečný termín pro dokončení procesu podepisování.
reminderInterval	reminderInterval		number	Určuje počet dní mezi e-maily s připomenutím.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum odeslání připomenutí
inviteLanguage	inviteLanguage		string	Určuje jazyk e-mailů odeslaných anonymním uživatelům, kteří nemají účet. Pro uživatele s účtem se místo toho použije jazyk, který vybrali ve svém profilu.
zpráva	message		string	Vlastní zpráva odeslaná příjemcům v e-mailu.
subject	subject		string	Řádek předmětu e-mailu odeslaného příjemcům.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Pokud je nastavená hodnota true, soubor PDF se odešle jako příloha všem příjemcům dokumentu (pokud je menší než 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Pokud je tato možnost povolená, příjemce žádosti o podpis bude omezen na podepsání nebo odmítnutí dokumentu a nebude moct přejít mimo stránku.
allowForwarding	allowForwarding		boolean	Povolit přeposlání pozvánky
collabSigningMode	collabSigningMode		object	Objekt, ve kterém každý klíč představuje podpisové kolo, a jeho odpovídající hodnota označuje, jestli je pro toto kolo povolené podepisování pro spolupráci. Pokud je hodnota true, k dokončení zadaného kola podepisování je vyžadován pouze jeden podpis a pokračujte k dalšímu kole. Například { '1': true } znamená, že při podepisování '1', je nutný pouze jeden podpis.
usePlaceholders	usePlaceholders		boolean	Pokud je hodnota true, zástupné symboly textu nebo pole formulářů uložené v dokumentu se použijí k pozvání příjemců.
inPersonSigning	inPersonSigning		boolean	Pokud je pravda, příjemce dostane automaticky otevírané okno, kde musí ručně nakreslit podpis.
folderName	folderName		string	Pokud je uvedeno, vytvoří se obálka obsahující všechny dokumenty v documentDataArray. (Vyžaduje se, pokud je odesláno více než jeden dokument.
callbackUrl	callbackUrl		string	Žádost POST, včetně dokumentu, se odešle na tuto adresu URL, když se vytvoří nový podpis nebo když příjemce odmítne dokument. V případě selhání je zaveden mechanismus opakování, který zajistí opakování požadavku.
Returnurl	returnUrl		string	Odkaz na tlačítko Pro návrat po podepsání dokumentu
returnBtnText	returnBtnText		string	Text tlačítka pro vrácení po podepsání dokumentu
data	data	True	string	Data dokumentu (PDF nebo DOCX) ve formátu base64.
mimetype	mimetype		string	Typ MIME s kódováním base64 data PDF nebo DOCX, který se vyžaduje v případě, že dokument není pdf
fileName	fileName	True	string	Název souboru
jmenovka	label		string	Vlastní popisek, který lze odeslat k uspořádání dokumentů.
stránka	page	True	integer	Číslo stránky, na které je pole zapnuté, přičemž první stránka je 0.
Pagewidth	pageWidth		integer	Jakákoli celočíselná hodnota popisující šířku stránky. Čím větší je číslo, tím lepší je přesnost při umístění pole do mezery x y. Na stránce A4 máme jako výchozí hodnotu 478.
pageHeight	pageHeight		integer	Jakákoli celočíselná hodnota popisující výšku stránky Čím větší je číslo, tím lepší je přesnost při umístění pole do mezery x y. Na stránce A4 máme jako výchozí hodnotu 676.
x	x	True	float	Představuje vodorovnou pozici pole jako procento šířky stránky. Původ (0,0) je v levém horním rohu stránky. Hodnota 0,1 znamená, že pole je umístěné na 10% šířky stránky zleva.
y	y	True	float	Představuje svislou pozici pole jako procento výšky stránky. Původ (0,0) je v levém horním rohu stránky. Hodnota 0,1 znamená, že pole je umístěné na 10% výšky stránky shora.
width	width	True	float	Šířka rámečku na základě rozměrů stránky, podobně jako souřadnice x a y. Jedná se o plovoucí hodnotu představující procento stránkyWidth.
height	height	True	float	Výška pole na základě rozměrů stránky, podobně jako souřadnice x a y. Jedná se o plovoucí hodnotu představující procento stránkyHeight.
id	id	True	string	Jedinečné ID pro toto pole vygenerované jakýmkoli způsobem.
jmenovka	label		string	Zástupný text, například název pole, například Datum narození.
value	value		string	Výchozí hodnota pole Může mít hodnotu null. Pokud je pole typu chooseBox, může být hodnota null nebo jeden z řetězců definovaných v možnostech.
jen pro čtení	readonly		boolean	Pokud je nastavena hodnota true, pozvaná osoba nemůže změnit hodnotu tohoto pole.
required	required		boolean	Pokud je nastavená hodnota true, pozvaná osoba nemůže dokument podepsat bez vyplnění tohoto pole.
typ	type	True	string
víceřádkový	multiline		boolean	Určuje, jestli je povoleno více řádků.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
seskupit	group		number	Každému přepínači lze přiřadit skupinu.
signatureTypes	signatureTypes		array of string	Typypodpisch Možnosti: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId je volitelné pole, které slouží k křížovému odkazu na nahraný dokument. V případě zadání vám umožní přiřadit k dokumentu vlastní identifikátor odkazu, který se vrátí jako součást objektu dokumentu v budoucích odpovědích rozhraní API. To může být užitečné pro sledování nebo uspořádání dokumentů externím systémem nebo pracovním postupem.
jazyk	language		string	Jazyk dokumentu.
folderId	folderId		string	ID složky, do které mají být dokumenty vloženy. To je možné pouze v případě, že nejsou definovány parametry inviteData i folderName.
isAttachment	isAttachment		boolean	isAttachment není v tomto případě potřeba.
Podrobnosti o příjemci	recipientDetails	True	object	Podrobnosti o příjemci, které jsou klíčem e-mailu příjemce Příklad: {"mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55;"y":0.80,"width":0.25;"height":0.08}]}}.
useFastlane	useFastlane		boolean	Pokud je nastaveno na true podepisující osoby, dostane v e-mailu s pozvánkou odkaz Fastlane.
fastlaneProfileId	fastlaneProfileId		uuid	Zadejte profil Fastlane, který se má použít s tímto dokumentem. (hodnota useFastlane musí být nastavena na hodnotu true).

Návraty

Tělo

EnvelopeResponse

Vytvoření žádosti o podpis pomocí zástupných symbolů

ID operace:

CreateSignatureRequestUsingPlaceholders

Vytvoří žádost o podpis pomocí zástupných symbolů uložených v nahraném dokumentu. Příjemci a pozice podpisu se extrahují z dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
e-mail	email	True	string	E-mail odesílatele Musí patřit členu vašeho plánu.
firstName	firstName	True	string	Jméno odesílatele.
lastName	lastName		string	Příjmení odesílatele.
role	role		string	Role odesílatele ve všech dokumentech.
e-mail	email		string	E-mail příjemce
firstName	firstName		string	Jméno příjemce.
lastName	lastName		string	Příjmení příjemce.
doNotSendEmails	doNotSendEmails		boolean	Pokud není nastavená žádná true e-mailová adresa, odešle se příjemci.
customId	customId		string	Pokud je e-mailová adresa příjemce v okamžiku pozvání neznámá . To funguje jenom v případě, že pozvete příjemce (ne pro přípravu tras) a chcete použít fastlane. Umožňuje customId předem vygenerovat jedinečný podpisový odkaz pro příjemce před odesláním pozvánky. Musí být jedinečný alfanumerický řetězec s nejméně 70 znaky. Poznámka: Vlastní ID lze použít pouze k vytvoření odkazu příjemce na dokument. Nejde ho použít pro jiné požadavky místo id člena. Podrobnosti o vytváření adres URL najdete v tématu Otevření dokumentu s vlastním ID.
useFastlane	useFastlane		boolean	Pokud je nastaveno na true podepisující osoby, dostane v e-mailu s pozvánkou odkaz Fastlane.
phoneNumber	phoneNumber		string	Telefonní číslo tohoto příjemce Používá se k ověření sms. (např: +43 699 1234 1234).
privateMessage	privateMessage		string	Soukromá zpráva pro tohoto konkrétního příjemce.
inPersonMode	inPersonMode		boolean	Pokud je tato možnost povolená, příjemce žádosti o podpis bude muset dokument podepsat osobně a nebude odeslán žádný e-mail. Tento režim je k dispozici pouze pomocí typu podpisu SES.
signatureTypes	signatureTypes		array of string	Typy podpisů, které jsou pro tohoto příjemce povolené. Možnosti: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
klíčové slovo	tag		string	Tato značka určuje zprostředkovatele identity, který se použije pro proces podepisování. Vyberte si z předdefinované sady podporovaných poskytovatelů. Poznámka1: Někteří zprostředkovatelé jsou k dispozici pouze pro určité typy podpisů, například onetimeqes budou vyžadovat "signatureType" : ["qualifiedPlusIdent"] Poznámka 2: Při použití sproof-qualified jako výchozího poskytovatele musí příjemce mít aktivní sproofní účet s aktivní licencí User+ .
canChange	canChange		boolean	Logická hodnota označující, jestli má pozvaný příjemce mít možnost změnit zprostředkovatele podpisu
Země	country		string	Výchozí země, pokud je nastavená na všechny hodnoty, vrátí se chyba s informacemi o tom, které země jsou pro zvolenou značku poskytovatele k dispozici.
splatné datum	dueDate		YYYY-MM-DD	Datum, do kterého lze dokument podepsat. Toto datum splnění se zobrazí příjemci v e-mailu s pozvánkou a zobrazuje se také v části s podrobnostmi dokumentu na řídicím panelu. Slouží jako konečný termín pro dokončení procesu podepisování.
reminderInterval	reminderInterval		number	Určuje počet dní mezi e-maily s připomenutím.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum odeslání připomenutí
inviteLanguage	inviteLanguage		string	Určuje jazyk e-mailů odeslaných anonymním uživatelům, kteří nemají účet. Pro uživatele s účtem se místo toho použije jazyk, který vybrali ve svém profilu.
zpráva	message		string	Vlastní zpráva odeslaná příjemcům v e-mailu.
subject	subject		string	Řádek předmětu e-mailu odeslaného příjemcům.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Pokud je nastavená hodnota true, soubor PDF se odešle jako příloha všem příjemcům dokumentu (pokud je menší než 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Pokud je tato možnost povolená, příjemce žádosti o podpis bude omezen na podepsání nebo odmítnutí dokumentu a nebude moct přejít mimo stránku.
allowForwarding	allowForwarding		boolean	Povolit přeposlání pozvánky
collabSigningMode	collabSigningMode		object	Objekt, ve kterém každý klíč představuje podpisové kolo, a jeho odpovídající hodnota označuje, jestli je pro toto kolo povolené podepisování pro spolupráci. Pokud je hodnota true, k dokončení zadaného kola podepisování je vyžadován pouze jeden podpis a pokračujte k dalšímu kole. Například { '1': true } znamená, že při podepisování '1', je nutný pouze jeden podpis.
inPersonSigning	inPersonSigning		boolean	Pokud je pravda, příjemce dostane automaticky otevírané okno, kde musí ručně nakreslit podpis.
folderName	folderName		string	Pokud je uvedeno, vytvoří se obálka obsahující všechny dokumenty v documentDataArray. (Vyžaduje se, pokud je odesláno více než jeden dokument.
callbackUrl	callbackUrl		string	Žádost POST, včetně dokumentu, se odešle na tuto adresu URL, když se vytvoří nový podpis nebo když příjemce odmítne dokument. V případě selhání je zaveden mechanismus opakování, který zajistí opakování požadavku.
Returnurl	returnUrl		string	Odkaz na tlačítko Pro návrat po podepsání dokumentu
returnBtnText	returnBtnText		string	Text tlačítka pro vrácení po podepsání dokumentu
data	data	True	string	Data dokumentu (PDF nebo DOCX) ve formátu base64.
mimetype	mimetype		string	Typ MIME s kódováním base64 data PDF nebo DOCX, který se vyžaduje v případě, že dokument není pdf
fileName	fileName	True	string	Název souboru
jmenovka	label		string	Vlastní popisek, který lze odeslat k uspořádání dokumentů.
stránka	page	True	integer	Číslo stránky, na které je pole zapnuté, přičemž první stránka je 0.
Pagewidth	pageWidth		integer	Jakákoli celočíselná hodnota popisující šířku stránky. Čím větší je číslo, tím lepší je přesnost při umístění pole do mezery x y. Na stránce A4 máme jako výchozí hodnotu 478.
Pageheight	pageHeight		integer	Jakákoli celočíselná hodnota popisující výšku stránky Čím větší je číslo, tím lepší je přesnost při umístění pole do mezery x y. Na stránce A4 máme jako výchozí hodnotu 676.
x	x	True	float	Představuje vodorovnou pozici pole jako procento šířky stránky. Původ (0,0) je v levém horním rohu stránky. Hodnota 0,1 znamená, že pole je umístěné na 10% šířky stránky zleva.
y	y	True	float	Představuje svislou pozici pole jako procento výšky stránky. Původ (0,0) je v levém horním rohu stránky. Hodnota 0,1 znamená, že pole je umístěné na 10% výšky stránky shora.
width	width	True	float	Šířka rámečku na základě rozměrů stránky, podobně jako souřadnice x a y. Jedná se o plovoucí hodnotu představující procento stránkyWidth.
height	height	True	float	Výška pole na základě rozměrů stránky, podobně jako souřadnice x a y. Jedná se o plovoucí hodnotu představující procento stránkyHeight.
id	id	True	string	Jedinečné ID pro toto pole vygenerované jakýmkoli způsobem.
jmenovka	label		string	Zástupný text, například název pole, například Datum narození.
value	value		string	Výchozí hodnota pole Může mít hodnotu null. Pokud je pole typu chooseBox, může být hodnota null nebo jeden z řetězců definovaných v možnostech.
jen pro čtení	readonly		boolean	Pokud je nastavena hodnota true, pozvaná osoba nemůže změnit hodnotu tohoto pole.
required	required		boolean	Pokud je nastavená hodnota true, pozvaná osoba nemůže dokument podepsat bez vyplnění tohoto pole.
typ	type	True	string
víceřádkový	multiline		boolean	Určuje, jestli je povoleno více řádků.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
seskupit	group		number	Každému přepínači lze přiřadit skupinu.
signatureTypes	signatureTypes		array of string	Typypodpisch Možnosti: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId je volitelné pole, které slouží k křížovému odkazu na nahraný dokument. V případě zadání vám umožní přiřadit k dokumentu vlastní identifikátor odkazu, který se vrátí jako součást objektu dokumentu v budoucích odpovědích rozhraní API. To může být užitečné pro sledování nebo uspořádání dokumentů externím systémem nebo pracovním postupem.
jazyk	language		string	Jazyk dokumentu.
folderId	folderId		string	ID složky, do které mají být dokumenty vloženy. To je možné pouze v případě, že nejsou definovány parametry inviteData i folderName.
isAttachment	isAttachment		boolean	isAttachment není v tomto případě potřeba.
useFastlane	useFastlane		boolean	Pokud je nastaveno na true podepisující osoby, dostane v e-mailu s pozvánkou odkaz Fastlane.
fastlaneProfileId	fastlaneProfileId		uuid	Zadejte profil Fastlane, který se má použít s tímto dokumentem. (hodnota useFastlane musí být nastavena na hodnotu true).

Návraty

Tělo

EnvelopeResponse

Získání dokumentu

ID operace:

GetDocument

Získejte podepsaný dokument jako binární řetězec nebo řetězec kódovaný kódem Base64.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID člena	memberId	True	string	ID člena
Stáhnout formát	format		string	Určuje formát odpovědi. Slouží pdf pro binární PDF a base64 pro odpověď zakódovanou v base64. Příklad base64 odpovědi: json { "base64": "JVBERi0xLjQKJe..." }

Návraty

Name	Cesta	Typ	Description
base64	base64	string	Obsah PDF s kódováním Base64

Získání stavu žádosti

ID operace:

GetSignatureStatus

Získejte stav žádosti o podpis. Vrátí objekt JSON dokumentu nebo chybu. Parametr je vrácen žádostí o příspěvek v dokumentu a je přidružený k e-mailu odesílatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID člena	memberId	True	string	ID člena

Návraty

Tělo

DocumentStatusForFlow

Definice

DeleteDocumentResponse

Odstranit odpověď na dokument

string

ObálkaResponse

Name	Cesta	Typ	Description
folderId	folderId	string
folderName	folderName	string
dokumenty	documents	array of object
id	documents.id	string
název	documents.name	string
jazyk	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Datum a čas zahájení odesílání připomenutí (řetězec data a času ISO 8601)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Datum a čas vytvoření dokumentu (řetězec data a času ISO 8601)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
stav	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
splatné datum	documents.dueDate	date-time	Termín splnění dokumentu (řetězec data a času ISO 8601)
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
members	documents.members	array of MemberResponseSchema
člen	documents.member	MemberResponseSchema
Krabice	documents.boxes	array of DocumentResponseBox	Pole formuláře v odpovědi dokumentu. Vrátí se pouze v případě, že dokument obsahuje pole formuláře. Pokud je dokument podepsaný, vrátí se pole s vyplněnými hodnotami.
opožděný	documents.overdue	boolean

DocumentResponseBox

Name	Cesta	Typ	Description
id	id	string
typ	type	string
value	value	string	Hodnota pole pole. Může to být řetězec (včetně prázdného řetězce), logické hodnoty nebo hodnoty null v závislosti na typu pole.
jmenovka	label	string

MemberResponseSchema

Name	Cesta	Typ	Description
id	id	string
documentId	documentId	string
e-mail	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Datum a čas vytvoření členu (řetězec data a času ISO 8601)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Datum a čas odeslání oznámení o odstranění (řetězec data a času ISO 8601)
ManuallyLastEmailSent	manuallyLastEmailSent	date-time	Datum a čas odeslání posledního ručního e-mailu (řetězec data a času ISO 8601)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Data pozice podpisu s dalšími poli specifickými pro odpověď. Pole cardStyle, pageWidth a pageHeight jsou volitelná a nemusí být k dispozici ve všech odpovědích rozhraní API.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Datum a čas, kdy člen odmítl (řetězec data a času ISO 8601)
signingOrder	signingOrder	number
Ondemand	onDemand	string
recipientId	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
role	role	string
approvedAt	approvedAt	date-time	Datum a čas schválení člena (řetězec data a času ISO 8601)
konfigurace ověření	verificationConfig
phoneNumber	phoneNumber	string
podpisy	signatures	array of string
SignedAt	signedAt	date-time	Datum a čas podepsání člena (řetězec data a času ISO 8601)

MemberSignaturePositionResponse

Data pozice podpisu s dalšími poli specifickými pro odpověď. Pole cardStyle, pageWidth a pageHeight jsou volitelná a nemusí být k dispozici ve všech odpovědích rozhraní API.

Name	Cesta	Typ	Description
Položky		SignaturePositionResponse	Data pozice podpisu s dalšími poli specifickými pro odpověď. Pole cardStyle, pageWidth a pageHeight jsou volitelná a nemusí být k dispozici ve všech odpovědích rozhraní API.

SignaturePositionResponse

Data pozice podpisu s dalšími poli specifickými pro odpověď. Pole cardStyle, pageWidth a pageHeight jsou volitelná a nemusí být k dispozici ve všech odpovědích rozhraní API.

Name	Cesta	Typ	Description
stránka	page	integer	Číslo stránky začínající číslem 0.
x	x	number	x souřadnice levé pozice podpisů
y	y	number	souřadnice levého horního okraje podpisů
width	width	number	Šířka podpisu.
height	height	number	Výška podpisu.
cardStyle	cardStyle	string	Vizuální styl karty podpisu. Toto pole je volitelné a nemusí být vráceno ve všech odpovědích.
Pagewidth	pageWidth	number	Šířka stránky v pixelech Toto pole je volitelné a nemusí být vráceno ve všech odpovědích.
Pageheight	pageHeight	number	Výška stránky v pixelech Toto pole je volitelné a nemusí být vráceno ve všech odpovědích.

DocumentStatusForFlow

Name	Cesta	Typ	Description
id	id	string
název	name	string
stav	state	string	Aktuální stav dokumentu. Možné hodnoty jsou: koncept, čekající, odmítnutý, dokončený, příloha, ručněPending, ručně Dokončeno
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean