Nitro Sign (Preview)

Rozhraní API pro Nitro Sign umožňuje zabezpečené a komplexní pracovní postupy eSignature tím, že aplikacím umožňuje vytvářet, spravovat a sledovat procesy digitálního podepisování. Poskytuje možnosti vytvářet obálky, nahrávat dokumenty, přidávat účastníky, definovat podpisové pořadí a odesílat dokumenty pro podpis prostřednictvím plně automatizovaného přístupu řízeného rozhraním API.

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

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Logické aplikace	Standard	Všechny oblasti Logic Apps s výjimkou následujících: – Azure Government oblastí – Azure oblasti Čína - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Automatizace napájení	Premium	Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)

Kontakt
Name (Název)	Podpora nitro
URL	https://www.gonitro.com/support
Email	prosupport@sfdc.gonitro.com

Metadata konektoru
Vydavatel	Nitro PDF
Internetová stránka	https://www.gonitro.com/
Zásady ochrany osobních údajů	https://www.gonitro.com/legal/privacy-policy
Kategorie	Produktivity; It provoz

Nitro Sign Connector

Přehled

Konektor Nitro Sign umožňuje zabezpečené a komplexní pracovní postupy eSignature přímo z Power Automate a Power Apps. Umožňuje aplikacím vytvářet a spravovat podpisové obálky, nahrávat a měnit pořadí dokumentů, přidávat účastníky a definovat podpisové pořadí, umístit podpisová a datová pole, odesílat dokumenty pro podpis, sledovat průběh a stahovat původní, zapečetěné a auditované soubory – to vše prostřednictvím plně automatizovaného přístupu řízeného rozhraním API.

Publisher: Nitro Software

Prerequisites

Chcete-li použít Nitro Sign prostřednictvím tohoto konektoru, budete potřebovat:

Účet Nitro s povolenou technologií Nitro Sign
https://developers.gonitro.com/
Plán Microsoft PowerApps nebo Power Automate s možnostmi vlastního konektoru.

Autentizace

Nitro Sign používá machine-to-machine OAuth 2.0 s udělením přihlašovacích údajů klienta k vygenerování přístupových tokenů pro požadavky rozhraní API.

Jak to funguje

Na samoobslužném portálu Nitro vytvoříte aplikaci API a získáte přidružené ID klienta a tajný klíč klienta.
Konektor se ověřuje výměnou těchto přihlašovacích údajů pro nosný přístupový token.
Token se pak použije k autorizaci následných volání rozhraní API nitro sign.

Vytvořte přihlašovací údaje a přečtěte si podrobný průvodce:
https://developers.gonitro.com/docs/authentication/credentials

Vytvoření připojení v Power Automate / Power Apps

Při přidávání konektoru do toku nebo aplikace:

Klikněte na Přidat nové připojení.
Zadejte ID klienta a tajný klíč klienta (vydaný na portálu pro vývojáře Nitro).
Vyberte svůj Nitro Region (Evropa, USA nebo APAC) – oblast přidružená k vašemu účtu Nitro.
Uložte připojení – při prvním použití si konektor vymění ID klienta a tajný klíč klienta za krátkodobý přístupový token pomocí udělení přihlašovacích údajů klienta OAuth 2.0, uloží ho do mezipaměti a obnoví ho automaticky. Vaše přihlašovací údaje se používají pouze k získání tokenu; následná volání rozhraní API se ověřují vaším jménem nosným tokenem.

Poznámka: Nevyžaduje se žádné přihlašování interaktivní uživatelem; tento tok je určený pro scénáře typu server-to-server nebo app-to-app.

Podporované operace

Konektor seskupí své akce kolem čtyř prostředků podpisového pracovního postupu – Obálky, Dokumenty, Pole a Účastníci – a sadu akcí stahování pro načítání dokončených souborů.

1. Obálky

Obálka je kontejner dokumentů, účastníků a polí v jediné žádosti o podpis.

Seznam obálek
Vrátí všechny obálky přidružené k aplikaci v účtu. Výsledky jsou stránkované: Odpověď obsahuje token kurzoru další stránky , který můžete zadat do volitelného parametru Page After a načíst další stránku (nebo Page Před na stránku zpět). Oba parametry kurzoru jsou v části Upřesnit a jsou potřeba pouze při procházení velkých sad výsledků.
Vytvořit obálku
Vytvoří novou obálku s názvem, zprávou s oznámením (předmět + text, s dynamickými proměnnými, jako $(sender_name_or_email) jsou a $(envelope_name)) a režimem podepisování:
- parallel — všichni účastníci jsou upozorněni současně a mohou se podepsat nezávisle.
- sequential — účastníci jsou upozorněni po jednom, v pořadí, v jakém byli přidáni.
Získat obálku podle ID
Načte podrobnosti o konkrétní obálce podle jeho UUID.
Aktualizovat obálku
Aktualizuje název obálky, nastavení oznámení nebo režim podepisování. Všechna pole jsou volitelná.
Odstranit obálku podle ID
Trvale odstraní obálku a všechny přidružené dokumenty, pole a účastníky. Tuto akci nelze vrátit zpět.
Odeslat obálku pro podepisování
Odešle obálku účastníkům pro kolekci podpisů. Před odesláním by měla obálka normálně obsahovat svoje dokumenty, účastníky a podpisová pole (prostřednictvím možnosti Vytvořit dokument podle ID obálky, Vytvořit účastníky podle ID obálky a Vytvořit pole podle ID dokumentu). Všechny dokumenty v obálce musí mít před odesláním obálky stav nahrání.
Odeslat připomenutí obálky
Aktivuje oznámení připomenutí čekajícími účastníky. Pokud nejsou k dispozici žádná nastavení oznámení, použije se výchozí šablona oznámení nakonfigurovaná pro obálku.
Zrušit obálku podle ID
Zruší žádost o podepsání. Je možné zrušit jenom obálky, které už byly odeslány k podepisování.

