sproof Sign (előzetes verzió)

Biztonságos aláírás használatával automatizálhatja a PDF- és DOCX-dokumentumok biztonságos elektronikus aláírási munkafolyamatait. A szervezetek létrehozhatnak egy- vagy többdokumentumos aláírási kérelmeket, hozzárendelhetnek címzetteket és aláíró szerepköröket, nyomon követhetik az állapotot, letölthetik a befejezett PDF-fájlokat, és törölhetik a dokumentumokat. Egy sproof Sign-fiókra, a kiválasztott műveleteket és aláírástípusokat támogató csomagra, valamint érvényes API-jogkivonatra van szükség.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Regions
Copilot Studio	prémium	Az összes Power Automate régió kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Apps	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate régió kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Kapcsolat
Name	API-támogatás
URL	https://sproof.com
Email	support@sproof.com

Összekötő metaadatai
Publisher	sproof GmbH
Webhely	https://www.sproof.com/en/sign/
Adatvédelmi irányelvek	https://www.sproof.com/en/privacy-policy-app/
Categories	Termelékenység; Tartalom és fájlok

sproof Sign

Áttekintés

A sproof Sign lehetővé teszi, hogy a szervezetek automatizálják a PDF- és DOCX-dokumentumok elektronikus aláírási munkafolyamatait. Az összekötő létrehozhat egydokumentumos aláírási kéréseket vagy többdokumentumos borítékokat, hozzárendelhet címzetteket és aláíró szerepköröket, lekérheti a kérések állapotát, letöltheti a kész dokumentumokat, és törölheti a dokumentumokat.

Prerequisites

Az összekötő használatához a következőkre van szüksége:

• Egy sproof Sign-fiók.
• Egy sproof Sign csomag API-hozzáféréssel és a szükséges műveletek és aláírástípusok támogatásával.
• Érvényes, sproof Sign API-jogkivonat.

Authentication

Az összekötő API-jogkivonatos hitelesítést használ. Hozzon létre egy kapcsolatot a fiókjához társított érvényes, sproof Sign API-jogkivonat megadásával. Tartsa biztonságosan a jogkivonatot, és cserélje le, ha visszavonják vagy újragenerálják.

Támogatott műveletek

• Aláírási kérelem létrehozása – Egy dokumentumra vagy egy több dokumentumot tartalmazó borítékra vonatkozó kérést hoz létre. A címzettek, az aláírási szerepkörök, az aláírási sorrend, az aláírási pozíciók és más meghívási beállítások konfigurálhatók.
• Aláírási kérelem létrehozása helyőrzők használatával – Kérést hoz létre egy feltöltött dokumentumban tárolt helyőrzőkkel. A címzettek adatai és aláírási pozíciói ezekből a helyőrzőkből származnak.
• Kérés állapotának lekérése – Lekéri egy aláírási kérelem aktuális állapotát és aláírási állapotát a tagazonosítójával.
• Dokumentum lekérése – Letölt egy dokumentumot bináris PDF-fájlként vagy Base64-kódolású PDF-fájlként.
• Dokumentum törlése – Törli a dokumentumot, vagy eltávolítja egy tag hozzáférését a megadott tagazonosítótól, a tag szerepkörétől és attól függően, hogy a dokumentum egy borítékhoz tartozik-e.

Ismert korlátozások és követelmények

• A bemeneti dokumentumokat Base64-kódolású PDF- vagy DOCX-tartalomként kell megadni.
• A boríték legfeljebb 25 dokumentumot tartalmazhat.
• Több dokumentum beküldésekor borítéknévre van szükség.
• A helyőrzőalapú kérelmekhez megfelelően formázott helyőrzőkre van szükség a feltöltött dokumentumban.
• Helyőrzőalapú kérések esetén a címzettek és az aláírási pozíciók nem manuálisan, hanem a dokumentumból származnak.
• Az elérhető műveletek, aláírástípusok és szolgáltatók a csatlakoztatott, sproof Sign-fióktól és -csomagtól függenek.
• A dokumentumtörlési viselkedés attól függ, hogy a megadott tagazonosító a feladóhoz vagy a címzetthez tartozik-e, és hogy a dokumentum egy boríték része-e.

Támogatás

Összekötő vagy API-támogatás esetén lépjen kapcsolatba a következővel support@sproof.com:

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Name	Típus	Description	Required
kód	securestring	"token" für diese API	True

Műveletek

