Legalesign (előzetes verzió)

A megfelelőségközpontú jogi és üzemeltetési csapatok számára tervezett Legalesign összekötője összekapcsolja a Microsoft power platformot a Legalesign eSignature szolgáltatással a dokumentum- és címzett-munkafolyamatok aktiválásához, emlékeztetők küldéséhez, PDF-fájlok beolvasásához és a felületi űrlapadatokhoz. Az API-használathoz jóváhagyott aktív Legalesign-előfizetés szükséges.

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

Service	Class	Régiók
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 Alkalmazások	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)

Érintkezés
Név	API-támogatás
URL	https://legalesign.com/contact/
Email	sales@legalesign.com

Összekötő metaadatai
Kiadó	Legalesign
További információ a Legalesignről	https://docs.microsoft.com/connectors/legalesign
Webhely	https://legalesign.com
Adatvédelem	https://legalesign.com/opn/privacy/
Kategóriák	Tartalom és fájlok; Termelékenység

Legalesign eSignature REST Connector

A Legalesign REST API működteti az eSignature munkafolyamatokat. Ez az összekötő teljes API-hozzáférést és valós idejű triggereket biztosít, így zökkenőmentes integrációt tesz lehetővé a Microsoft Power Automate-tel, a Logic Appsszel és a kapcsolódó platformokkal.

Előfeltételek

Első lépésként egy Legalesign-fiókra és EGY API-kulcsra van szüksége: 1. Regisztráljon egy ingyenes próbaverzióra. 2. Hozzon létre egy csoportot (egy egyéni környezetet – például egyet a fejlesztéshez, a másikat pedig az éles környezethez). 3. Kérjen egy API-kulcsot egy támogatási jegy létrehozásával. Adja meg a használati esetet, a vállalatot és a szerepkört, hogy a támogatási szolgálat ellenőrizni tudja az ön identitását. 4. Az ellenőrzés után jelentkezzen be az API-irányítópultra a kulcs lekéréséhez.

Telepítés

Az új fiókok a következő korlátozásokkal indulnak tesztkörnyezeti módban: • A dokumentumok csak az API-irányítópulton konfigurált tesztelési e-mail-címekre küldhetők. • A kérelmek szabályozása percenként 100-ra van szabályozva.

Ha készen áll az élő adásra, hozzon létre egy támogatási jegyet , amellyel átállíthatja fiókját a tesztkörnyezetről az éles környezetre. Ezen a ponton a korlátozások megszűnnek. A részletekért tekintse meg az üzembe helyezési útmutatót .

Kiváltó okok

Az összekötő két valós idejű eseményindítót támogat:

• Dokumentumesemények (például létrehozva, elutasítva, aláírva, végleges PDF létrehozva)
• Címzett események (pl. befejezve, elutasítva, megnyitott e-mail, visszapattant, emlékeztetők küldése)

Az összes dokumentumot vagy címzettet megkaphatja, csoport- vagy eseménytípus szerint szűrve. Az összes társított Legalesign-webhook kezelhető és figyelhető az API-irányítópulton.

Operations

A Legalesign REST API-műveletek támogatottak. A leggyakoribbak közé tartozik az aláírt PDF letöltése, a sablonok, a dokumentumok, a címzettek és a mezők elhelyezése. A teljes specifikációt a teljes API-dokumentációban találja.

A Legalesignben a feltöltött dokumentumokat "sablonnak" nevezzük. Amikor egy sablont egy vagy több címzettnek küldenek, az "dokumentum" lesz. Általában feltölt egy sablont, visszaállítja annak azonosítóját, majd elküldi azt egy vagy több címzettnek.

Gyakori műveletek a következők:

Sablonok

• Create PDF template - sablon feltöltése (bármilyen fájltípus, például PDF, Word vagy kép).
• Get PDF embeddable link - egy egyszer használható hivatkozás a sablonszerkesztő felhasználónak való megjelenítéséhez

Documents

• Location to download PDF - egy aláírt dokumentum PDF-bináris fájlját adja vissza
• Create signing document - dokumentum küldése (sablon és címzettek kiválasztása)
• Void/archive signing document - dokumentum aláírásának leállítása
• Permanently delete signing document - dokumentum eltávolítása örökre

Címzettek (aláírók)

• Send signer reminder email - emlékezteti a címzettet a dokumentum kiegészítésére
• Get signer rejection reason - ha a dokumentumot elutasítják, nézze meg, miért

Mező elhelyezése

A Legalesign speciális űrlaprendszerrel rendelkezik mezőkkel. Ha rendelkezik aláíróval, akkor minden aláírónak rendelkeznie kell legalább egy aláírási mezővel.

A sablonban négyféleképpen definiálhat mezőket:

1. Pdf feltöltése beágyazott mezőkkel (a Legalesign által automatikusan konvertálva).
2. Legalesign szöveges címkék használata.
3. X/y koordináták definiálása.
4. Használja a Legalesign űrlapszerkesztőt (a beágyazási hivatkozáson vagy a webalkalmazáson keresztül).