2. Dokumenty

Dokumenty jsou soubory připojené k obálce a podepsané účastníky.

Výpis dokumentů podle ID obálky
Načte všechny dokumenty přidružené k obálce.
Vytvoření dokumentu podle ID obálky
Nahraje dokument do existující obálky. Zadejte soubor plus jednoduchá napsaná pole – bez ručně napsaného formátu JSON:
- Soubor dokumentu – soubor k nahrání.
- Název dokumentu – název, pod který chcete dokument uložit.
- Content Type(advanced; optional) – typ MIME souboru; výchozí hodnota application/pdf. Pokud tento parametr vynecháte, přijímají se jenom soubory PDF.
Získání dokumentu podle ID
Načte podrobnosti o konkrétním dokumentu v obálce.
Aktualizace dokumentu podle ID
Aktualizuje metadata dokumentu. V současné době je možné změnit pouze název dokumentu.
Odstranit dokument podle ID
Trvale odstraní dokument z obálky.
Změna pořadí dokumentů podle ID obálky
Změní pořadí dokumentů v obálce na základě zadaného seznamu ID dokumentů.

3. Pole

Pole jsou interaktivní prvky (podpis, iniciály, datum atd.) umístěné v dokumentu a přiřazené účastníkovi.

Seznam polí podle ID dokumentu
Načte všechna pole přidružená ke konkrétnímu dokumentu.
Vytvoření polí podle ID dokumentu
Vytvoří jedno nebo více polí v dokumentu a přiřadí je účastníkům. Zadejte jednu položku pro jedno pole nebo více položek hromadné žádosti. Každé pole určuje:
- participantID — účastník přiřazený k poli.
- type— jeden z signature, initials, , name, titledate, company, checkbox, custom.
- page — číslo stránky (indexování založené na 1).
- Pozice X, Pozice Y, Šířka, Výška – pozice a velikost pole, každý zadaný jako samostatné číslo v bodech (X/Y se měří od levého nebo horního okraje stránky). Nahradí předchozí jedno boundingBox pole, takže každá hodnota je pole typu v uživatelském rozhraní, nikoli ručně sestavený seznam.
- Volitelné: required (výchozí true) a – v části Upřesnit – format (např. MM/DD/YYYY pro pole kalendářních dat) a modifiable.
Aktualizovat pole podle ID
Aktualizuje vlastnosti existujícího pole. type Pole musí být zadáno a musí odpovídat existujícímu typu pole – slouží k identifikaci schématu pole a nemění typ pole.
Odstranit pole podle ID
Trvale odstraní pole z dokumentu.

4. Účastníci

Účastníci jsou lidé, kteří dostanou obálku – buď ji podepsat, nebo být informovaní.

Výpis účastníků podle ID obálky
Načte všechny účastníky přidružené k obálce.
Vytvoření účastníků podle ID obálky
Přidá k obálce jeden nebo více účastníků. Zadejte jednu položku pro jednoho účastníka nebo více položek hromadné žádosti. Každý účastník určuje:
- email — e-mailovou adresu účastníka.
- role — signer (můžou mít přiřazená pole pro podepisování) nebo cc (přístup jen pro čtení).
- authentication (rozšířené, volitelné) – v současné době přístupový kód: před podepsáním musí účastník zadat statický přístupový kód. Tuto část otevřete jenom v případě, že by se účastník měl před podepsáním ověřit.
Aktualizovat účastníka podle ID
Aktualizuje nastavení ověřování účastníka. E-mail účastníka nelze změnit.
Odstranit účastníka podle ID
Trvale odstraní účastníka z obálky.

5. Soubory ke stažení

Po podepsání a zapečetění dokumentů načtěte dokončené soubory.

Stáhnout původní obálku
Stáhne původní nepodepsané dokumenty z obálky jako archiv ZIP .
Stáhnout zapečetěnou obálku
Stáhne zapečetěné podepsané dokumenty spolu se záznamem auditu jako archiv ZIP .
Stáhnout zapečetěný dokument podle ID
Stáhne jeden zapečetěný podepsaný dokument jako soubor PDF .
Stáhnout záznam auditu obálky
Stáhne úplný záznam auditu obálky jako soubor PDF .