Aláírási kérelem létrehozása	Ez az új létrehozási aláírási kérelem. Amellett, hogy egyetlen dokumentummeghívót hoz létre, mostantól támogatja a borítékok létrehozását és több dokumentum egyidejű feltöltését a meghívók küldésekor.
Aláírási kérelem létrehozása helyőrzőkkel	Aláírási kérelmet hoz létre a feltöltött dokumentumban tárolt helyőrzőkkel. A rendszer kinyeri a címzetteket és az aláírási pozíciókat a dokumentumból.
Dokumentum lekérése	Aláírt dokumentum lekérése bináris vagy Base64 kódolású sztringként.
Dokumentum törlése	Törli a dokumentumot, vagy eltávolítja a tag hozzáférését attól függően, hogy a megadott memberId dokumentum a feladóhoz vagy a címzetthez tartozik-e, és hogy a dokumentum egy boríték része-e. Dokumentumok borítékban A lekérdezési paraméternek all nincs hatása a borítékban lévő dokumentumokra. A feladóval memberId: A rendszer egyetlen dokumentumot töröl a feladó és az összes címzett számára. A dokumentum el lesz távolítva a borítékból. A címzettnél memberId: A borítékban lévő összes dokumentumot eltávolítjuk a címzett számára. A címzett a címzett számára törölt összes dokumentumon láthatóként declined van megjelölve. A dokumentumok továbbra is elérhetők maradnak a dokumentum többi tagja számára. Önálló dokumentumok A feladóval memberId és all=truea következővel: A dokumentum törlődik a feladó és az összes címzett számára. A feladóval memberId és all=falsea következővel: A dokumentum csak a feladó számára törlődik. A dokumentum továbbra is elérhető marad a dokumentum többi címzettje számára. A címzettnél memberId: A címzett meg van jelölve declined a dokumentumban. A dokumentum a dokumentum többi tagja számára is elérhető marad.
Kérés állapotának lekérése	Az aláírási kérelem állapotának lekérése. JSON-objektumot vagy hibát ad vissza. A paramétert a post request on document adja vissza, és a feladók e-mailjeihez van társítva.

Aláírási kérelem létrehozása

Műveletazonosító:

CreateSignatureRequest