Kattintson ide az útmutatóért

Lekérdezések és támogatás

További támogatásért vagy lekérdezésekhez jelentkezzen be Legalesign-fiókjába, és hozzon létre egy támogatási jegyet.

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.

Név	Típus	Description	Kötelező
API kulcs	securestring	Az api api_key	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

A dokumentumnapló letöltése	CSAK a dokumentumnapló PDF-fájlja.
Beágyazható PDF-hivatkozás lekérése	Egy egyszer használható hivatkozást ad vissza a PDF-szerkesztő beágyazásához.
Csoport tagja	A csoport adott felhasználójának adatai.
Csoportok lekérése	Listázhatja azokat a csoportokat, amelyhez az API-felhasználó tartozik.
Csoportok tagjai	A csoportok összes tagjának listája.
Címzett elutasítási okának lekérése	Visszaadja az aláíró által a dokumentum elutasításának okát.
Címzett emlékeztető e-mail küldése	Emlékeztető e-mail küldése a címzettnek.
Címzett hivatkozásának lekérése	Az aláíró oldalakra mutató címzettek számára használható hivatkozás.
Címzett lekérése	Az egyes címzettek állapotának és adatainak lekérése.
Címzett űrlapmezőinek lekérése	Egy adott címzett űrlapmezőit adja vissza.
Dokumentum küldése	Dokumentum elküldése aláírásra vagy jóváhagyásra.
Dokumentum lekérése	Adott dokumentumot ad vissza.
Dokumentum végleges törlése	Véglegesen törli az adatokat és fájlokat.
Dokumentum érvénytelenítése és archiválása	Beállít egy 40-as állapotú dokumentumot – eltávolítva – és archiválja azt.
Dokumentummezők lekérése	A dokumentum mezői.
Dokumentumok lekérése	Archiválatlan aláíró dokumentumok listázása.
Felhasználó lekérése	Felhasználói adatok lekérése.
Melléklet lekérése	Melléklet lekérése.
Melléklet törlése	Melléklet törlése.
Mellékletek lekérése	Mellékletek listázása.
PDF letöltése	Az aláíró dokumentum piszkozatának vagy végleges PDF-fájljának lekérése az állapotától függően. Vegye figyelembe, hogy 200 vagy 302 válasz lehetséges.
PDF-melléklet feltöltése	Pdf mentése címzett e-mailhez csatoláshoz.
PDF-sablon feltöltése	Töltsön fel egy pdf-dokumentumot, amelyet alá szeretne írni.
PDF-sablon lekérése	Adott PDF-sablon részletei
PDF-sablonok lekérése	PDF-sablonok listázása

A dokumentumnapló letöltése

Műveletazonosító:

GetDocumentAuditLog

CSAK a dokumentumnapló PDF-fájlja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító

Válaszok

response

file

Beágyazható PDF-hivatkozás lekérése

Műveletazonosító:

GetPdfTemplateEditLink

Egy egyszer használható hivatkozást ad vissza a PDF-szerkesztő beágyazásához.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Pdf-azonosító	pdfId	True	string	A feltöltött PDF-azonosító beállítása.
Mezőlista elrejtése a renderelt oldalról	hide_sender_fields		boolean	Mezőlista elrejtése a renderelt oldalról.
Hexa kód, kivéve a háttérszín kivonatszimbólumát	css_body_backgroundcolor		string	A háttérszín módosításához használjon hexadecimális kódot, kivéve a kivonatszimbólumot.

Csoport tagja

Műveletazonosító:

GetMember

A csoport adott felhasználójának adatai.

Paraméterek

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

Válaszok

Törzs

MemberResponse

Csoportok lekérése

Műveletazonosító:

GetGroups

Listázhatja azokat a csoportokat, amelyhez az API-felhasználó tartozik.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Lekérdezés eltolása	offset		integer	Eltolás az adathalmaz kezdetétől. Használja a korlát lekérdezéssel az adathalmazon keresztüli iteráláshoz.
Lekérdezési korlát	limit		integer	A visszaadandó adathalmaz hossza. Az eltolásos lekérdezés használatával iterálhat az eredmények között.

Válaszok

Csoportok listája

Törzs

GroupListResponse

Csoportok tagjai

Műveletazonosító:

GetMembers

A csoportok összes tagjának listája.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	group		string	Szűrés adott csoport szerint
Lekérdezési korlát	limit		integer	Az eltolással az eredmények iterálásához használható.
Lekérdezés eltolása	offset		integer	Az eredmények iterálásának korlátozásával használható.

Válaszok

Törzs

MemberListResponse

Címzett elutasítási okának lekérése

Műveletazonosító:

GetSignerRejection

Visszaadja az aláíró által a dokumentum elutasításának okát.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Címzett azonosítója	recipientId	True	uuid	Címzett azonosítója

Válaszok

Name	Elérési út	Típus	Description
állapot	status	integer	Címzett szobrok.
ok	reason	string	Az ok elvetése.