Akce stahování zpřístupňují tokeny pro výběr nativní název souboru a obsah souboru (plus typ obsahu souboru). Obsah souboru umístěte přímo do vstupního souboru podřízeného kroku , například OneDrive / SharePoint Vytvořit soubor – a název souboru do vstupu názvu souboru. Není vyžadován žádný body('Action_Name') výraz ani ručně zadaný název souboru. Konektor zabalí stažený soubor ZIP nebo PDF do obálky JSON, takže Power Automate tyto soubory zobrazí jako běžné tokeny dynamického obsahu.

Typický podpisový pracovní postup

Kompletní podpisový tok zřetědí výše uvedené akce. Běžný tok Power Automate vypadá takto:

Vytvořit obálku – nastavte název, předmět/text oznámení a režim podepisování (parallel nebo sequential). Uložte vrácené ID obálky.
Vytvořit dokument podle ID obálky – nahrajte do obálky jeden nebo více souborů (pomocí ID obálky z kroku 1). Uložte každé vrácené ID dokumentu.
(Volitelné)Změnit pořadí dokumentů podle ID obálky – nastavte pořadí dokumentů.
Vytvořte účastníky podle ID obálky – přidejte podepisující osoby a příjemce kopie se svým ověřováním pomocí přístupového kódu. Uložte každé vrácené ID účastníka.
Vytvořte pole podle ID dokumentu – u každého dokumentu umisťujte pole podpisu/data atd. a přiřaďte je účastníkům (pomocí ID dokumentu z kroku 2 a ID účastníka z kroku 3).
Odeslat obálku pro podepisování – odešle obálku. Nejdřív musí být všechny dokumenty ve stavu nahrání.
(Čeká se na vyřízení)Odeslání připomenutí obálky k posunu účastníků nebo zrušení obálky podle ID , aby se žádost zastavila.
(Po dokončení)Stáhnout zapečetěnou obálku / Stáhnout zapečetěný dokument podle ID / Download Audit Trail of Envelope k načtení hotových souborů.

Tip: ID obálky, ID dokumentu a ID účastníka vrácené akcemi vytvoření se přirozeně prosadí do pozdějších akcí prostřednictvím nástroje pro výběr dynamického obsahu Power Automate – místo toho, abyste ho nezadáli, vyberte token ID z upstreamové akce.

Chyby a omezování

Rozhraní API pro nitro sign může vrátit následující chyby:

400 – Chybný požadavek
401 – Neautorizováno
404 – Nenalezena
409 – Konflikt (např. jednání na obálce ve stavu, který nepovoluje operaci)
413 – Obsah je příliš velký
415 – Nepodporovaný typ média
422 – Nezpracovaná entita
500 – Vnitřní chyba serveru

Škrcení

Volání rozhraní API na připojení: 100 za 60 sekund.

Limity platformy

Velikost souboru

Maximum: 25 MB na požadavek
Platí pro operace s jedním i více soubory.

Počet stránek

Maximum: 250 stránek na jednotlivé dokumenty
Celkový počet kombinovaných stránek ve více dokumentech může překročit 250.

Doba uchování

Vstupní a výstupní soubory se odstraní přibližně 15 minut po dokončení operace.

Poznámky

Akce správy obálek, dokumentů, polí a účastníků vrací JSON.
Akce stahování vrátí soubor (ZIP nebo PDF) zabalený v obálce JSON s názvem souboru, typem obsahu souboru a obsahem souboru jako tokeny nativních pro výběr, aby výsledky mohly být zřetězeny do podřízené akce souboru bez výrazů.
Podpisový režim (parallel vs sequential. ) se nastaví při vytvoření obálky a lze ji před odesláním obálky změnit pomocí aktualizační obálky .
Ověřování účastníka v současné době podporuje pouze přístupový kód .

Vytvoření připojení

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


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

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

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

Name (Název)	Typ	Description	Required
Id klienta Nitro	securestring	ID klienta vaší aplikace Nitro	Pravdivé
Nitro Tajný klíč klienta	securestring	Váš Nitro aplikace Client Secret	Pravdivé
Nitro Region	řetězec	Vyberte pro svůj účet oblast rozhraní Nitro API.	Pravdivé

Akce

Aktualizace dokumentu podle ID	Aktualizuje metadata existujícího dokumentu v obálce Nitro Sign. V současné době je možné aktualizovat pouze název dokumentu.
Aktualizovat obálku	Aktualizuje stávající obálku Nitro Sign. Název obálky, nastavení oznámení, režim podepisování nebo libovolnou kombinaci těchto polí můžete upravit.
Aktualizovat pole podle ID	Aktualizuje vlastnosti existujícího pole v dokumentu Nitro Sign. Musí být zadán typ pole a musí odpovídat existujícímu typu pole; rozhraní API ho používá k identifikaci schématu pole a nemění typ pole.
Aktualizovat účastníka podle ID	Aktualizuje nastavení ověřování pro účastníka obálky Nitro Sign. E-mail účastníka nelze aktualizovat.
Odeslat obálku pro podepisování	Pošle obálku Nitro Sign účastníkům pro kolekci podpisů. Před použitím této akce by obálka měla normálně obsahovat dokumenty, účastníky a podpisová pole přidaná pomocí pole Vytvořit dokument podle ID obálky, Vytvořit účastníky podle ID obálky a Vytvořit pole podle ID dokumentu. Všechny dokumenty v obálce musí mít před odesláním obálky stav nahrání.
Odeslat připomenutí obálky	Aktivuje oznámení připomenutí čekajícími účastníky zadané obálky Nitro Sign. Pokud nejsou k dispozici žádná nastavení oznámení, použije se výchozí šablona oznámení nakonfigurovaná pro obálku.
Odstranit dokument podle ID	Trvale odstraní dokument z obálky Nitro Sign.
Odstranit obálku podle ID	Trvale odstraní obálku Nitro Sign. Tuto operaci nelze vrátit zpět a odstraní se také všechny přidružené dokumenty, pole a účastníci.
Odstranit pole podle ID	Trvale odstraní pole z dokumentu v obálce Nitro Sign.
Odstranit účastníka podle ID	Trvale odstraní účastníka z obálky Nitro Sign.
Seznam obálek	Koncový bod Seznam obálek vrátí všechny obálky přidružené k aplikaci v účtu.
Seznam polí podle ID dokumentu	Načte všechna pole přidružená ke konkrétnímu dokumentu v obálce Nitro Sign.
Stáhnout původní obálku	Stáhne původní nepodepsané dokumenty z obálky Nitro Sign jako archiv ZIP.
Stáhnout zapečetěnou obálku	Stáhne zapečetěné podepsané dokumenty z obálky Nitro Sign spolu se záznamem auditu jako archiv ZIP.
Stáhnout zapečetěný dokument podle ID	Stáhne jeden zapečetěný podepsaný dokument z obálky Nitro Sign jako PDF soubor.
Stáhnout záznam auditu obálky	Stáhne soubor PDF obsahující úplný záznam auditu pro vybranou obálku Nitro Sign.
Vytvoření dokumentu podle ID obálky	Nahraje dokument do existující obálky Nitro Sign. Dokument lze později použít v pracovním postupu podepisování.
Vytvoření polí podle ID dokumentu	Vytvoří jedno nebo více polí v dokumentu a přiřadí je účastníkům. Pokud chcete vytvořit jedno pole, zadejte jednu položku v poli Pole. Pokud chcete vytvořit více polí, zadejte více položek.
Vytvoření účastníků podle ID obálky	Přidá jednoho nebo více účastníků do obálky Nitro Sign. Pokud chcete přidat jednoho účastníka, zadejte jednu položku v poli Účastníci. Pokud chcete přidat více účastníků, zadejte více položek.
Vytvořit obálku	Vytvoří novou obálku Nitro Sign, která může být později naplněna dokumenty, účastníky, pole a odeslána k podepisování.
Výpis dokumentů podle ID obálky	Načte všechny dokumenty přidružené ke konkrétní obálce Nitro Sign.
Výpis účastníků podle ID obálky	Načte všechny účastníky spojené s konkrétní obálkou Nitro Sign.
Změna pořadí dokumentů podle ID obálky	Změní pořadí dokumentů přidružených ke konkrétní obálce Nitro Sign na základě zadaného seznamu ID dokumentů.
Zrušit obálku podle ID	Zruší podpisovou žádost o obálku Nitro Sign. Je možné zrušit pouze obálky odeslané k podepisování.
Získat obálku podle ID	Načte podrobnosti pro konkrétní obálku Nitro Sign pomocí jeho jedinečné ID obálky.
Získání dokumentu podle ID	Načte podrobnosti o konkrétním dokumentu v obálce Nitro Sign.

Aktualizace dokumentu podle ID

ID operace:: UpdateDocumentByID

Aktualizuje metadata existujícího dokumentu v obálce Nitro Sign. V současné době je možné aktualizovat pouze název dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument, který se má aktualizovat.
Název dokumentu	name	True	string	Nový název dokumentu.

Návraty

Podrobnosti dokumentu podepisujte nitro.

Body: DocumentResponse

Aktualizovat obálku

ID operace:: UpdateEnvelope

Aktualizuje stávající obálku Nitro Sign. Název obálky, nastavení oznámení, režim podepisování nebo libovolnou kombinaci těchto polí můžete upravit.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, kterou chcete aktualizovat.
Název obálky	name		string	Aktualizovaný název obálky. Nemusí být jedinečný.
Předmět oznámení	subject		string	Řádek předmětu e-mailového oznámení odeslaného podpisovým účastníkům. Podporují se dynamické proměnné, například : $(sender_name_or_email) požaduje váš podpis.
Text oznámení	body		string	Text e-mailu odeslaný účastníkům podpisu. Podporují se dynamické proměnné, například: Hi,\nPlease sign the $(envelope_name)\nDěkujeme,\n$(sender_name_or_email).
Režim podepisování	mode		string	Definuje podpisové pořadí. Pomocí paralelně upozorněte všechny účastníky najednou nebo postupně upozorněte účastníky na jeden po druhém v pořadí, v jakém byli přidáni.

Návraty

Odpověď vrácená po vyžádání nebo vytvoření obálky Nitro Sign.

Body: EnvelopeResponse

Aktualizovat pole podle ID

ID operace:: UpdateFieldByID

Aktualizuje vlastnosti existujícího pole v dokumentu Nitro Sign. Musí být zadán typ pole a musí odpovídat existujícímu typu pole; rozhraní API ho používá k identifikaci schématu pole a nemění typ pole.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument obsahující pole.
Pole ID	fieldID	True	uuid	Jedinečný identifikátor UUID, který identifikuje pole, které se má aktualizovat.
Typ pole	type	True	string	Aktuální typ pole, které se aktualizuje. Tato hodnota je vyžadována rozhraním API a musí odpovídat existujícímu typu pole; nezmění typ pole.
ID účastníka	participantID		uuid	Jedinečný identifikátor účastníka přiřazeného k poli.
Stránka	page		integer	Číslo stránky, kde se zobrazí pole. Stránky používají indexování založené na 1.
Pozice X	x		float	Optional. Vodorovná pozice pole měřená od levého okraje stránky v bodech.
Pozice Y	y		float	Optional. Svislá pozice pole měřená od horního okraje stránky v bodech.
Šířka	width		float	Optional. Šířka pole v bodech.
Výška	height		float	Optional. Výška pole v bodech.
Required	required		boolean	Určuje, zda musí účastník toto pole dokončit.
Format	format		string	Formát pole, pokud je to možné. Například pole kalendářních dat můžou používat formát, například MM/DD/RRRR.
Lze změnit	modifiable		boolean	Určuje, zda je hodnota pole upravitelná, pokud je k dispozici.

Návraty

Podrobnosti pole Nitro Sign.

Body: FieldResponse

Aktualizovat účastníka podle ID

ID operace:: UpdateParticipantByID

Aktualizuje nastavení ověřování pro účastníka obálky Nitro Sign. E-mail účastníka nelze aktualizovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující účastníka.
ID účastníka	participantID	True	uuid	Jedinečný identifikátor UUID, který identifikuje účastníka, který se má aktualizovat.
Typ ověření	type		string	Optional. Vyberte metodu ověřování pro účastníka. Pokud je zadaný, měl by se zadat také přístupový kód.
Přístupový kód	accessCode		string	Vyžaduje se pouze v případě, že je zadán typ ověřování. Pokud se nevyžaduje ověřování účastníků, nechte prázdné.

Návraty

Podrobnosti o účastníkovi Nitro Sign.

Body: ParticipantResponse

Odeslat obálku pro podepisování

ID operace:: SendEnvelopeForSigning

Pošle obálku Nitro Sign účastníkům pro kolekci podpisů. Před použitím této akce by obálka měla normálně obsahovat dokumenty, účastníky a podpisová pole přidaná pomocí pole Vytvořit dokument podle ID obálky, Vytvořit účastníky podle ID obálky a Vytvořit pole podle ID dokumentu. Všechny dokumenty v obálce musí mít před odesláním obálky stav nahrání.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, která se má odeslat k podepisování.

Návraty

Souhrnné informace o obálce Nitro Sign.

Body: EnvelopeSummaryResponse

Odeslat připomenutí obálky

ID operace:: SendRemindersForEnvelope

Aktivuje oznámení připomenutí čekajícími účastníky zadané obálky Nitro Sign. Pokud nejsou k dispozici žádná nastavení oznámení, použije se výchozí šablona oznámení nakonfigurovaná pro obálku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, pro kterou se mají odesílat oznámení připomenutí.
Předmět oznámení	subject		string	Řádek předmětu e-mailového oznámení odeslaného podpisovým účastníkům. Podporují se dynamické proměnné, například : $(sender_name_or_email) požaduje váš podpis.
Text oznámení	body		string	Text e-mailu odeslaný účastníkům podpisu. Podporují se dynamické proměnné, například: Hi,\nPlease sign the $(envelope_name)\nDěkujeme,\n$(sender_name_or_email).

Odstranit dokument podle ID

ID operace:: DeleteDocumentByID

Trvale odstraní dokument z obálky Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument k odstranění.

Odstranit obálku podle ID

ID operace:: DeleteEnvelopeByID

Trvale odstraní obálku Nitro Sign. Tuto operaci nelze vrátit zpět a odstraní se také všechny přidružené dokumenty, pole a účastníci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku k odstranění.

Odstranit pole podle ID

ID operace:: DeleteFieldByID

Trvale odstraní pole z dokumentu v obálce Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument obsahující pole.
Pole ID	fieldID	True	uuid	Jedinečný identifikátor UUID, který identifikuje pole, které se má odstranit.

Odstranit účastníka podle ID

ID operace:: DeleteParticipantByID

Trvale odstraní účastníka z obálky Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující účastníka.
ID účastníka	participantID	True	uuid	Jedinečný identifikátor UUID, který identifikuje účastníka k odstranění.

Seznam obálek

ID operace:: ListEnvelopes

Koncový bod Seznam obálek vrátí všechny obálky přidružené k aplikaci v účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Stránka za	pageAfter		string	Volitelný token kurzoru použitý k načtení další stránky obálek. Použijte hodnotu nextPage vrácenou předchozí odpovědí.
Stránka před	pageBefore		string	Volitelný token kurzoru použitý k načtení předchozí stránky obálek. Nepoužívejte společně se stránkou Za.