Ez az új létrehozási aláírási kérelem. Amellett, hogy egyetlen dokumentummeghívót hoz létre, mostantól támogatja a borítékok létrehozását és több dokumentum egyidejű feltöltését a meghívók küldésekor.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
e-mail	email	True	string	A feladó e-mail címe. A terv egyik tagjához kell tartoznia.
firstName	firstName	True	string	A feladó utóneve.
lastName	lastName		string	A feladó vezetékneve.
szerepkör	role		string	A feladó szerepe az összes dokumentumban.
e-mail	email		string	A címzett e-mail címe.
firstName	firstName		string	A címzett utóneve.
lastName	lastName		string	A címzett vezetékneve.
doNotSendEmails	doNotSendEmails		boolean	Ha nincs true beállítva e-mail küldése a címzettnek.
customId	customId		string	Csak akkor használható, ha a címzett e-mail-címe ismeretlen a meghíváskor. Ez csak akkor működik, ha meghívja a címzetteket (nem az útvonalak előkészítésére), és a fastlane-t szeretné használni. Ez customId lehetővé teszi, hogy a meghívó elküldése előtt előre létrehozhassa a címzett egyedi aláíró hivatkozását. Legalább 70 karakterből álló egyedi alfanumerikus sztringnek kell lennie. Megjegyzés: A customId csak a címzett dokumentumra mutató hivatkozásának létrehozásához használható. A tagazonosító helyett más kérésekhez nem használható. Az URL-konstrukció részleteiért lásd : Dokumentum megnyitása egyéni azonosítóval
useFastlane	useFastlane		boolean	Ha az aláíróra van true állítva, a meghívó e-mailben kap egy Fastlane-hivatkozást.
phoneNumber	phoneNumber		string	A címzett telefonszáma. Ez az SMS-ellenőrzéshez használatos. (pl. +43 699 1234 1234).
privateMessage	privateMessage		string	Egy privát üzenet az adott címzett számára.
inPersonMode	inPersonMode		boolean	Ha ez a lehetőség engedélyezve van, az aláírási kérelem címzettjének személyesen kell aláírnia a dokumentumot, és nem kell e-mailt küldenie. Ez a mód csak SES-aláírástípussal érhető el
signatureTypes	signatureTypes		array of string	A címzett számára engedélyezett aláírástípusok. Beállítások: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"
címke	tag		string	Ez a címke határozza meg az aláírási folyamathoz használni kívánt identitásszolgáltatót. Válasszon a támogatott szolgáltatók előre definiált készletéből. Megjegyzés1: Egyes szolgáltatók csak bizonyos signatureType-okhoz érhetők el, például onetimeqes"signatureType" : ["qualifiedPlusIdent"] Megjegyzés2: Alapértelmezett szolgáltatóként való használat sproof-qualified esetén a címzettnek aktív, aktív User+ licenccel rendelkező, de megbízható fiókkal kell rendelkeznie.
canChange	canChange		boolean	Logikai érték, amely jelzi, hogy a meghívott címzettnek képesnek kell-e lennie az aláírás-szolgáltató módosítására
country	country		string	Az alapértelmezett ország, ha az üres az összesre van állítva, a rendszer hibát ad vissza azzal, hogy mely országok érhetők el a kiválasztott szolgáltatócímkéhez
esedékesség dátuma	dueDate		YYYY-MM-DD	A dokumentum aláírásának dátuma. Ez a határidő megjelenik a címzettnek a meghívó e-mailben, és az irányítópult Dokumentum részletei szakaszában is látható. Ez az aláírási folyamat befejezésének határideje.
emlékeztetőInterval	reminderInterval		number	Az emlékeztető e-mailek között eltelt napok számát adja meg.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Az emlékeztetők elküldésének dátuma
inviteLanguage	inviteLanguage		string	Megadja azoknak a névtelen felhasználóknak küldött e-mailek nyelvét, akik nem rendelkeznek fiókkal. Azoknak a felhasználóknak, akiknek van fiókja, a profiljukban kiválasztott nyelvet fogja használni a rendszer.
üzenet	message		string	Az e-mail címzettjeinek küldött egyéni üzenet.
tárgy	subject		string	A címzetteknek küldött e-mail tárgysora.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Ha igaz értékre van állítva, a rendszer mellékletként küldi el a pdf-fájlt a dokumentum összes címzettjének (ha kisebb, mint 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Ha ez a beállítás engedélyezve van, az aláírási kérelem címzettje csak a dokumentum aláírására vagy elutasítására lesz korlátozva, és nem tud eltávolodni az oldaltól.
allowForwarding	allowForwarding		boolean	A meghívás továbbításának engedélyezése.
collabSigningMode	collabSigningMode		object	Egy objektum, amelyben az egyes kulcsok egy aláíró kereket jelölnek, és annak megfelelő értéke azt jelzi, hogy engedélyezve van-e az együttműködésen alapuló aláírás az adott fordulóban. Ha az érték igaz, csak egy aláírás szükséges a megadott aláírási kör befejezéséhez, és folytassa a következő fordulóval. Például{ '1': true } azt jelenti, hogy az "1" kör aláírásakor csak egy aláírásra van szükség.
usePlaceholders	usePlaceholders		boolean	Ha igaz, a dokumentumban tárolt szöveghelyőrzők/űrlapmezők a címzettek meghívására használhatók.
inPersonSigning	inPersonSigning		boolean	Ha igaz, a címzett egy előugró ablakba kerül, ahol manuálisan kell aláírást rajzolnia
folderName	folderName		string	Ha meg van adva, létrejön egy boríték, amely tartalmazza a documentDataArray összes dokumentumát. (Több dokumentum elküldése esetén kötelező)
visszahívási URL-cím	callbackUrl		string	Ha új aláírást hoz létre, vagy ha egy címzett elutasítja a dokumentumot, egy POST kérést küld erre az URL-címre, beleértve a dokumentumot is. Hiba esetén egy újrapróbálkozásos mechanizmus van érvényben, amely biztosítja a kérés újrapróbálkozását.
returnUrl	returnUrl		string	A visszaküldés gomb hivatkozása dokumentum aláírása után
returnBtnText	returnBtnText		string	A visszaküldés gomb szövege a dokumentum aláírása után
adat	data	True	string	A dokumentum (PDF vagy DOCX) adatai base64 formátumban.
mimetype	mimetype		string	A BASE64 kódolású adat PDF-fájljának vagy DOCX-típusának MIME-típusa kötelező, ha a dokumentum nem pdf
fileName	fileName	True	string	A fájl neve
címke	label		string	A dokumentumok rendszerezéséhez küldhető egyéni címke.
oldal	page	True	integer	Azon oldal száma, amelyen a mező be van kapcsolva, és az első oldal 0.
pageWidth	pageWidth		integer	Az oldal szélességét leíró egész számérték. Minél nagyobb a szám, annál jobb a pontosság, ha a dobozt x y térben helyezi el. Egy A4-lapon a 478 az alapértelmezett érték.
pageHeight	pageHeight		integer	Az oldalmagasságot leíró egész számértékek. Minél nagyobb a szám, annál jobb a pontosság, ha a dobozt x y térben helyezi el. Egy A4-lapon a 676 az alapértelmezett érték.
x	x	True	float	A mező vízszintes pozícióját jelöli az oldalszélesség százalékában. A forrás (0,0) a lap bal felső részén található. A 0,1 érték azt jelenti, hogy a doboz balról az oldalszélesség 10% van elhelyezve.
y	y	True	float	A mező függőleges pozícióját jelöli az oldalmagasság százalékában. A forrás (0,0) a lap bal felső részén található. A 0,1 érték azt jelenti, hogy a doboz az oldalmagasság 10% van fentről.
szélesség	width	True	float	A mező szélessége az oldalméretek alapján, az x és az y koordinátákhoz hasonlóan. Ez egy lebegőpontos érték, amely a pageWidth százalékát jelöli.
magasság	height	True	float	A doboz magassága az oldalméretek alapján, az x és az y koordinátákhoz hasonlóan. Ez egy lebegőpontos érték, amely a pageHeight százalékát jelöli.
azonosító	id	True	string	A mező egyedi azonosítója, amely tetszőleges módon jön létre.
címke	label		string	Helyőrző szöveg, például a mező neve, például "Születési dátum".
value	value		string	A mező alapértelmezett értéke. Null érték is lehet. Ha a mező típusa "chooseBox", akkor az érték lehet null értékű, vagy a beállításokban definiált karakterláncok egyike.
readonly	readonly		boolean	Ha igaz értékre van állítva, a meghívott személy nem módosíthatja ennek a mezőnek az értékét.
required	required		boolean	Ha igaz értékre van állítva, a meghívott személy a mező kitöltése nélkül nem tudja aláírni a dokumentumot.
típus	type	True	string
többsoros	multiline		boolean	Több sor is engedélyezve van-e.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
csoport	group		number	Minden egyes választómező hozzárendelhető egy csoporthoz.
signatureTypes	signatureTypes		array of string	A címzett számára engedélyezett aláírástípusok felülírhatók a címzett aláírástípusokkal. Beállítások: "advanced", "advancedPlus", "qualified", "simple", 'qualifiedPlusIdent]
refId	refId		string	A refId egy nem kötelező mező, amely a feltöltött dokumentum kereszthivatkozására szolgál. Ha meg van adva, egyéni hivatkozásazonosítót rendelhet a dokumentumhoz, amelyet a rendszer a dokumentumobjektum részeként ad vissza a jövőbeli API-válaszokban. Ez hasznos lehet dokumentumok külső rendszer vagy munkafolyamat általi nyomon követéséhez vagy rendszerezéséhez.
nyelv	language		string	A dokumentum nyelve.
folderId	folderId		string	Annak a mappának az azonosítója, amelybe a dokumentumokat be kell szúrni. Ez csak akkor lehetséges, ha az inviteData és a folderName is nincs meghatározva.
isAttachment	isAttachment		boolean	ebben az esetben nincs szükség az isattachmentre.
Címzett adatai	recipientDetails	True	object	Címzett adatai a címzett e-mail-címe alapján. Példa: {"":mail@test.com{"role":"signer","signaturePositions":[{"page":0,"x":0,55,"y":0,80,"width":0.25,"height":0.08}]}}}.
useFastlane	useFastlane		boolean	Ha az aláíróra van true állítva, a meghívó e-mailben kap egy Fastlane-hivatkozást.
fastlaneProfileId	fastlaneProfileId		uuid	Adja meg a dokumentumhoz használni kívánt Fastlane-profilt. (a useFastlane értéket igaz értékre kell állítani).