Címzett emlékeztető e-mail küldése

Műveletazonosító:

PostSignerReminder

Emlékeztető e-mail küldése a címzettnek.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Címzett azonosítója	recipientId	True	uuid	Címzett azonosítója
SMS	text		string	Egyéni üzenet szövege

Címzett hivatkozásának lekérése

Műveletazonosító:

GetSignerLink

Az aláíró oldalakra mutató címzettek számára használható hivatkozás.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Címzett azonosítója	recipientId	True	uuid	Címzett azonosítója

Címzett lekérése

Műveletazonosító:

GetRecipient

Az egyes címzettek állapotának és adatainak lekérése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Címzett azonosítója	recipientId	True	uuid	Címzett azonosítója

Válaszok

Címzett adatai

Törzs

SignerResponse

Címzett űrlapmezőinek lekérése

Műveletazonosító:

GetSignerFields

Egy adott címzett űrlapmezőit adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Címzett azonosítója	recipientId	True	uuid	Címzett azonosítója

Válaszok

Name	Elérési út	Típus	Description
		array of object
címke	label	string	Címke
label_extra	label_extra	string	Extra címke
state	state	boolean	Állam
fieldorder	fieldorder	integer	Mezősorrend
value	value	string	Ha a mező aláíró fájl, ez az érték egy rövid élettartamú letöltési URL-cím lesz.

Dokumentum küldése

Műveletazonosító:

PostDocument

Dokumentum elküldése aláírásra vagy jóváhagyásra.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoport	group	True	string	Erőforrás uri csoportosítása
Név	name	True	string	A dokumentum nevének megadása
PDF-sablon	templatepdf	True	string	A feltöltendő PDF-fájl.
e-mail	email	True	email	Email
utónév	firstname	True	string	Keresztnév
vezetéknév	lastname	True	string	Vezetéknév
attachments	attachments		array of string	A melléklet erőforrás-uri-jainak listája.
Lejár	expires		date-time	ISO8601 formázott dátumidő, amely a feladó vagy az időzón TZ értékére van állítva, ha használják
üzenet	message		string	A csoport e-mail-sablonjának közepén megadott személyes üzenete a párt számára. Használja a sablont egy kivonatszimbólum által előre létrehozott mentett e-mail-sablon nevével. Ha egynél több azonos nevű sablon van, akkor a legutóbb módosított sablont választja ki.
utónév	firstname		string	Keresztnév
vezetéknév	lastname		string	Vezetéknév
e-mail	email	True	email	Email
include_link	include_link		boolean	Az aláíró oldalakra mutató hivatkozás belefoglalása, amely lehetővé teszi a véleményező aláírását
SMS (szöveges üzenet)	sms		string	Az SMS-ellenőrzés hozzáadásához használjon nemzetközi formátumszámot. Kötelező, ha egy tanú vagy egy tanúsító aláíró.
tárgy	subject		string	Kimenő e-mail tárgysora
timezone	timezone		string	Az aláíró TZ-jének érvényes TZ-nek kell lennie a timezoneenum szerint (a timezoneenum részleteiért lásd a Felhasználót). Ha az üres a feladó tz-ét használja.
Aláírás típusa	signature_type		integer	Használja a 4-et a végrehajtott PDF-tanúsítvány beszerzéséhez. Ajánlott. Alapértelmezés szerint 1 (sha256 kivonatot használ a dokumentum integritásához).
PDF hozzáfűzése	append_pdf		boolean	A Legalesign érvényesítési adatainak hozzáfűzése a végleges PDF-fájlhoz.
auto_archive	auto_archive		boolean	Nem sokkal az aláírás után küldje el az archívumba. A webalkalmazások zsúfoltságának megtartása
Legalesign e-mailek használata	do_email		boolean	A Legalesign e-mail használatával küldjön értesítési e-maileket. Ha a hamis letiltja az összes e-mailt.
Másolatot kap a befejezés után	cc_emails		string	Az aláírásról vagy elutasításról értesített e-mail-címek vessző által tagolt sztringje.
Üres feladómezők átalakítása első címzett mezőkké	convert_sender_to_signer		boolean	Ha bármelyik feladómező üres, konvertálja őket az első címzett mezőivé.
PDF-jelszó	pdf_password		string	Állítson be egy jelszót. Ascii kódolásra képesnek kell lennie, signature_type 4 értékre kell állítania, és ki kell választania egy pdf_password_type.
PDF-jelszó beállításai	pdf_password_type		integer	1 a jelszó tárolásához, 2 a rekordokból való törléshez a végleges aláíráskor.
pdftext	pdftext		object	Rendeljen értékeket a PDF-feladó mezőihez, használja a sablon mezőfeliratát vagy uuid azonosítóját objektumkulcsként. Tekintse meg a templatepdf/:id/fields/ mezőt, és szűrjön a element_type="admin" kifejezésre, és kérje le a megfelelő mezőket a címkéjükkel vagy uuidjukkal. Lásd még: strict_fields.
Átirányítási URL-cím	redirect		string	URL-cím az aláírónak az aláírás után (letöltési oldal helyett). Az URL-cím a következő azonosítóval és állapotinformációval rendelkező lekérdezési paramétereket tartalmazza: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Emlékeztető ütemezése	reminders		string	Ha az alapértelmezett emlékeztető ütemezését szeretné használni a csoportban (az alapértelmezett ütemezés beállításához nyissa meg a webalkalmazást)
Aláíró hivatkozások visszaküldése	return_signer_links		boolean	Dokumentumhivatkozásokat ad vissza az aláíróknak a válasz TÖRZSében.
szekvenálás küldése	signers_in_order		boolean	Értesítse az aláírókat a sorrendjükben. Ha hamis minden értesítést simulataneousous.
aláíró szöveg	signertext		object	Egyéni helyőrzők hozzáadása az aláíró mezőkhöz. Használjon mezőfeliratokat vagy uuid azonosítót kulcsként az objektumban (pdftext esetén). Lásd: templatepdf/:id/fields/, és szűrjön element_type = "text" értékre a megfelelő mezők címkékkel vagy uuid azonosítóval való lekéréséhez.
Mezőérvényesítés kényszerítése	strict_fields		boolean	A PDF-szöveg nem ellenőrzi a érvényesítést csendesen, igaz értékre állítva az ellenőrzést.
Az Ön referenciája	tag		string	Tag
Az Ön referenciája	tag1		string	Tag
Az Ön referenciája	tag2		string	Tag
felhasználó	user		string	Dokumentum hozzárendelése egy másik felhasználóhoz a csoportban.

Dokumentum lekérése

Műveletazonosító:

GetDocument

Adott dokumentumot ad vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító

Válaszok

Dokumentum részletei

Törzs

DocumentResponseDetail

Dokumentum végleges törlése

Műveletazonosító:

DeleteDocument

Véglegesen törli az adatokat és fájlokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító

Dokumentum érvénytelenítése és archiválása

Műveletazonosító:

UpdateArchiveDocument

Beállít egy 40-as állapotú dokumentumot – eltávolítva – és archiválja azt.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító
Értesítési e-mail küldése a címzettnek	email		string	Ha igaz vagy 1 értékre van állítva, a címzettek értesítést kapnak a dokumentum érvénytelenítéséről.

Dokumentummezők lekérése

Műveletazonosító:

GetDocumentFields

A dokumentum mezői.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító

Válaszok

Name	Elérési út	Típus	Description
		array of object	Dokumentummezők listája
element_type	element_type	string	Elem típusa
fieldorder	fieldorder	integer	Mezősorrend
címke	label	string	Címke
label_extra	label_extra	string	Extra címke
aláíró	signer	integer	Recipient
state	state	boolean
ellenőrzés	validation	integer	Érvényesítési azonosító
value	value	string	Érték

Dokumentumok lekérése

Műveletazonosító:

GetDocuments

Archiválatlan aláíró dokumentumok listázása.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	group	True	string	Szűrés adott csoport szerint, kötelező.
Archivált dokumentumok belefoglalása	archived		string	Az archivált állapot szűrése, az alapértelmezett érték nem archiválva, a paraméterben szereplő összes érték használatával kérdezheti le az összes dokumentumot.
Szűrés címzett e-mail alapján	email		string	Szűrés címzett e-mail alapján.
Lekérdezési korlát	limit		integer	A visszaadandó adathalmaz hossza. Az eltolásos lekérdezés használatával iterálhat az eredmények között.
Lekérdezés eltolása	offset		integer	Eltolás az adathalmaz kezdetétől. Használja a korlát lekérdezéssel az adathalmazon keresztüli iteráláshoz.
Szűrés dokumentumállapot szerint	status		integer	Szűrés a dokumentum állapotára.
Címzettek eltávolítása a válaszból	nosigners		string	Adjon hozzá 1 értéket a címzettek adatainak gyorsabb lekérdezéshez való eltávolításához.
Szűrés a dátum után létrehozva	created_gt		date-time	Szűrjön az adott idő után létrehozott dokumentumokra.
Szűrés módosításra ezen dátum után	modified_gt		date-time	Szűrjön az adott idő után módosított dokumentumokra.

Válaszok

Dokumentumlista

Törzs

DocumentListResponse

Felhasználó lekérése

Műveletazonosító:

GetUser

Felhasználói adatok lekérése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Felhasználóazonosító	userId	True	uuid	Felhasználóazonosító

Válaszok

A felhasználó adatai.

Törzs

UserDetailResponse

Melléklet lekérése

Műveletazonosító:

GetAttachment

Melléklet lekérése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Melléklet azonosítója	attachId	True	uuid	Melléklet azonosítója

Válaszok

Elem csatolása.

Törzs

AttachmentResponse

Melléklet törlése

Műveletazonosító:

DeleteAttachment

Melléklet törlése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Melléklet azonosítója	attachId	True	uuid	Csatolás azonosítója

Mellékletek lekérése

Műveletazonosító:

GetAttachments

Mellékletek listázása.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	group		string	Szűrés adott csoport szerint.
Lekérdezési korlát	limit		integer	Az eltolással az eredmények iterálásához használható.
Lekérdezés eltolása	offset		integer	Az eredmények iterálásának korlátozásával használható.

Válaszok

Mellékletlista

Törzs

AttachmentListResponse

PDF letöltése

Műveletazonosító:

GetDocumentPdf

Az aláíró dokumentum piszkozatának vagy végleges PDF-fájljának lekérése az állapotától függően. Vegye figyelembe, hogy 200 vagy 302 válasz lehetséges.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dokumentumazonosító	docId	True	uuid	Dokumentumazonosító

Válaszok

response

file

PDF-melléklet feltöltése

Műveletazonosító:

PostAttachment

Pdf mentése címzett e-mailhez csatoláshoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
csoport	group	True	string	Erőforrás uri csoportosítása
pdf_file	pdf_file	True	byte	Base64 kódolású PDF-fájladatok, a maximális méret egy csoportbeállítás, alapértelmezés szerint 5 MB.
filename	filename	True	string	Egyszerű alfanumerikus névvégző .pdf
felhasználó	user		string	Hozzárendelés másik felhasználóhoz.
leírás	description		string

PDF-sablon feltöltése

Műveletazonosító:

PostPdfTemplate

Töltsön fel egy pdf-dokumentumot, amelyet alá szeretne írni.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Archiválás küldéskor	archive_upon_send		boolean	Állítsa be a true (igaz) értéket, ha ez a feltöltés csak egyszer használatos lesz.
Csoport	group	True	string	Adja meg azt a csoportot, ahol ezt használni fogja.
PDF-fájl	pdf_file	True	byte	Base64 kódolású PDF-fájladatok.
Folyamatcímkék	process_tags		boolean	Ha a fájl szöveges címkéket tartalmaz, akkor konvertálja őket mezőkké.
Cím	title		string	Nevezze el ezt a rekordot, ha nem használja a fájlnevet.
User	user		string	Rendelje hozzá a csoporttaghoz, ha nem API-felhasználó.

PDF-sablon lekérése

Műveletazonosító:

GetPdfTemplate

Adott PDF-sablon részletei

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Feltöltött PDF-azonosító	pdfId	True	uuid	Feltöltött PDF-azonosító

Válaszok

Sablon részletei

Törzs

TemplatePdfResponse

PDF-sablonok lekérése

Műveletazonosító:

GetPdfTemplates

PDF-sablonok listázása

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoportazonosító	group		string	Lehet teljes resource_uri vagy csak azonosító.
Lekérdezési korlát	limit		integer	A visszaadandó adathalmaz hossza. Az eltolásos lekérdezés használatával iterálhat az eredmények között.
Lekérdezés eltolása	offset		integer	Eltolás az adathalmaz kezdetétől. Használja a korlát lekérdezéssel az adathalmazon keresztüli iteráláshoz.

Válaszok

Sablonlisták

Törzs

TemplatePdfListResponse

Triggerek

Címzett eseménye	Eseményindító címzett esemény bekövetkezésekor
Dokumentumesemény	Eseményindító egy dokumentumeseményhez

Címzett eseménye

Műveletazonosító:

RecipientTrigger

Eseményindító címzett esemény bekövetkezésekor

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
eventFilter	eventFilter	True	string	Eseményszűrő
csoport	group		string	Csoportszűrő

Válaszok

Name	Elérési út	Típus	Description
verzió	version	string	verzió
objektum	object	string	Objektum
címke	data.tag	string	Tag
címke1	data.tag1	string	Címke1
címke2	data.tag2	string	Címke2
univerzálisan egyedi azonosító (UUID)	data.uuid	string	Címzett azonosítója
e-mail	data.email	string	Email
csoport	data.group	string	Csoport
sorrend	data.order	integer	Order
állapot	data.status	integer	Státusz
dokumentum	data.document	string	Dokumentum
vezetéknév	data.lastname	string	Vezetéknév
roleText	data.roleText	string	Szerepkörszöveg
utónév	data.firstname	string	Keresztnév
állapotSzöveg	data.statusText	string	Állapotszöveg
emailBounce	data.emailBounce	integer	Az e-mail visszapattant
resourceUri	data.resourceUri	string	Címzett erőforrás uri-ja
documentName	data.documentName	string	Dokumentum neve
rejectReason	data.rejectReason	string	Elutasítás oka
groupResourceUri	data.groupResourceUri	string	Erőforrás uri csoportosítása
emailBounceMessage	data.emailBounceMessage	string	E-mail visszapattanó üzenet
documentResourceUri	data.documentResourceUri	string	Dokumentumerőforrás URI-ja
created	created	integer	Létrehozott
azonosító	id	string	azonosító
esemény	event	string	Event

Dokumentumesemény

Műveletazonosító:

DocumentTrigger

Eseményindító egy dokumentumeseményhez

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
eventFilter	eventFilter	True	string	Eseményszűrő
csoport	group		string	Csoportszűrő

Válaszok

Name	Elérési út	Típus	Description
verzió	version	string	verzió
objektum	object	string	Objektum
címke1	data.tag1	string	Tag
recipients	data.recipients	array of object	Címzettek
univerzálisan egyedi azonosító (UUID)	data.recipients.uuid	string	Címzett azonosítója
e-mail	data.recipients.email	string	Címzett e-mail címe
sorrend	data.recipients.order	integer	Címzett rendelési száma
állapot	data.recipients.status	integer	Címzett állapota
vezetéknév	data.recipients.lastname	string	Címzett vezetékneve
roleText	data.recipients.roleText	string	Címzett szerepkörszövege
utónév	data.recipients.firstname	string	Címzett utóneve
állapotSzöveg	data.recipients.statusText	string	Címzett állapotszövege
resourceUri	data.recipients.resourceUri	string	Címzett erőforrás uri-ja
rejectReason	data.recipients.rejectReason	string	rejectReason
groupResourceUri	data.groupResourceUri	string	Erőforrás uri csoportosítása
állapotSzöveg	data.statusText	string	Dokumentumállapot szövege
név	data.name	string	Dokumentum neve
címke	data.tag	string	Tag
resourceUri	data.resourceUri	string	Erőforrás-uri
univerzálisan egyedi azonosító (UUID)	data.uuid	string	Dokumentumazonosító
címke2	data.tag2	string	Címke2
csoport	data.group	string	Csoport
állapot	data.status	integer	Dokumentum állapota
created	created	integer	Létrehozott
azonosító	id	string	Tett
esemény	event	string	Event

Definíciók

PermissionsEnum

Engedélybeállítások

Engedélybeállítások

integer

ListMeta

Metaadatok a listáról.

Name	Elérési út	Típus	Description
limit	limit	integer	Objektumok maximális száma.
next	next	string	A következő objektumkészlet URL-címe.
eltolás	offset	integer	Az eredményhalmaz kezdetétől kezdődő elemek száma.
előző	previous	string	Az előző objektumkészlet URL-címe.
total_count	total_count	integer	Objektumok teljes száma.

GroupListResponse

Csoportok listája

Name	Elérési út	Típus	Description
meta	meta	ListMeta	Metaadatok a listáról.
objektum	objects	array of object
created	objects.created	date-time	Létrehozott
is_active	objects.is_active	boolean	Active
módosított	objects.modified	date-time	Módosított
név	objects.name	string	Név
public_name	objects.public_name	string	Nyilvános név
resource_uri	objects.resource_uri	string	Erőforrás-uri
meztelen csiga	objects.slug	string	Egyedi név
felhasználó	objects.user	string	Létrehozói erőforrás uri-ja
xframe_allow	objects.xframe_allow	boolean	Beágyazási aláírás engedélyezése
xframe_allow_pdf_edit	objects.xframe_allow_pdf_edit	boolean	Beágyazás szerkesztésének engedélyezése

TemplatePdfListResponse

Sablonlisták

Name	Elérési út	Típus	Description
meta	meta	ListMeta	Metaadatok a listáról.
objektum	objects	array of TemplatePdfResponse

TemplatePdfResponse

Sablon részletei

Name	Elérési út	Típus	Description
created	created	date-time	Létrehozott
csoport	group	string	Csoport uri-ja
módosított	modified	date-time	Módosított
Felek	parties	string	JSON-sztringelt dokumentumpartik tömbje.
page_count	page_count	integer	Oldalszám
resource_uri	resource_uri	string	Erőforrás-uri
signer_count	signer_count	integer	Aláírók száma
title	title	string	Cím
felhasználó	user	string	A létrehozó erőforrás-uri-ja
univerzálisan egyedi azonosító (UUID)	uuid	uuid	Pdf-azonosító
érvényes	valid	boolean	Elküldhető (ha a mezők nem érvényesítik).

DocumentListResponse

Dokumentumlista