Návraty

Name	Cesta	Typ	Description
Obálky	items	array of EnvelopeSummaryResponse	Seznam obálek.
Další stránka	nextPage	string	Token kurzoru, který lze použít jako Page After k načtení další stránky obálek.

Seznam polí podle ID dokumentu

ID operace:: ListFieldsByDocumentID

Načte všechna pole přidružená ke konkrétnímu dokumentu v obálce Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument, jehož pole by se měla načíst.

Návraty

Odpověď vrácená po vytvoření jednoho nebo více polí

Body: FieldsResponse

Stáhnout původní obálku

ID operace:: DownloadOriginalEnvelope

Stáhne původní nepodepsané dokumenty z obálky Nitro Sign jako archiv ZIP.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž původní dokumenty by se měly stáhnout.

Návraty

Stažený soubor zabalený jako obálka JSON

Body: FileDownloadResponse

Stáhnout zapečetěnou obálku

ID operace:: DownloadSealedEnvelope

Stáhne zapečetěné podepsané dokumenty z obálky Nitro Sign spolu se záznamem auditu jako archiv ZIP.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž zapečetěné dokumenty by se měly stáhnout.

Návraty

Stažený soubor zabalený jako obálka JSON

Body: FileDownloadResponse

Stáhnout zapečetěný dokument podle ID

ID operace:: DownloadSealedDocumentByID

Stáhne jeden zapečetěný podepsaný dokument z obálky Nitro Sign jako PDF soubor.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující zapečetěný dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje zapečetěný dokument ke stažení.

Návraty

Stažený soubor zabalený jako obálka JSON

Body: FileDownloadResponse

Stáhnout záznam auditu obálky

ID operace:: DownloadAuditTrailOfEnvelope

Stáhne soubor PDF obsahující úplný záznam auditu pro vybranou obálku Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž záznam auditu by se měl stáhnout.

Návraty

Stažený soubor zabalený jako obálka JSON

Body: FileDownloadResponse

Vytvoření dokumentu podle ID obálky

ID operace:: CreateDocumentByEnvelopeID

Nahraje dokument do existující obálky Nitro Sign. Dokument lze později použít v pracovním postupu podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, do které se dokument nahraje.
Název dokumentu	documentName	True	string	Název dokumentu, který se má nahrát. Tato hodnota se použije k vytvoření metadat dokumentu posílaných do Nitro.
Typ obsahu	contentType		string	Typ obsahu nahraného dokumentu. Pro soubory PDF použijte aplikaci/pdf. Pokud z metadat vynecháte, přijímají se pouze soubory PDF.
Soubor dokumentu	payload	True	file	Soubor dokumentu, který chcete nahrát na obálku.

Návraty

Name	Cesta	Typ	Description
ID dokumentu	ID	uuid	Jedinečný identifikátor UUID, který identifikuje nahraný dokument.
Název dokumentu	name	string	Název nahraného dokumentu.
Vytvořeno v	createdAt	string	Časové razítko označující, kdy byl dokument vytvořen.
Stav dokumentu	status	string	Stav zpracování nahraného dokumentu.

Vytvoření polí podle ID dokumentu

ID operace:: CreateFieldsByDocumentID

Vytvoří jedno nebo více polí v dokumentu a přiřadí je účastníkům. Pokud chcete vytvořit jedno pole, zadejte jednu položku v poli Pole. Pokud chcete vytvořit více polí, zadejte více položek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument, ve kterém se mají pole vytvořit.
ID účastníka	participantID	True	uuid	Jedinečný identifikátor účastníka přiřazeného k poli.
Stránka	page	True	integer	Číslo stránky, kam má být pole umístěné. Stránky používají indexování založené na 1, takže první stránka je 1.
Typ pole	type	True	string	Typ pole, které chcete vytvořit.
Pozice X	x	True	float	Vodorovná pozice pole měřená od levého okraje stránky v bodech.
Pozice Y	y	True	float	Svislá pozice pole měřená od horního okraje stránky v bodech.
Šířka	width	True	float	Šířka pole v bodech.
Výška	height	True	float	Výška pole v bodech.
Required	required		boolean	Určuje, zda musí účastník toto pole dokončit.
Format	format		string	Volitelný formát pro typy polí, které podporují formátování, například pole kalendářních dat. Příklad: MM/DD/YYYY.
Lze změnit	modifiable		boolean	Určuje, zda lze hodnotu pole upravit účastníkem, pokud je podporovaný typem pole.

Návraty

Odpověď vrácená po vytvoření jednoho nebo více polí

Body: FieldsResponse

Vytvoření účastníků podle ID obálky

ID operace:: CreateParticipantsByEnvelopeID