Válaszok

Törzs

EnvelopeResponse

Aláírási kérelem létrehozása helyőrzőkkel

Műveletazonosító:

CreateSignatureRequestUsingPlaceholders

Aláírási kérelmet hoz létre a feltöltött dokumentumban tárolt helyőrzőkkel. A rendszer kinyeri a címzetteket és az aláírási pozíciókat a dokumentumból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
e-mail	email	True	string	A feladó e-mail címe. A terv egyik tagjához kell tartoznia.
firstName	firstName	True	string	A feladó utóneve.
lastName	lastName		string	A feladó vezetékneve.
szerepkör	role		string	A feladó szerepe az összes dokumentumban.
e-mail	email		string	A címzett e-mail címe.
firstName	firstName		string	A címzett utóneve.
lastName	lastName		string	A címzett vezetékneve.
doNotSendEmails	doNotSendEmails		boolean	Ha nincs true beállítva e-mail küldése a címzettnek.
customId	customId		string	Csak akkor használható, ha a címzett e-mail-címe ismeretlen a meghíváskor. Ez csak akkor működik, ha meghívja a címzetteket (nem az útvonalak előkészítésére), és a fastlane-t szeretné használni. Ez customId lehetővé teszi, hogy a meghívó elküldése előtt előre létrehozhassa a címzett egyedi aláíró hivatkozását. Legalább 70 karakterből álló egyedi alfanumerikus sztringnek kell lennie. Megjegyzés: A customId csak a címzett dokumentumra mutató hivatkozásának létrehozásához használható. A tagazonosító helyett más kérésekhez nem használható. Az URL-konstrukció részleteiért lásd : Dokumentum megnyitása egyéni azonosítóval
useFastlane	useFastlane		boolean	Ha az aláíróra van true állítva, a meghívó e-mailben kap egy Fastlane-hivatkozást.
phoneNumber	phoneNumber		string	A címzett telefonszáma. Ez az SMS-ellenőrzéshez használatos. (pl. +43 699 1234 1234).
privateMessage	privateMessage		string	Egy privát üzenet az adott címzett számára.
inPersonMode	inPersonMode		boolean	Ha ez a lehetőség engedélyezve van, az aláírási kérelem címzettjének személyesen kell aláírnia a dokumentumot, és nem kell e-mailt küldenie. Ez a mód csak SES-aláírástípussal érhető el
signatureTypes	signatureTypes		array of string	A címzett számára engedélyezett aláírástípusok. Beállítások: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"
címke	tag		string	Ez a címke határozza meg az aláírási folyamathoz használni kívánt identitásszolgáltatót. Válasszon a támogatott szolgáltatók előre definiált készletéből. Megjegyzés1: Egyes szolgáltatók csak bizonyos signatureType-okhoz érhetők el, például onetimeqes"signatureType" : ["qualifiedPlusIdent"] Megjegyzés2: Alapértelmezett szolgáltatóként való használat sproof-qualified esetén a címzettnek aktív, aktív User+ licenccel rendelkező, de megbízható fiókkal kell rendelkeznie.
canChange	canChange		boolean	Logikai érték, amely jelzi, hogy a meghívott címzettnek képesnek kell-e lennie az aláírás-szolgáltató módosítására
country	country		string	Az alapértelmezett ország, ha az üres az összesre van állítva, a rendszer hibát ad vissza azzal, hogy mely országok érhetők el a kiválasztott szolgáltatócímkéhez
esedékesség dátuma	dueDate		YYYY-MM-DD	A dokumentum aláírásának dátuma. Ez a határidő megjelenik a címzettnek a meghívó e-mailben, és az irányítópult Dokumentum részletei szakaszában is látható. Ez az aláírási folyamat befejezésének határideje.
emlékeztetőInterval	reminderInterval		number	Az emlékeztető e-mailek között eltelt napok számát adja meg.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Az emlékeztetők elküldésének dátuma
inviteLanguage	inviteLanguage		string	Megadja azoknak a névtelen felhasználóknak küldött e-mailek nyelvét, akik nem rendelkeznek fiókkal. Azoknak a felhasználóknak, akiknek van fiókja, a profiljukban kiválasztott nyelvet fogja használni a rendszer.
üzenet	message		string	Az e-mail címzettjeinek küldött egyéni üzenet.
tárgy	subject		string	A címzetteknek küldött e-mail tárgysora.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Ha igaz értékre van állítva, a rendszer mellékletként küldi el a pdf-fájlt a dokumentum összes címzettjének (ha kisebb, mint 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Ha ez a beállítás engedélyezve van, az aláírási kérelem címzettje csak a dokumentum aláírására vagy elutasítására lesz korlátozva, és nem tud eltávolodni az oldaltól.
allowForwarding	allowForwarding		boolean	A meghívás továbbításának engedélyezése.
collabSigningMode	collabSigningMode		object	Egy objektum, amelyben az egyes kulcsok egy aláíró kereket jelölnek, és annak megfelelő értéke azt jelzi, hogy engedélyezve van-e az együttműködésen alapuló aláírás az adott fordulóban. Ha az érték igaz, csak egy aláírás szükséges a megadott aláírási kör befejezéséhez, és folytassa a következő fordulóval. Például { '1': true } azt jelenti, hogy az "1" kör aláírásakor csak egy aláírásra van szükség.
inPersonSigning	inPersonSigning		boolean	Ha igaz, a címzett egy előugró ablakba kerül, ahol manuálisan kell aláírást rajzolnia
folderName	folderName		string	Ha meg van adva, létrejön egy boríték, amely tartalmazza a documentDataArray összes dokumentumát. (Több dokumentum elküldése esetén kötelező)
visszahívási URL-cím	callbackUrl		string	Ha új aláírást hoz létre, vagy ha egy címzett elutasítja a dokumentumot, egy POST kérést küld erre az URL-címre, beleértve a dokumentumot is. Hiba esetén egy újrapróbálkozásos mechanizmus van érvényben, amely biztosítja a kérés újrapróbálkozását.
returnUrl	returnUrl		string	A visszaküldés gomb hivatkozása dokumentum aláírása után
returnBtnText	returnBtnText		string	A visszaküldés gomb szövege a dokumentum aláírása után
adat	data	True	string	A dokumentum (PDF vagy DOCX) adatai base64 formátumban.
mimetype	mimetype		string	A BASE64 kódolású adat PDF-fájljának vagy DOCX-típusának MIME-típusa kötelező, ha a dokumentum nem pdf
fileName	fileName	True	string	A fájl neve
címke	label		string	A dokumentumok rendszerezéséhez küldhető egyéni címke.
oldal	page	True	integer	Azon oldal száma, amelyen a mező be van kapcsolva, és az első oldal 0.
pageWidth	pageWidth		integer	Az oldal szélességét leíró egész számérték. Minél nagyobb a szám, annál jobb a pontosság, ha a dobozt x y térben helyezi el. Egy A4-lapon a 478 az alapértelmezett érték.
pageHeight	pageHeight		integer	Az oldalmagasságot leíró egész számértékek. Minél nagyobb a szám, annál jobb a pontosság, ha a dobozt x y térben helyezi el. Egy A4-lapon a 676 az alapértelmezett érték.
x	x	True	float	A mező vízszintes pozícióját jelöli az oldalszélesség százalékában. A forrás (0,0) a lap bal felső részén található. A 0,1 érték azt jelenti, hogy a doboz balról az oldalszélesség 10% van elhelyezve.
y	y	True	float	A mező függőleges pozícióját jelöli az oldalmagasság százalékában. A forrás (0,0) a lap bal felső részén található. A 0,1 érték azt jelenti, hogy a doboz az oldalmagasság 10% van fentről.
szélesség	width	True	float	A mező szélessége az oldalméretek alapján, az x és az y koordinátákhoz hasonlóan. Ez egy lebegőpontos érték, amely a pageWidth százalékát jelöli.
magasság	height	True	float	A doboz magassága az oldalméretek alapján, az x és az y koordinátákhoz hasonlóan. Ez egy lebegőpontos érték, amely a pageHeight százalékát jelöli.
azonosító	id	True	string	A mező egyedi azonosítója, amely tetszőleges módon jön létre.
címke	label		string	Helyőrző szöveg, például a mező neve, például "Születési dátum".
value	value		string	A mező alapértelmezett értéke. Null érték is lehet. Ha a mező típusa "chooseBox", akkor az érték lehet null értékű, vagy a beállításokban definiált karakterláncok egyike.
readonly	readonly		boolean	Ha igaz értékre van állítva, a meghívott személy nem módosíthatja ennek a mezőnek az értékét.
required	required		boolean	Ha igaz értékre van állítva, a meghívott személy a mező kitöltése nélkül nem tudja aláírni a dokumentumot.
típus	type	True	string
többsoros	multiline		boolean	Több sor is engedélyezve van-e.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
csoport	group		number	Minden egyes választómező hozzárendelhető egy csoporthoz.
signatureTypes	signatureTypes		array of string	A címzett számára engedélyezett aláírástípusok felülírhatók a címzett aláírástípusokkal. Beállítások: "advanced", "advancedPlus", "qualified", "simple", 'qualifiedPlusIdent]
refId	refId		string	A refId egy nem kötelező mező, amely a feltöltött dokumentum kereszthivatkozására szolgál. Ha meg van adva, egyéni hivatkozásazonosítót rendelhet a dokumentumhoz, amelyet a rendszer a dokumentumobjektum részeként ad vissza a jövőbeli API-válaszokban. Ez hasznos lehet dokumentumok külső rendszer vagy munkafolyamat általi nyomon követéséhez vagy rendszerezéséhez.
nyelv	language		string	A dokumentum nyelve.
folderId	folderId		string	Annak a mappának az azonosítója, amelybe a dokumentumokat be kell szúrni. Ez csak akkor lehetséges, ha az inviteData és a folderName is nincs meghatározva.
isAttachment	isAttachment		boolean	ebben az esetben nincs szükség az isattachmentre.
useFastlane	useFastlane		boolean	Ha az aláíróra van true állítva, a meghívó e-mailben kap egy Fastlane-hivatkozást.
fastlaneProfileId	fastlaneProfileId		uuid	Adja meg a dokumentumhoz használni kívánt Fastlane-profilt. (a useFastlane értéket igaz értékre kell állítani).

Válaszok

Törzs

EnvelopeResponse

Dokumentum lekérése

Műveletazonosító:

GetDocument

Aláírt dokumentum lekérése bináris vagy Base64 kódolású sztringként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tagazonosító	memberId	True	string	Tagazonosító
Formátum letöltése	format		string	Megadja a válaszformátumot. Bináris PDF-fájlhoz és base64 Base64-kódolású válaszhoz használhatópdf. Példa base64 válasz: json { "base64": "JVBERi0xLjQKJe..." }

Válaszok

Name	Elérési út	Típus	Description
base64	base64	string	Base64 kódolású PDF-tartalom

Dokumentum törlése

Műveletazonosító:

DeleteDocument

Törli a dokumentumot, vagy eltávolítja a tag hozzáférését attól függően, hogy a megadott memberId dokumentum a feladóhoz vagy a címzetthez tartozik-e, és hogy a dokumentum egy boríték része-e.

Dokumentumok borítékban

A lekérdezési paraméternek all nincs hatása a borítékban lévő dokumentumokra.

A feladóval memberId:

• A rendszer egyetlen dokumentumot töröl a feladó és az összes címzett számára.
• A dokumentum el lesz távolítva a borítékból.

A címzettnél memberId:

• A borítékban lévő összes dokumentumot eltávolítjuk a címzett számára.
• A címzett a címzett számára törölt összes dokumentumon láthatóként declined van megjelölve.
• A dokumentumok továbbra is elérhetők maradnak a dokumentum többi tagja számára.

Önálló dokumentumok

A feladóval memberId és all=truea következővel:

• A dokumentum törlődik a feladó és az összes címzett számára.

A feladóval memberId és all=falsea következővel:

• A dokumentum csak a feladó számára törlődik.
• A dokumentum továbbra is elérhető marad a dokumentum többi címzettje számára.

A címzettnél memberId:

• A címzett meg van jelölve declined a dokumentumban.
• A dokumentum a dokumentum többi tagja számára is elérhető marad.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tagazonosító	memberId	True	string	Tagazonosító
Törlés az összes címzett esetében	all		boolean	Csak egyetlen dokumentum esetében releváns, ha a megadott memberId a feladóhoz tartozik. Ha be van trueállítva, a rendszer törli a dokumentumot a feladó és az összes címzett számára. Ha be falsevan állítva, a dokumentum csak a feladó számára törlődik, és a többi címzett számára is elérhető marad. Ez a paraméter nincs hatással a borítékban lévő dokumentumokra (alapértelmezett = true), vagy ha a megadott memberId címzetthez tartozik.

Válaszok

response

DeleteDocumentResponse

Kérés állapotának lekérése

Műveletazonosító:

GetSignatureStatus

Az aláírási kérelem állapotának lekérése. JSON-objektumot vagy hibát ad vissza. A paramétert a post request on document adja vissza, és a feladók e-mailjeihez van társítva.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tagazonosító	memberId	True	string	Tagazonosító

Válaszok

Törzs

DocumentStatusForFlow

Definíciók

DeleteDocumentResponse

Dokumentumválasz törlése

string

Borítékresponse

Name	Elérési út	Típus	Description
folderId	folderId	string
folderName	folderName	string
dokumentumok	documents	array of object
azonosító	documents.id	string
név	documents.name	string
nyelv	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Emlékeztetők küldésének dátuma és időpontja (ISO 8601 datetime string)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
emlékeztetőInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	A dokumentum létrehozásának dátuma és időpontja (ISO 8601 datetime string)
visszahívási URL-cím	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
state	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
esedékesség dátuma	documents.dueDate	date-time	A dokumentum határideje (ISO 8601 datetime karakterlánc)
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
tag	documents.member	MemberResponseSchema
Dobozok	documents.boxes	array of DocumentResponseBox	Űrlapmező a dokumentum válaszában. Ez csak akkor jelenik meg, ha a dokumentum űrlapmezőket tartalmaz. Ha a dokumentum aláírása megtörtént, a dokumentum a kitöltött értékeket tartalmazó mezőket adja vissza.
esedékes	documents.overdue	boolean

DocumentResponseBox

Name	Elérési út	Típus	Description
azonosító	id	string
típus	type	string
value	value	string	A mező értéke. A mező típusától függően lehet sztring (beleértve az üres sztringet is), logikai vagy null érték.
címke	label	string

MemberResponseSchema

Name	Elérési út	Típus	Description
azonosító	id	string
documentId	documentId	string
e-mail	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	A tag létrehozásának dátuma és időpontja (ISO 8601 datetime karakterlánc)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Törlési értesítés elküldésének dátuma és időpontja (ISO 8601 datetime string)
manuálisanLastEmailSent	manuallyLastEmailSent	date-time	Az utolsó manuális e-mail elküldésének dátuma és időpontja (ISO 8601 datetime string)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Aláírás pozícióadatok további válaszspecifikus mezőkkel. A cardStyle, a pageWidth és a pageHeight mezők nem kötelezőek, és előfordulhat, hogy nem minden API-válaszban szerepelnek.
doNotSendEmails	doNotSendEmails	boolean
elutasítottAt	declinedAt	date-time	A tag elutasításának dátuma és időpontja (ISO 8601 datetime karakterlánc)
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
szerepkör	role	string
approvedAt	approvedAt	date-time	A tag jóváhagyásának dátuma és időpontja (ISO 8601 datetime sztring)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
Aláírások	signatures	array of string
signedAt	signedAt	date-time	A tag aláírásának dátuma és időpontja (ISO 8601 datetime sztring)

MemberSignaturePositionResponse

Aláírás pozícióadatok további válaszspecifikus mezőkkel. A cardStyle, a pageWidth és a pageHeight mezők nem kötelezőek, és előfordulhat, hogy nem minden API-válaszban szerepelnek.

Name	Elérési út	Típus	Description
Elemek		SignaturePositionResponse	Aláírás pozícióadatok további válaszspecifikus mezőkkel. A cardStyle, a pageWidth és a pageHeight mezők nem kötelezőek, és előfordulhat, hogy nem minden API-válaszban szerepelnek.

SignaturePositionResponse

Aláírás pozícióadatok további válaszspecifikus mezőkkel. A cardStyle, a pageWidth és a pageHeight mezők nem kötelezőek, és előfordulhat, hogy nem minden API-válaszban szerepelnek.

Name	Elérési út	Típus	Description
oldal	page	integer	Oldalszám, 0-val kezdődően.
x	x	number	x az aláírások bal felső pozíciójának koordinátája
y	y	number	az aláírások bal felső pozíciójának koordinátája
szélesség	width	number	Az aláírás szélessége.
magasság	height	number	Az aláírás magassága.
cardStyle	cardStyle	string	Az aláírási kártya vizuális stílusa. Ez a mező nem kötelező, és nem minden válaszban adható vissza.
pageWidth	pageWidth	number	Az oldal szélessége képpontban. Ez a mező nem kötelező, és nem minden válaszban adható vissza.
pageHeight	pageHeight	number	Az oldal magassága képpontban. Ez a mező nem kötelező, és nem minden válaszban adható vissza.

DocumentStatusForFlow

Name	Elérési út	Típus	Description
azonosító	id	string
név	name	string
state	state	string	A dokumentum aktuális állapota. Lehetséges értékek: piszkozat, függőben, elutasítva, befejezve, melléklet, manuálispending, manuális kiegészítés
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean