Legalesign (Preview)

Je určená pro týmy pro právní a provozní týmy zaměřené na dodržování předpisů, konektor Legalesign propojí platformu Microsoft Power Platform s eSignature legalesignu, aby aktivovala pracovní postupy dokumentů a příjemců, odesílala připomenutí, načítá pdfky a data formulářů povrchu. Vyžaduje aktivní předplatné Legalesign schválené pro použití 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 s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora rozhraní API
URL	https://legalesign.com/contact/
Email	sales@legalesign.com

Metadata konektoru
Vydavatel	Legalesign
Další informace o legalesignu	https://docs.microsoft.com/connectors/legalesign
Internetová stránka	https://legalesign.com
Zásady ochrany osobních údajů	https://legalesign.com/opn/privacy/
Kategorie	Obsah a soubory; Produktivita

Konektor REST pro legalesign eSignature

Rozhraní REST API Legalesign využívá pracovní postupy eSignature. Tento konektor poskytuje úplný přístup k rozhraní API a triggery v reálném čase, což umožňuje bezproblémovou integraci s Microsoft Power Automate, Logic Apps a souvisejícími platformami.

Požadavky

Abyste mohli začít, potřebujete účet Legalesign a klíč rozhraní API: 1. Zaregistrujte se k bezplatné zkušební verzi. 2. Vytvořte skupinu (individuální prostředí – například pro vývoj a druhé pro produkční prostředí). 3. Vytvořte lístek podpory a požádejte o klíč rozhraní API. Uveďte svůj případ použití, společnost a roli, aby podpora vaši identitu ověřila. 4. Po ověření se přihlaste k řídicímu panelu rozhraní API a načtěte svůj klíč.

Nasazení

Nové účty se spouštějí v režimu sandboxu s následujícími omezeními: • Dokumenty se dají odeslat jenom na testovací e-mailové adresy, které nakonfigurujete na řídicím panelu rozhraní API. • Požadavky se omezují na 100 minut.

Až budete připravení pokračovat, vytvořte lístek podpory pro přepnutí účtu z sandboxu do produkčního prostředí. V tomto okamžiku budou omezení zrušena. Podrobnosti najdete v průvodci nasazením .

Triggers

Konektor podporuje dvě triggery v reálném čase:

• Události dokumentu (např. vytvořené, odmítnuté, podepsané, konečné vytvoření PDF)
• Události příjemců (např. dokončené, odmítnuté, otevřené e-maily, odražené, odeslaná připomenutí)

Můžete přijímat všechny dokumenty nebo příjemce filtru podle typu skupiny nebo události. Všechny přidružené webhooky Legalesign je možné spravovat a monitorovat na řídicím panelu rozhraní API.

Operations

Podporují se operace rozhraní REST API legalesignu. Mezi nejběžnější patří stažení podepsaného SOUBORU PDF, správa šablon, dokumentů, příjemců a umístění polí. Kompletní specifikaci najdete v úplné dokumentaci k rozhraní API .

V dokumentu Legalesign se nahraný dokument nazývá šablona. Když se šablona odešle jednomu nebo více příjemcům, stane se dokumentem. Šablonu obvykle nahrajete, obnovíte její identifikátor a pak ji pošlete jednomu nebo více příjemcům.

Mezi běžné operace patří:

Šablony

• Create PDF template - nahrajte šablonu (libovolný typ souboru, například PDF, Word nebo obrázek).
• Get PDF embeddable link – odkaz s jedním použitím k zobrazení editoru šablon pro uživatele

Documents

• Location to download PDF - vrátí binární soubor PDF podepsaného dokumentu.
• Create signing document – odeslání dokumentu (výběr šablony a příjemců)
• Void/archive signing document - zastavení podepsání dokumentu
• Permanently delete signing document - odebrat dokument navždy

Příjemci (podepisující osoby)

• Send signer reminder email - připomeňte příjemci, aby dokončil váš dokument.
• Get signer rejection reason - pokud je dokument odmítnut, podívejte se, proč

Umístění pole

Legalesign má rozšířený systém formulářů s poli. Pokud máte signatáře, musí mít každý signatář alespoň jedno pole podpisu.

Pole v šabloně můžete definovat čtyřmi způsoby:

1. Nahrajte SOUBOR PDF s vloženými poli (automaticky převedeno pomocí legalesignu).
2. Použijte textové značky Legalesign.
3. Definujte souřadnice x/y.
4. Použijte editor formulářů Legalesign (prostřednictvím odkazu pro vložení nebo webové aplikace).

Kliknutím sem zobrazíte průvodce.

Dotazy a podpora

Pokud potřebujete další podporu nebo dotazy, přihlaste se ke svému účtu Legalesign a vytvořte lístek podpory.

Vytvoření připojení

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

výchozí	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é
klíč API	securestring	Api_key pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Dokument void a archivu	Nastaví dokument se stavem 40 -removed- a archivuje ho.
Nahrát přílohu PDF	Uložte soubor PDF pro připojení k e-mailu příjemce.
Nahrát šablonu PDF	Nahrajte dokument PDF, který chcete odeslat, aby byl podepsán.
Odeslat dokument	Odešlete dokument k podpisu nebo schválení.
Odeslat e-mail s připomenutím příjemce	Pošlete příjemci e-mail s připomenutím.
Odstranění přílohy	Odstraňte přílohu.
Stažení protokolu auditování dokumentů	PDF pouze z protokolu auditlogu dokumentů.
Stáhnout PDF	V závislosti na jeho stavu získáte koncept nebo konečný PDF pro podpisový dokument. Všimněte si, že odpověď 200 nebo 302 je možná.
Trvale odstranit dokument	Trvale odstraní data a soubory.
Získat odkaz na příjemce	Jedním odkazem pro příjemce přejděte na podpisové stránky.
Získat přílohu	Získejte přílohu.
Získat vložený odkaz PDF	Vrátí odkaz s jedním použitím pro vložení editoru PDF.
Získání dokumentu	Vrátí konkrétní dokument.
Získání dokumentů	Vypisujte nearchivované podpisové dokumenty.
Získání důvodu zamítnutí příjemce	Vrátí podepisující důvod pro odmítnutí dokumentu.
Získání polí dokumentu	Pole z dokumentu.
Získání polí formuláře příjemce	Vrátí pole formuláře od konkrétního příjemce.
Získání příjemce	Získejte stav a podrobnosti o individuálním příjemci.
Získání příloh	Vypsat přílohy
Získání skupin	Uveďte skupiny, do nichž uživatel rozhraní API patří.
Získání uživatele	Získejte podrobnosti o uživateli.
Získání šablon PDF	Výpis šablon PDF
Získání šablony PDF	Podrobnosti o konkrétní šabloně PDF
Člen skupiny	Podrobnosti o konkrétním uživateli ve skupině
Členové skupin	Výpisy všech členů vašich skupin

Dokument void a archivu

ID operace:

UpdateArchiveDocument

Nastaví dokument se stavem 40 -removed- a archivuje ho.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu
E-mail s oznámením příjemcům	email		string	Pokud je nastavená hodnota true nebo 1, příjemci obdrží oznámení, že dokument je neplatný.

Nahrát přílohu PDF

ID operace:

PostAttachment

Uložte soubor PDF pro připojení k e-mailu příjemce.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
seskupit	group	True	string	Identifikátor URI prostředku skupiny
pdf_file	pdf_file	True	byte	Data souboru PDF s kódováním Base64, maximální velikost je nastavení skupiny, ve výchozím nastavení 5 MB.
filename	filename	True	string	Jednoduchý alfanumerický název končící .pdf
uživatel	user		string	Přiřaďte ho jinému uživateli.
popis	description		string

Nahrát šablonu PDF

ID operace:

PostPdfTemplate

Nahrajte dokument PDF, který chcete odeslat, aby byl podepsán.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Archivace po odeslání	archive_upon_send		boolean	Nastavte hodnotu true, pokud se toto nahrávání použije jenom pro jedno použití.
Skupina	group	True	string	Zadejte skupinu, do které se bude tato možnost používat.
PDF soubor	pdf_file	True	byte	Data souboru PDF s kódováním Base64
Značky procesů	process_tags		boolean	Pokud soubor obsahuje textové značky, převeďte je na pole.
Title	title		string	Tento záznam pojmenujte, pokud se nepoužívá, použije se název souboru.
Uživatel	user		string	Přiřaďte člena skupiny, pokud není uživatel rozhraní API.

Odeslat dokument

ID operace:

PostDocument

Odešlete dokument k podpisu nebo schválení.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Skupina	group	True	string	Identifikátor URI prostředku skupiny
Název	name	True	string	Zadejte název dokumentu.
Šablona PDF	templatepdf	True	string	Nahraný soubor PDF, který chcete odeslat.
e-mail	email	True	email	Email
Křestní jméno	firstname	True	string	Křestní jméno
Příjmení	lastname	True	string	Příjmení
attachments	attachments		array of string	Seznam uris prostředku přílohy
propadává	expires		date-time	ISO8601 vytvoření data a času, pokud se používá, nastavte na hodnotu TZ odesílatele nebo časového pásma.
zpráva	message		string	Vaše osobní zpráva pro oslavu, která byla zadána v centru šablony e-mailu skupiny. K použití této šablony použijte název uložené e-mailové šablony před symbolem hash. Pokud existuje více než jedna šablona se stejným názvem, vybere se naposledy změněná šablona.
Křestní jméno	firstname		string	Křestní jméno
Příjmení	lastname		string	Příjmení
e-mail	email	True	email	Email
include_link	include_link		boolean	Zahrňte odkaz na podpisové stránky, které kontrolorovi umožňují podepsat
textová zpráva (sms)	sms		string	K přidání ověření SMS použijte číslo mezinárodního formátu. Vyžaduje se, pokud je určující nebo podepisující svědek.
předmět	subject		string	Řádek předmětu pro odchozí e-maily
timezone	timezone		string	TZ podepisující osoby musí být platný TZ podle časového pásma (viz Podrobnosti o časovém pásmu uživatele). Pokud je hodnota prázdná, použije metodu tz odesílatele.
Typ podpisu	signature_type		integer	Použijte 4 k získání provedené certifikace PDF. Doporučeno. Výchozí hodnota je 1 (pro integritu dokumentu se používá hodnota hash sha256).
Připojit PDF	append_pdf		boolean	Připojte ověřovací informace legalesignu do konečného SOUBORU PDF.
auto_archive	auto_archive		boolean	Odeslání do archivu brzy po podepsání Udržuje funkci nepotřebné webové aplikace zdarma
Použití e-mailů Legalesign	do_email		boolean	K odesílání e-mailů s oznámeními použijte e-mail Legalesign. Pokud false potlačí všechny e-maily.
Kopie po dokončení	cc_emails		string	Textový řetězec s oddělovači e-mailových adres, které jsou upozorněny na podepsání nebo odmítnutí.
Převod prázdných polí odesílatele na první pole příjemce	convert_sender_to_signer		boolean	Pokud jsou některá pole odesílatele prázdná, převeďte je na pole prvního příjemce.
Heslo PDF	pdf_password		string	Nastavte heslo. Musí být kódování ascii, musíte také nastavit signature_type na 4 a zvolit pdf_password_type.
Nastavení hesla PDF	pdf_password_type		integer	1 pro uložení hesla, 2 pro odstranění z našich záznamů po konečném podepsání.
pdftext	pdftext		object	Přiřaďte hodnoty polím odesílatele PDF, použijte popisek pole šablony nebo jeho uuid jako klíče objektu. Pokud chcete získat relevantní pole s popiskem nebo uuid, podívejte se na templatepdf/:id/fields/ a vyfiltrujte element_type="admin". Viz také strict_fields.
Přesměrovací adresa URL	redirect		string	Adresa URL pro odeslání podepisující osoby po podepsání (místo stránky pro stažení) Vaše adresa URL bude obsahovat parametry dotazu s ID a informacemi o stavu následujícím způsobem: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Plán připomenutí	reminders		string	Pokud chcete ve skupině použít výchozí plán připomenutí (přejděte do webové aplikace a nastavte výchozí plán)
Odkazy pro vrácení podepisující osoby	return_signer_links		boolean	Vrátí odkazy na dokument pro podepisující osoby v textu odpovědi.
odesílání sekvencování	signers_in_order		boolean	Upozorněte podepisující osoby v pořadí jejich pořadí. Pokud jsou všechny hodnoty false upozorněny simultánně.
signertext	signertext		object	Přidejte do polí podepisující osoby vlastní zástupné symboly. Použijte popisky polí nebo uuid jako klíče v objektu (jako u pdftext). Viz templatepdf/:id/fields/ a vyfiltrujte element_type = "text" a získejte relevantní pole s jejich popisky nebo uuid.
Vynucení ověření pole	strict_fields		boolean	Pdftext selže při ověřování bezobslužně a nastaví hodnotu true pro ověření.
Váš odkaz	tag		string	Štítek
Váš odkaz	tag1		string	Štítek
Váš odkaz	tag2		string	Štítek
uživatel	user		string	Přiřaďte dokument jinému uživateli ve skupině.

Odeslat e-mail s připomenutím příjemce

ID operace:

PostSignerReminder

Pošlete příjemci e-mail s připomenutím.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID příjemce	recipientId	True	uuid	ID příjemce
poslat SMS	text		string	Vlastní text zprávy

Odstranění přílohy

ID operace:

DeleteAttachment

Odstraňte přílohu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID přílohy	attachId	True	uuid	Připojit ID

Stažení protokolu auditování dokumentů

ID operace:

GetDocumentAuditLog

PDF pouze z protokolu auditlogu dokumentů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu

Návraty

response

file

Stáhnout PDF

ID operace:

GetDocumentPdf

V závislosti na jeho stavu získáte koncept nebo konečný PDF pro podpisový dokument. Všimněte si, že odpověď 200 nebo 302 je možná.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu

Návraty

response

file

Trvale odstranit dokument

ID operace:

DeleteDocument

Trvale odstraní data a soubory.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu

Získat odkaz na příjemce

ID operace:

GetSignerLink

Jedním odkazem pro příjemce přejděte na podpisové stránky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID příjemce	recipientId	True	uuid	ID příjemce

Získat přílohu

ID operace:

GetAttachment

Získejte přílohu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID přílohy	attachId	True	uuid	ID přílohy

Návraty

Připojit položku

Body

AttachmentResponse

Získat vložený odkaz PDF

ID operace:

GetPdfTemplateEditLink

Vrátí odkaz s jedním použitím pro vložení editoru PDF.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Pdf Id	pdfId	True	string	Nastavte nahrané ID PDF.
Skrytí výpisu polí z vykreslené stránky	hide_sender_fields		boolean	Umožňuje skrýt výpis polí ze vykreslené stránky.
Šestnáctkový kód s výjimkou symbolu hash pro barvu pozadí	css_body_backgroundcolor		string	Pokud chcete změnit barvu pozadí, použijte šestnáctkový kód s výjimkou symbolu hash.

Získání dokumentu

ID operace:

GetDocument

Vrátí konkrétní dokument.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu

Návraty

Podrobnosti dokumentu

Body

DocumentResponseDetail

Získání dokumentů

ID operace:

GetDocuments

Vypisujte nearchivované podpisové dokumenty.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group	True	string	Filtrovat podle konkrétní skupiny, povinné.
Zahrnout archivované dokumenty	archived		string	Filtrujte archivovaný stav, výchozí hodnota není archivovaná, k dotazování na všechny dokumenty použijte hodnotu v tomto parametru.
Filtrovat podle e-mailu příjemce	email		string	Filtrovat podle e-mailu příjemce
Omezení dotazů	limit		integer	Délka datové sady, která se má vrátit Slouží k iteraci výsledků s posunem dotazu.
Posun dotazu	offset		integer	Posun od začátku datové sady Použije se s limitovým dotazem k iteraci prostřednictvím datové sady.
Filtrovat podle stavu dokumentu	status		integer	Umožňuje filtrovat stav dokumentu.
Odebrání příjemců z odpovědi	nosigners		string	Přidáním hodnoty 1 odeberete informace o příjemcích pro rychlejší dotaz.
Filtr pro vytvoření po tomto datu	created_gt		date-time	Vyfiltrujte tyto dokumenty vytvořené po určité době.
Filtr pro změnu po tomto datu	modified_gt		date-time	Vyfiltrujte tyto dokumenty změněné po určité době.

Návraty

Výpisy dokumentů

Body

DocumentListResponse

Získání důvodu zamítnutí příjemce

ID operace:

GetSignerRejection

Vrátí podepisující důvod pro odmítnutí dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID příjemce	recipientId	True	uuid	ID příjemce

Návraty

Name	Cesta	Typ	Description
stav	status	integer	Sošky příjemců.
důvod	reason	string	Zamítnout důvod.

Získání polí dokumentu

ID operace:

GetDocumentFields

Pole z dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID dokumentu	docId	True	uuid	ID dokumentu

Návraty

Name	Cesta	Typ	Description
		array of object	Seznam polí dokumentu
element_type	element_type	string	Typ prvku
fieldorder	fieldorder	integer	Pořadí polí
jmenovka	label	string	Označení
label_extra	label_extra	string	Popisek navíc
signatář	signer	integer	Recipient
stav	state	boolean
ověření	validation	integer	Ověřovací identifikátor
value	value	string	Hodnota

Získání polí formuláře příjemce

ID operace:

GetSignerFields

Vrátí pole formuláře od konkrétního příjemce.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID příjemce	recipientId	True	uuid	ID příjemce

Návraty

Name	Cesta	Typ	Description
		array of object
jmenovka	label	string	Označení
label_extra	label_extra	string	Popisek navíc
stav	state	boolean	Stát
fieldorder	fieldorder	integer	Pořadí polí
value	value	string	Pokud je polem soubor podepisující osoby, bude tato hodnota krátkodobou adresou URL pro stažení.

Získání příjemce

ID operace:

GetRecipient

Získejte stav a podrobnosti o individuálním příjemci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID příjemce	recipientId	True	uuid	ID příjemce

Návraty

Podrobnosti o příjemci

Body

SignerResponse

Získání příloh

ID operace:

GetAttachments

Vypsat přílohy

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group		string	Filtrovat podle konkrétní skupiny
Omezení dotazů	limit		integer	Slouží k iteraci výsledků s posunem.
Posun dotazu	offset		integer	Používejte s limitem pro iteraci výsledků.

Návraty

Výpis přílohy

Body

AttachmentListResponse

Získání skupin

ID operace:

GetGroups

Uveďte skupiny, do nichž uživatel rozhraní API patří.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Posun dotazu	offset		integer	Posun od začátku datové sady Použije se s limitovým dotazem k iteraci prostřednictvím datové sady.
Omezení dotazů	limit		integer	Délka datové sady, která se má vrátit Slouží k iteraci výsledků s posunem dotazu.

Návraty

Výpis skupin

Body

GroupListResponse

Získání uživatele

ID operace:

GetUser

Získejte podrobnosti o uživateli.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID uživatele	userId	True	uuid	ID uživatele

Návraty

Podrobnosti o uživateli

Body

UserDetailResponse

Získání šablon PDF

ID operace:

GetPdfTemplates

Výpis šablon PDF

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group		string	Může být úplná resource_uri nebo jenom ID.
Omezení dotazů	limit		integer	Délka datové sady, která se má vrátit Slouží k iteraci výsledků s posunem dotazu.
Posun dotazu	offset		integer	Posun od začátku datové sady Použije se s limitovým dotazem k iteraci prostřednictvím datové sady.

Návraty

Výpisy šablon

Body

TemplatePdfListResponse

Získání šablony PDF

ID operace:

GetPdfTemplate

Podrobnosti o konkrétní šabloně PDF

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Nahrané ID PDF	pdfId	True	uuid	Nahrané ID PDF

Návraty

Podrobnosti o šabloně

Body

TemplatePdfResponse

Člen skupiny

ID operace:

GetMember

Podrobnosti o konkrétním uživateli ve skupině

Parametry

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

Návraty

Body

MemberResponse

Členové skupin

ID operace:

GetMembers

Výpisy všech členů vašich skupin

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	group		string	Filtrování podle konkrétní skupiny
Omezení dotazů	limit		integer	Slouží k iteraci výsledků s posunem.
Posun dotazu	offset		integer	Používejte s limitem pro iteraci výsledků.

Návraty

Body

MemberListResponse

Aktivační události

Událost dokumentu	Aktivační událost pro událost dokumentu se vyskytuje
Událost příjemce	Trigger pro případ, kdy dojde k události příjemce

Událost dokumentu

ID operace:

DocumentTrigger

Aktivační událost pro událost dokumentu se vyskytuje

Parametry

Name	Klíč	Vyžadováno	Typ	Description
eventFilter	eventFilter	True	string	Filtr událostí
seskupit	group		string	Filtr skupin

Návraty

Name	Cesta	Typ	Description
verze	version	string	Version
objekt	object	string	Object
tag1	data.tag1	string	Štítek
recipients	data.recipients	array of object	Příjemci
Univerzální jednoznačný identifikátor (UUID)	data.recipients.uuid	string	ID příjemce
e-mail	data.recipients.email	string	E-mail příjemce
pořadí	data.recipients.order	integer	Číslo objednávky příjemce
stav	data.recipients.status	integer	Stav příjemce
Příjmení	data.recipients.lastname	string	Příjmení příjemce
roleText	data.recipients.roleText	string	Text role příjemce
Křestní jméno	data.recipients.firstname	string	Jméno příjemce
statusText	data.recipients.statusText	string	StatusText příjemce
resourceUri	data.recipients.resourceUri	string	Identifikátor URI prostředku příjemce
rejectReason	data.recipients.rejectReason	string	rejectReason
groupResourceUri	data.groupResourceUri	string	Identifikátor URI prostředku skupiny
statusText	data.statusText	string	Text stavu dokumentu
název	data.name	string	Název dokumentu
klíčové slovo	data.tag	string	Štítek
resourceUri	data.resourceUri	string	Identifikátor URI prostředku
Univerzální jednoznačný identifikátor (UUID)	data.uuid	string	ID dokumentu
tag2	data.tag2	string	Značka 2
seskupit	data.group	string	Skupina
stav	data.status	integer	Stav dokumentu
created	created	integer	Vytvořené
identifikační číslo	id	string	Udělal
událost	event	string	Event

Událost příjemce

ID operace:

RecipientTrigger

Trigger pro případ, kdy dojde k události příjemce

Parametry

Name	Klíč	Vyžadováno	Typ	Description
eventFilter	eventFilter	True	string	Filtr událostí
seskupit	group		string	Filtr skupin

Návraty

Name	Cesta	Typ	Description
verze	version	string	Version
objekt	object	string	Object
klíčové slovo	data.tag	string	Štítek
tag1	data.tag1	string	Značka 1
tag2	data.tag2	string	Značka 2
Univerzální jednoznačný identifikátor (UUID)	data.uuid	string	ID příjemce
e-mail	data.email	string	Email
seskupit	data.group	string	Skupina
pořadí	data.order	integer	Objednávka
stav	data.status	integer	Stav
dokument	data.document	string	Dokument
Příjmení	data.lastname	string	Příjmení
roleText	data.roleText	string	Text role
Křestní jméno	data.firstname	string	Křestní jméno
statusText	data.statusText	string	Text stavu
emailBounce	data.emailBounce	integer	E-mail se nedoručil
resourceUri	data.resourceUri	string	Identifikátor URI prostředku příjemce
název_dokumentu	data.documentName	string	Název dokumentu
rejectReason	data.rejectReason	string	Důvod zamítnutí
groupResourceUri	data.groupResourceUri	string	Identifikátor URI prostředku skupiny
emailBounceMessage	data.emailBounceMessage	string	E-mailová zpráva o nedoručitelnosti
documentResourceUri	data.documentResourceUri	string	Identifikátor URI prostředku dokumentu
created	created	integer	Vytvořené
identifikační číslo	id	string	ID
událost	event	string	Event

Definice

PermissionsEnum

Možnosti oprávnění

Možnosti oprávnění

integer

ListMeta

Meta informace o výpisu.

Name	Cesta	Typ	Description
limit	limit	integer	Maximální počet objektů
next	next	string	Adresa URL pro další sadu objektů.
posun	offset	integer	Počet položek od začátku sady výsledků
předchozí	previous	string	Adresa URL pro předchozí sadu objektů
total_count	total_count	integer	Celkový počet objektů

GroupListResponse

Výpis skupin

Name	Cesta	Typ	Description
meta	meta	ListMeta	Meta informace o výpisu.
– objekty	objects	array of object
created	objects.created	date-time	Vytvořené
is_active	objects.is_active	boolean	Aktivní
upravený	objects.modified	date-time	Změněno
název	objects.name	string	Název
public_name	objects.public_name	string	Veřejný název
resource_uri	objects.resource_uri	string	Identifikátor URI prostředku
slimák	objects.slug	string	Jedinečný název
uživatel	objects.user	string	Identifikátor URI prostředku tvůrce
xframe_allow	objects.xframe_allow	boolean	Povolit podepisování vložení
xframe_allow_pdf_edit	objects.xframe_allow_pdf_edit	boolean	Povolit úpravy vložení

TemplatePdfListResponse

Výpisy šablon

Name	Cesta	Typ	Description
meta	meta	ListMeta	Meta informace o výpisu.
– objekty	objects	array of TemplatePdfResponse

TemplatePdfResponse

Podrobnosti o šabloně

Name	Cesta	Typ	Description
created	created	date-time	Vytvořené
seskupit	group	string	Identifikátor URI skupiny
upravený	modified	date-time	Změněno
strany	parties	string	Pole s řetězci JSON strany dokumentů
page_count	page_count	integer	Počet stránek
resource_uri	resource_uri	string	Identifikátor URI prostředku
signer_count	signer_count	integer	Počet podepisující osoby
title	title	string	Title
uživatel	user	string	Identifikátor URI prostředku tvůrce
Univerzální jednoznačný identifikátor (UUID)	uuid	uuid	Pdf Id
platný	valid	boolean	Je možné odeslat (pokud pole neověřují).

DocumentListResponse

Výpisy dokumentů

Name	Cesta	Typ	Description
meta	meta	ListMeta	Meta informace o výpisu.
– objekty	objects	array of object	Documents
archivovaný	objects.archived	boolean	Archivovaný
auto_archive	objects.auto_archive	boolean	Archivujte po odeslání.
cc_emails	objects.cc_emails	string	E-maily se seznamem oddělených čárkami po dokončení kopie.
created	objects.created	date-time	Vytvořené
do_email	objects.do_email	boolean	Používejte e-maily Legalesign.
download_final	objects.download_final	boolean	Je připraven ke stažení po dokončení.
seskupit	objects.group	string	Identifikátor URI prostředku skupiny
upravený	objects.modified	date-time	Změněno
název	objects.name	string	Název dokumentu
pdftext	objects.pdftext	string	Hodnoty polí odesílatele
přesměrovat	objects.redirect	string	Adresa URL pro přesměrování příjemce po podepsání
resource_uri	objects.resource_uri	string	Identifikátor URI prostředku
return_signer_links	objects.return_signer_links	boolean	Přidání odkazů příjemců na odpověď
Signatáři	objects.signers	array of array	Vnořené pole s podrobnostmi podepisující osoby
items	objects.signers	array of	Vždy obsahuje [podepisující identifikátor URI, jméno, příjmení, e-mail, sms číslo, has_fields, stav, objednávka podepisující osoby (0 indexováno)]
signers_in_order	objects.signers_in_order	integer	Příjemci e-mailu simulují nebo sekvenční
stav	objects.status	DocumentStatusEnum	Možnosti stavu dokumentu: 10 – Počáteční stav, kontrola stavu podepisující osoby pro odeslání nebo zrušení odeslání 20. Pole byla dokončena. 30 – Podepsáno 40 – Odebráno (před podpisem) 50 – Odmítnuto
klíčové slovo	objects.tag	string	Označení dokumentu
tag1	objects.tag1	string	Označení dokumentu
tag2	objects.tag2	string	Označení dokumentu
šablona	objects.template	string	Identifikátor URI prostředku šablony, pokud se používá
templatepdf	objects.templatepdf	string	Identifikátor URI prostředku šablony PDF
poslat SMS	objects.text	string	Text pro podepisování
uživatel	objects.user	string	Identifikátor URI pro tvůrce
Univerzální jednoznačný identifikátor (UUID)	objects.uuid	uuid	ID dokumentu

DocumentStatusEnum

Možnosti stavu dokumentu:

• 10 – Počáteční stav, kontrola stavu podepisující osoby pro odeslání nebo zrušení odeslání
• 20. Pole byla dokončena.
• 30 – Podepsáno
• 40 – Odebráno (před podpisem)
• 50 – Odmítnuto

Možnosti stavu dokumentu:

• 10 – Počáteční stav, kontrola stavu podepisující osoby pro odeslání nebo zrušení odeslání
• 20. Pole byla dokončena.
• 30 – Podepsáno
• 40 – Odebráno (před podpisem)
• 50 – Odmítnuto

integer

SignerResponse

Podrobnosti o příjemci

Name	Cesta	Typ	Description
dokument	document	string	Dokument
e-mail	email	string	E-mail příjemce
křestní_jméno	first_name	string	Jméno příjemce
příjmení	last_name	string	Příjmení příjemce
has_fields	has_fields	boolean	Příjemce má pole
pořadí	order	integer	Objednávka příjemce
resource_uri	resource_uri	string	Identifikátor URI prostředku příjemce
stav	status	SignerStatusEnum	Možnosti stavu podepisující osoby: 4 – nezasílané 5 – naplánováno odeslání 10 – odesláno 15 . Otevřený e-mail 20 - navštíveno 30 – pole jsou dokončena. 35 . Pole jsou úplná ex podpis 39 . Čekání na dokončení svědka 40 – podepsáno 50 – staženo 60 – odmítnuto

SignerStatusEnum

Možnosti stavu podepisující osoby:

• 4 – nezasílané
• 5 – naplánováno odeslání
• 10 – odesláno
• 15 . Otevřený e-mail
• 20 - navštíveno
• 30 – pole jsou dokončena.
• 35 . Pole jsou úplná ex podpis
• 39 . Čekání na dokončení svědka
• 40 – podepsáno
• 50 – staženo
• 60 – odmítnuto

Možnosti stavu podepisující osoby:

• 4 – nezasílané
• 5 – naplánováno odeslání
• 10 – odesláno
• 15 . Otevřený e-mail
• 20 - navštíveno
• 30 – pole jsou dokončena.
• 35 . Pole jsou úplná ex podpis
• 39 . Čekání na dokončení svědka
• 40 – podepsáno
• 50 – staženo
• 60 – odmítnuto

integer

DocumentResponseDetail

Podrobnosti dokumentu