Přidá jednoho nebo více účastníků do obálky Nitro Sign. Pokud chcete přidat jednoho účastníka, zadejte jednu položku v poli Účastníci. Pokud chcete přidat více účastníků, zadejte více položek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, do které se mají účastníci přidat.
Email	email	True	email	E-mailová adresa účastníka.
Úloha	role	True	string	Role účastníka. Podepisující člověk může mít přiřazená pole pro podepisování. Účastník kopie má přístup jen pro čtení.
Typ ověření	type		string	Optional. Vyberte metodu ověřování pro účastníka. Pokud je zadaný, měl by se zadat také přístupový kód.
Přístupový kód	accessCode		string	Vyžaduje se pouze v případě, že je zadán typ ověřování. Pokud se nevyžaduje ověřování účastníků, nechte prázdné.

Návraty

Odpověď vrácená po vytvoření jednoho nebo více účastníků

Body: ParticipantsResponse

Vytvořit obálku

ID operace:: CreateEnvelope

Vytvoří novou obálku Nitro Sign, která může být později naplněna dokumenty, účastníky, pole a odeslána k podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název obálky	name	True	string	Název obálky. Nemusí být jedinečný.
Režim podepisování	mode	True	string	Definuje podpisové pořadí. Pomocí paralelně upozorněte všechny účastníky najednou nebo postupně upozorněte účastníky na jeden po druhém v pořadí, v jakém byli přidáni.
Předmět oznámení	subject	True	string	Řádek předmětu e-mailového oznámení odeslaného podpisovým účastníkům. Podporují se dynamické proměnné, například : $(sender_name_or_email) požaduje váš podpis.
Text oznámení	body	True	string	Text e-mailu odeslaný účastníkům podpisu. Podporují se dynamické proměnné, například: Hi,\nPlease sign the $(envelope_name)\nDěkujeme,\n$(sender_name_or_email).

Návraty

Odpověď vrácená po vyžádání nebo vytvoření obálky Nitro Sign.

Body: EnvelopeResponse

Výpis dokumentů podle ID obálky

ID operace:: ListDocumentsByEnvelopeID

Načte všechny dokumenty přidružené ke konkrétní obálce Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž dokumenty by se měly načíst.

Návraty

Odpověď vrácená při výpisu dokumentů spojených s obálkou Nitro Sign.

Body: ListDocumentsByEnvelopeIDResponse

Výpis účastníků podle ID obálky

ID operace:: ListParticipantsByEnvelopeID

Načte všechny účastníky spojené s konkrétní obálkou Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž účastníci by se měli načíst.

Návraty

Odpověď vrácená při výpisu účastníků spojených s obálkou Nitro Sign.

Body: ParticipantsListResponse

Změna pořadí dokumentů podle ID obálky

ID operace:: ReorderDocumentsByEnvelopeID

Změní pořadí dokumentů přidružených ke konkrétní obálce Nitro Sign na základě zadaného seznamu ID dokumentů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, jejíž dokumenty by se měly změnit.
ID dokumentů	order	True	array of uuid	Pole ID dokumentů představující nové pořadí dokumentů v rámci obálky.

Návraty

Odpověď vrácená při výpisu dokumentů spojených s obálkou Nitro Sign.

Body: ListDocumentsByEnvelopeIDResponse

Zrušit obálku podle ID

ID operace:: CancelEnvelopeByID

Zruší podpisovou žádost o obálku Nitro Sign. Je možné zrušit pouze obálky odeslané k podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, kterou chcete zrušit.

Návraty

Odpověď vrácená po vyžádání nebo vytvoření obálky Nitro Sign.

Body: EnvelopeResponse

Získat obálku podle ID

ID operace:: GetEnvelopeByID

Načte podrobnosti pro konkrétní obálku Nitro Sign pomocí jeho jedinečné ID obálky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku, která se má načíst.

Návraty

Odpověď vrácená po vyžádání nebo vytvoření obálky Nitro Sign.

Body: EnvelopeResponse

Získání dokumentu podle ID

ID operace:: GetDocumentByID

Načte podrobnosti o konkrétním dokumentu v obálce Nitro Sign.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	envelopeID	True	uuid	Jedinečný identifikátor UUID, který identifikuje obálku obsahující dokument.
ID dokumentu	documentID	True	uuid	Jedinečný identifikátor UUID, který identifikuje dokument, který se má načíst.

Návraty

Podrobnosti dokumentu podepisujte nitro.

Body: DocumentResponse

Definice

ObálkaNotification

Nastavení e-mailu s oznámením pro obálku Nitro Sign.

Name	Cesta	Typ	Description
Předmět oznámení	subject	string	Řádek předmětu e-mailového oznámení odeslaného podpisovým účastníkům. Podporují se dynamické proměnné, například : $(sender_name_or_email) požaduje váš podpis.
Text oznámení	body	string	Text e-mailu odeslaný účastníkům podpisu. Podporují se dynamické proměnné, například: Hi,\nPlease sign the $(envelope_name)\nDěkujeme,\n$(sender_name_or_email).

EnvelopeSummaryResponse

Souhrnné informace o obálce Nitro Sign.