Name	Elérési út	Típus	Description
meta	meta	ListMeta	Metaadatok a listáról.
objektum	objects	array of object	Documents
Archivált	objects.archived	boolean	Archivált
auto_archive	objects.auto_archive	boolean	Archiválás küldés után.
cc_emails	objects.cc_emails	string	Vesszővel tagolt lista e-maileket kap a másolatot kap a befejezés után.
created	objects.created	date-time	Létrehozott
do_email	objects.do_email	boolean	Használjon Legalesign e-maileket.
download_final	objects.download_final	boolean	Készen áll a letöltésre a befejezés után.
csoport	objects.group	string	Erőforrás-uri csoportosítása.
módosított	objects.modified	date-time	Módosított
név	objects.name	string	Dokumentum neve
pdftext	objects.pdftext	string	Feladó mezőértékek
átirányít	objects.redirect	string	A címzett átirányításának URL-címe aláírás után
resource_uri	objects.resource_uri	string	Erőforrás-uri
return_signer_links	objects.return_signer_links	boolean	Címzetthivatkozások hozzáadása válaszhoz
Aláírói	objects.signers	array of array	Beágyazott tömbök aláíró adataival
items	objects.signers	array of	Mindig tartalmazza [aláíró uri, utónév, vezetéknév, e-mail, SMS-szám, has_fields, állapot, aláíró sorrend (0 indexelt)]
signers_in_order	objects.signers_in_order	integer	E-mail címzettek simulataneous or szekvenciálisan
állapot	objects.status	DocumentStatusEnum	Dokumentumállapot-beállítások: 10 – Kezdeti állapot, az aláírók állapotának ellenőrzése az elküldött/nem küldött üzenetek esetében 20 – Mezők befejezve 30 – Aláírt 40 – Eltávolítva (aláírás előtt) 50 – Elutasítva
címke	objects.tag	string	Dokumentum címkézése
címke1	objects.tag1	string	Dokumentum címkézése
címke2	objects.tag2	string	Dokumentum címkézése
sablon	objects.template	string	Sablonerőforrás URI használata esetén
templatepdf	objects.templatepdf	string	PDF-sablon erőforrás-uri-ja
SMS	objects.text	string	Aláíráshoz használt szöveg
felhasználó	objects.user	string	Alkotói uri
univerzálisan egyedi azonosító (UUID)	objects.uuid	uuid	Dokumentumazonosító

DocumentStatusEnum

Dokumentumállapot-beállítások:

• 10 – Kezdeti állapot, az aláírók állapotának ellenőrzése az elküldött/nem küldött üzenetek esetében
• 20 – Mezők befejezve
• 30 – Aláírt
• 40 – Eltávolítva (aláírás előtt)
• 50 – Elutasítva

Dokumentumállapot-beállítások:

• 10 – Kezdeti állapot, az aláírók állapotának ellenőrzése az elküldött/nem küldött üzenetek esetében
• 20 – Mezők befejezve
• 30 – Aláírt
• 40 – Eltávolítva (aláírás előtt)
• 50 – Elutasítva

integer

SignerResponse

Címzett adatai

Name	Elérési út	Típus	Description
dokumentum	document	string	Dokumentum
e-mail	email	string	Címzett e-mail címe
keresztnév	first_name	string	Címzett utóneve
vezetéknév	last_name	string	Címzett vezetékneve
has_fields	has_fields	boolean	A címzett mezői
sorrend	order	integer	Címzett rendelése
resource_uri	resource_uri	string	Címzett erőforrás uri-ja
állapot	status	SignerStatusEnum	Aláíró állapotbeállításai: 4 – nem kívánt 5 – elküldésre ütemezve 10 – elküldve 15 – megnyitott e-mail 20 - meglátogatva 30 – a mezők készek 35 - mezők kész ex signature 39 - várakozás a tanú befejezésére 40 – aláírt 50 – letöltve 60 – elutasítva

SignerStatusEnum

Aláíró állapotbeállításai:

• 4 – nem kívánt
• 5 – elküldésre ütemezve
• 10 – elküldve
• 15 – megnyitott e-mail
• 20 - meglátogatva
• 30 – a mezők készek
• 35 - mezők kész ex signature
• 39 - várakozás a tanú befejezésére
• 40 – aláírt
• 50 – letöltve
• 60 – elutasítva

Aláíró állapotbeállításai:

• 4 – nem kívánt
• 5 – elküldésre ütemezve
• 10 – elküldve
• 15 – megnyitott e-mail
• 20 - meglátogatva
• 30 – a mezők készek
• 35 - mezők kész ex signature
• 39 - várakozás a tanú befejezésére
• 40 – aláírt
• 50 – letöltve
• 60 – elutasítva

integer

DocumentResponseDetail

Dokumentum részletei