Name	Cesta	Typ	Description
archivovaný	archived	boolean	Archivuje se.
auto_archive	auto_archive	boolean	Po podepsání odešlete archiv dokumentů.
cc_emails	cc_emails	string	Kdo bude příjemcem e-mailového oznámení při podepsání
created	created	date-time	Vytvořené
do_email	do_email	boolean	Použití e-mailů Legalesign
download_final	download_final	boolean	Konečný SOUBOR PDF je k dispozici ke stažení
zápatí	footer	string	Dokumentace HTML – text pro zápatí, pokud se používá
footer_height	footer_height	integer	Dokumentace HTMl – výška zápatí v px, pokud se používá
seskupit	group	string	Identifikátor URI prostředku skupiny
has_fields	has_fields	boolean	Dokument obsahuje pole
hash_value	hash_value	string	Kontrolní součet SHA256 konečného dokumentu, který slouží k ověření konečného stažení PDF
hlavička	header	string	Dokumentace HTML – text pro záhlaví, pokud se používá
header_height	header_height	integer	Dokumentace HTMl – výška hlavičky px, pokud se používá
upravený	modified	date-time	Změněno
název	name	string	Název dokumentu
pdf_password	pdf_password	string	Heslo PDF
pdf_password_type	pdf_password_type	string	Pokud se heslo pdf zachovají
pdftext	pdftext	string	Tuto možnost ignorujte.
přesměrovat	redirect	string	Adresa URL pro přesměrování příjemce po podepsání
resource_uri	resource_uri	string	Identifikátor URI prostředku
return_signer_links	return_signer_links	boolean	Ignorovat
sign_mouse	sign_mouse	boolean	ignorovat
sign_time	sign_time	date-time	Čas podpisu
sign_type	sign_type	boolean	starší verze
sign_upload	sign_upload	boolean	starší verze
signature_placement	signature_placement	integer	starší verze
signature_type	signature_type	integer	starší verze – vždy 4
Signatáři	signers	array of array	Vnořené pole s podrobnostmi podepisující osoby
items	signers	array of	Vždy obsahuje [podepisující identifikátor URI, jméno, příjmení, e-mail, sms číslo, has_fields, stav, objednávka podepisující osoby (0 indexováno)]
signer_objects	signer_objects	array of object	Seznam příjemců
e-mail	signer_objects.email	string	Email
Křestní jméno	signer_objects.firstname	string	Křestní jméno
Příjmení	signer_objects.lastname	string	Příjmení
Tel	signer_objects.tel	string	Telefonní číslo
pořadí	signer_objects.order	integer	Podpisová objednávka
resource_uri	signer_objects.resource_uri	string	Identifikátor URI prostředku
role	signer_objects.role	string	Role
stav	signer_objects.status	integer	Stavový kód příjemce
Univerzální jednoznačný identifikátor (UUID)	signer_objects.uuid	string	ID příjemce
signers_in_order	signers_in_order	boolean	Příjemci e-mailu simulují nebo sekvenční
stav	status	DocumentStatusEnum	Možnosti stavu dokumentu: 10 – Počáteční stav, kontrola stavu podepisující osoby pro odeslání nebo zrušení odeslání 20. Pole byla dokončena. 30 – Podepsáno 40 – Odebráno (před podpisem) 50 – Odmítnuto
klíčové slovo	tag	string	Váš odkaz
tag1	tag1	string	Váš odkaz
tag2	tag2	string	Váš odkaz
šablona	template	string	Identifikátor URI prostředku pro textová šablona, pokud se používá
templatepdf	templatepdf	string	Identifikátor URI prostředku pro šablonu PDF, pokud se používá
poslat SMS	text	string	Text dokumentu, pokud se používá
uživatel	user	string	Identifikátor URI prostředku uživatele.
Univerzální jednoznačný identifikátor (UUID)	uuid	uuid	ID dokumentu

MemberListResponse

Name	Cesta	Typ	Description
meta	meta	ListMeta	Meta informace o výpisu.
– objekty	objects	array of MemberResponse

MemberResponse

Name	Cesta	Typ	Description
created	created	date-time	Vytvořené
seskupit	group	string	Identifikátor URI prostředku skupiny
upravený	modified	date-time	Změněno
oprávnění	permission	PermissionsEnum	Možnosti oprávnění
resource_uri	resource_uri	string	Identifikátor URI prostředku
uživatel	user	string	Identifikátor URI prostředku uživatele.

PřílohaResponse

Připojit položku

Name	Cesta	Typ	Description
created	created	date-time	Vytvořené
popis	description	string	Description
filename	filename	string	Název souboru
seskupit	group	string	Skupina
resource_uri	resource_uri	string	Připojení identifikátoru URI prostředku
uživatel	user	string	Identifikátor URI prostředku uživatele
Univerzální jednoznačný identifikátor (UUID)	uuid	uuid	Připojit ID

AttachmentListResponse

Výpis přílohy

Name	Cesta	Typ	Description
meta	meta	ListMeta	Meta informace o výpisu.
– objekty	objects	array of object	Soupis
created	objects.created	date-time	Vytvořené
popis	objects.description	string	Description
filename	objects.filename	string	Název souboru
seskupit	objects.group	string	Skupina
resource_uri	objects.resource_uri	string	Identifikátor URI prostředku
uživatel	objects.user	string	Identifikátor URI prostředku uživatele
Univerzální jednoznačný identifikátor (UUID)	objects.uuid	uuid	Připojit ID

UserDetailResponse

Podrobnosti o uživateli

Name	Cesta	Typ	Description
date_joined	date_joined	date-time	Datum připojení
e-mail	email	email	Email
křestní_jméno	first_name	string	Křestní jméno
groups	groups	array of string	Seznam skupin, ke které se tento uživatel připojil
last_login	last_login	date-time	Poslední přihlášení
příjmení	last_name	string	Příjmení
resource_uri	resource_uri	string	Identifikátor URI prostředku
timezone	timezone	string	Časové pásmo
uživatelské jméno	username	string	Uživatelské jméno

soubor

Toto je základní datový typ "file".