Name	Cesta	Typ	Description
ID obálky	ID	uuid	Jedinečný identifikátor UUID, který identifikuje obálku.
Vytvořeno v	createdAt	date-time	Časové razítko UTC označující, kdy byla obálka vytvořena.
Naposledy změněno na adrese	lastModifiedAt	date-time	Časové razítko UTC označující, kdy byla obálka naposledy změněna.
Název obálky	name	string	Název obálky.
Stav obálky	status	string	Vnitřní stav obálky.

ObálkaResponse

Odpověď vrácená po vyžádání nebo vytvoření obálky Nitro Sign.

Name	Cesta	Typ	Description
ID obálky	ID	uuid	Jedinečný identifikátor UUID, který identifikuje obálku.
Vytvořeno v	createdAt	date-time	Časové razítko UTC označující, kdy byla obálka vytvořena.
Naposledy změněno na adrese	lastModifiedAt	date-time	Časové razítko UTC označující, kdy byla obálka naposledy změněna.
Název obálky	name	string	Název obálky.
Stav obálky	status	string	Vnitřní stav obálky.
Režim podepisování	mode	string	Režim podepisování nakonfigurovaný pro obálku.
oznámení	notification	EnvelopeNotification	Nastavení e-mailu s oznámením pro obálku Nitro Sign.

ListDocumentsByEnvelopeIDResponse

Odpověď vrácená při výpisu dokumentů spojených s obálkou Nitro Sign.

Name	Cesta	Typ	Description
Documents	items	array of DocumentResponse	Seznam dokumentů přidružených k obálce

DocumentResponse

Podrobnosti dokumentu podepisujte nitro.

Name	Cesta	Typ	Description
ID dokumentu	ID	uuid	Jedinečný identifikátor UUID, který dokument identifikuje.
Název dokumentu	name	string	Název dokumentu.
Vytvořeno v	createdAt	date-time	Časové razítko UTC označující, kdy byl dokument vytvořen.
Velikost v bajtech	sizeBytes	integer	Velikost dokumentu v bajtech.
Počet stránek	numPages	integer	Počet stránek v dokumentu
Stav dokumentu	status	string	Aktuální stav dokumentu.

PoleResponse

Odpověď vrácená po vytvoření jednoho nebo více polí

Name	Cesta	Typ	Description
Fields	items	array of FieldResponse	Pole vytvořená v tomto požadavku.

FieldResponse

Podrobnosti pole Nitro Sign.

Name	Cesta	Typ	Description
Pole ID	ID	uuid	Jedinečný identifikátor UUID, který identifikuje pole.
ID účastníka	participantID	uuid	Jedinečný identifikátor účastníka přiřazeného k poli.
ID dokumentu	documentID	uuid	Jedinečný identifikátor dokumentu, do kterého pole patří.
Stránka	page	integer	Číslo stránky, kde se zobrazí pole.
Ohraničovací rámeček	boundingBox	array of float	Matice čtyř čísel ve formátu [x, y, šířka, výška], měřená v bodech.
Required	required	boolean	Určuje, zda musí účastník toto pole dokončit.
Typ pole	type	string	Typ pole.
Format	format	string	Formát pole, pokud je to možné.
Lze změnit	modifiable	boolean	Určuje, zda je hodnota pole upravitelná, pokud je k dispozici.

ParticipantsResponse

Odpověď vrácená po vytvoření jednoho nebo více účastníků

Name	Cesta	Typ	Description
Participants	items	array of ParticipantResponse	Účastníci vytvořili v této žádosti.

ParticipantsListResponse

Odpověď vrácená při výpisu účastníků spojených s obálkou Nitro Sign.

Name	Cesta	Typ	Description
Participants	items	array of ParticipantResponse	Účastníci přidružené k obálce.
Celkový počet účastníků	total	integer	Celkový počet účastníků dostupných v kolekci

ParticipantResponse

Podrobnosti o účastníkovi Nitro Sign.

Name	Cesta	Typ	Description
ID účastníka	ID	uuid	Jedinečný identifikátor UUID, který identifikuje účastníka.
Email	email	email	E-mailová adresa účastníka.
Úloha	role	string	Role účastníka.
ověřování	authentication	ParticipantAuthenticationResponse	Nastavení ověřování vrácené pro účastníka

ParticipantAuthenticationResponse

Nastavení ověřování vrácené pro účastníka

Name	Cesta	Typ	Description
Typ ověření	type	string	Typ ověřování účastníka.
Přístupový kód	accessCode	string	Přístupový kód nakonfigurovaný pro účastníka.

FileDownloadResponse

Stažený soubor zabalený jako obálka JSON

Name	Cesta	Typ	Description
Název souboru	fileName	string	Název staženého souboru odvozený z hlavičky Content-Disposition odpovědi (například result.zip nebo result.pdf). Tento token přetáhněte přímo do vstupu názvu souboru podřízené akce, jako je OneDrive nebo SharePoint Vytvořit soubor.
Typ obsahu souboru	fileContentType	string	Typ MIME staženého souboru, například application/zip nebo application/pdf.
Obsah souboru	fileContent	byte	Obsah souboru s kódováním base64. Tento token přetáhněte přímo do vstupu obsahu souboru podřízené akce (například OneDrive nebo SharePoint Vytvořit soubor nebo jinou akci Nitro) – nevyžaduje se žádný výraz.