Name	Elérési út	Típus	Description
Archivált	archived	boolean	Archiválva
auto_archive	auto_archive	boolean	Dokumentumarchívum küldése aláírás után.
cc_emails	cc_emails	string	Ki lesz másolatot kap a feladóval az e-mail-értesítésben aláíráskor
created	created	date-time	Létrehozott
do_email	do_email	boolean	Legalesign e-mailek használata
download_final	download_final	boolean	A végleges PDF letölthető
élőláb	footer	string	HTML-dokumentumok – élőláb szövegének használata esetén
footer_height	footer_height	integer	HTMl-dokumentumok – px magasságú lábléc használata esetén
csoport	group	string	Csoport erőforrás-uri-ja
has_fields	has_fields	boolean	A dokumentum mezői
hash_value	hash_value	string	SHA256 ellenőrzőösszeg a végleges dokumentumból, ezzel ellenőrizheti a pdf végleges letöltését
fejléc	header	string	HTML-dokumentumok – az élőfej szövegének használata esetén
header_height	header_height	integer	HTMl-dokumentumok – Az élőfej px magasságának használata esetén
módosított	modified	date-time	Módosított
név	name	string	Dokumentum neve
pdf_password	pdf_password	string	PDF-jelszó
pdf_password_type	pdf_password_type	string	Ha a pdf-jelszó megőrzve van
pdftext	pdftext	string	Ennek figyelmen kívül hagyása
átirányít	redirect	string	A címzett átirányításának URL-címe aláírás után
resource_uri	resource_uri	string	Erőforrás-uri
return_signer_links	return_signer_links	boolean	Hagyd figyelmen kívül
sign_mouse	sign_mouse	boolean	semmibe vesz
sign_time	sign_time	date-time	Aláírási idő
sign_type	sign_type	boolean	örökölt
sign_upload	sign_upload	boolean	örökölt
signature_placement	signature_placement	integer	örökölt
signature_type	signature_type	integer	örökölt – mindig 4
Aláírói	signers	array of array	Beágyazott tömbök aláíró adataival
items	signers	array of	Mindig tartalmazza [aláíró uri, utónév, vezetéknév, e-mail, SMS-szám, has_fields, állapot, aláíró sorrend (0 indexelt)]
signer_objects	signer_objects	array of object	Címzettek listája
e-mail	signer_objects.email	string	Email
utónév	signer_objects.firstname	string	Keresztnév
vezetéknév	signer_objects.lastname	string	Vezetéknév
Telefon	signer_objects.tel	string	Tel szám
sorrend	signer_objects.order	integer	Aláírási rendelés
resource_uri	signer_objects.resource_uri	string	Erőforrás-uri
szerepkör	signer_objects.role	string	Role
állapot	signer_objects.status	integer	Címzett állapotkódja
univerzálisan egyedi azonosító (UUID)	signer_objects.uuid	string	Címzett azonosítója
signers_in_order	signers_in_order	boolean	E-mail címzettek simulataneous or szekvenciálisan
állapot	status	DocumentStatusEnum	Dokumentumállapot-beállítások: 10 – Kezdeti állapot, az aláírók állapotának ellenőrzése az elküldött/nem küldött üzenetek esetében 20 – Mezők befejezve 30 – Aláírt 40 – Eltávolítva (aláírás előtt) 50 – Elutasítva
címke	tag	string	Az Ön referenciája
címke1	tag1	string	Az Ön referenciája
címke2	tag2	string	Az Ön referenciája
sablon	template	string	Szövegsablon erőforrás-uri-ja, ha használják
templatepdf	templatepdf	string	A pdf-sablon erőforrás-uri-ja, ha használják
SMS	text	string	Szöveg a dokumentumhoz, ha használják
felhasználó	user	string	Felhasználói erőforrás URI-ja.
univerzálisan egyedi azonosító (UUID)	uuid	uuid	Dokumentumazonosító

MemberListResponse

Name	Elérési út	Típus	Description
meta	meta	ListMeta	Metaadatok a listáról.
objektum	objects	array of MemberResponse

MemberResponse

Name	Elérési út	Típus	Description
created	created	date-time	Létrehozott
csoport	group	string	Erőforrás uri csoportosítása
módosított	modified	date-time	Módosított
engedély	permission	PermissionsEnum	Engedélybeállítások
resource_uri	resource_uri	string	Erőforrás-uri
felhasználó	user	string	Felhasználói erőforrás URI-ja.

AttachmentResponse

Elem csatolása.

Name	Elérési út	Típus	Description
created	created	date-time	Létrehozott
leírás	description	string	Description
filename	filename	string	Fájlnév
csoport	group	string	Csoport
resource_uri	resource_uri	string	Erőforrás-uri csatolása
felhasználó	user	string	Felhasználói erőforrás uri-ja
univerzálisan egyedi azonosító (UUID)	uuid	uuid	Csatolás azonosítója

AttachmentListResponse

Mellékletlista

Name	Elérési út	Típus	Description
meta	meta	ListMeta	Metaadatok a listáról.
objektum	objects	array of object	Szövetszegély
created	objects.created	date-time	Létrehozott
leírás	objects.description	string	Description
filename	objects.filename	string	Fájlnév
csoport	objects.group	string	Csoport
resource_uri	objects.resource_uri	string	Erőforrás-uri
felhasználó	objects.user	string	Felhasználói erőforrás uri-ja
univerzálisan egyedi azonosító (UUID)	objects.uuid	uuid	Csatolás azonosítója

UserDetailResponse

A felhasználó adatai.

Name	Elérési út	Típus	Description
date_joined	date_joined	date-time	Csatlakozás dátuma
e-mail	email	email	Email
keresztnév	first_name	string	Keresztnév
groups	groups	array of string	A felhasználó által csatlakozott csoportok listája.
last_login	last_login	date-time	Utolsó bejelentkezés
vezetéknév	last_name	string	Vezetéknév
resource_uri	resource_uri	string	Erőforrás-uri
timezone	timezone	string	Időzóna
felhasználónév	username	string	Felhasználónév

fájl

Ez a fájl alapszintű adattípusa.