Nitro Sign Enterprise Ověřeno (Preview)
Nitro Sign Enterprise Verified je známé řešení digitálního podpisu, které nabízí obrovské množství metod podpisu a dodržování nejpřímějších (inter)vnitrostátních předpisů. NSEV umožňuje transformovat jakýkoli proces založený na papíře na komplexní digitální tok s jedinečným uživatelským prostředím. Zjednodušte proces podepisování přesně tak, jak ho chcete odeslat, podepsat a sledovat všechny typy dokumentů přímo z vašich oblíbených obchodních aplikací.
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 nitro |
| URL | https://www.gonitro.com/support |
| service@gonitro.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Nitro Software Belgium NV |
| Internetová stránka | https://www.gonitro.com |
| Zásady ochrany osobních údajů | https://www.gonitro.com/legal/privacy-policy |
| Kategorie | IT provoz; Produktivita |
Nitro Sign Enterprise Verified Connector
Nitro Software, specialista v řešeních inteligentních dokumentů, zpřístupnil konektor Nitro Sign Enterprise Verified Connector pro Power Automate pro použití. Konektor umožňuje společnostem předávat dokumenty, které vyžadují digitální podpis přímo ze svých oblíbených aplikací Microsoft 365 – z Microsoft Teams do Wordu, SharePointu, Dynamics, OneDrivu a mnoha dalších. Nitro Sign Enterprise Ověřeno - dříve známé jako Nitro Sign Premium a Connective eSignatures.
Požadavky
Pokud chcete začít používat konektor, vyžaduje se stávající předplatné Nitro Sign Enterprise Verified. Obraťte se na svůj kontakt na Nitro Software nebo přejděte na naši stránku nápovědy a podpory na našich webových stránkách a získejte přihlašovací údaje.
Documentation
Tato stránka dále podrobně rozepíše různé dostupné akce a poskytne přehled o různých způsobech implementace těchto akcí.
Neváhejte se podívat na náš web dokumentace , kde najdete další informace nebo se s týmem podpory spojit prostřednictvím naší stránky nápovědy a podpory nebo poštovní schránky podpory: mailto:service@gonitro.com. Dokumentace k rozhraní API je dostupná také ve formátu Postman.
Glosář je k dispozici pro vysvětlení různých termínů používaných v této dokumentaci.
Podporované operace
Konektor Nitro Sign Enterprise Verified je založený na rozhraní API v4 Nitro Sign Enterprise Ověřeno. Rozhraní API je rozhraní REST API, které umožňuje integraci externích aplikací s funkcemi uvedenými v tomto dokumentu a jejich používání k vytváření a správě podpisových toků.
Dostupné akce je možné seskupit do různých skupin.
| Skupina akcí | Dostupné akce |
|---|---|
| Packages | Získání všech balíčků |
| Získání balíčku podle ID | |
| Získání stavu balíčku | |
| Vytvoření nového balíčku (standardní nebo okamžité) | |
| Odstranění balíčku podle ID | |
| Aktualizace stavu balíčku | |
| Získání data vypršení platnosti balíčku | |
| Aktualizace data vypršení platnosti balíčku | |
| Přeskočit podepisující osoby | |
| Odeslání připomenutí | |
| Stažení balíčku | |
| Stažení záznamu auditu balíčku | |
| Documents | Přidání dokumentu do balíčku |
| Stažení podepsaného dokumentu z balíčku | |
| Účastníci | Odstranění účastníka podle ID |
| Získání všech zúčastněných stran balíčku | |
| Přidání účastníka do balíčku | |
| Proces | Získání všech kroků procesu balíčku |
| Proces | Přidání kroku v procesu balíčku |
| Proces | Přepsání kroků procesu balíčku |
| Proces | Získání všech akcí kroku procesu |
| Proces | Odstranění kroku procesu a všech jeho aktérů |
| Proces | Přidání objektu actor do kroku procesu |
| Proces | Získání všech akcí v aktuálním kroku procesu |
| Other | Získání všech jazyků povolených v aplikaci |
| Získání všech motivů, které je možné přiřadit k balíčku | |
| Získání všech skupin dokumentů, ke kterým je možné přiřadit balíček | |
| Získání všech nakonfigurovaných metod podepisování |
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é |
|---|---|---|---|
| Nitro Sign hostitel | řetězec | a cestu k vašemu prostředí Nitro Sign, např. contoso.sign.gonitro.com/esig | Pravdivé |
| Uživatelské jméno rozhraní API | securestring | Uživatelské jméno rozhraní API pro přístup k rozhraní API | Pravdivé |
| Heslo rozhraní API | securestring | Heslo rozhraní API pro přístup k rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace data vypršení platnosti balíčku |
Aktualizace data vypršení platnosti balíčku |
| Aktualizace stavu balíčku |
Aktualizuje stav balíčku. |
| Načtení všech jazyků, které jsou v aplikaci povolené |
Načte všechny jazyky, které jsou v aplikaci povolené. |
| Načtení všech motivů, které lze přiřadit k balíčku |
Načte všechny motivy, které lze přiřadit k balíčku. Možné stránkovat výsledek zadáním MaxQuantity a pokračováníToken |
| Načtení všech skupin dokumentů, ke kterým lze balíčky přiřadit |
Načte všechny skupiny dokumentů, ke kterým lze balíčky přiřadit. |
| Odeslání připomenutí balíčku |
Zásady společnosti můžou vyžadovat, aby se dokument zpracovával v daném časovém rozpětí. Když se aktivuje volání "Odeslat připomenutí", vyhledá se všichni, kteří se nepřihlásili, a pošlete jim další oznámení jako připomenutí. |
| Odstranění balíčku podle ID |
Odstraní balíček podle jeho ID. |
| Odstranění kroku procesu a všech jeho aktérů |
Odstraní krok procesu a všechny jeho aktéry. |
| Odstranění účastníka podle ID |
Odstraní účastníka jeho ID. |
| Přepsání kroků procesu balíčku |
Přepíše všechny aktéry v balíčku pomocí 2D pole, kde každá sada herců jsou akce, které je možné provádět paralelně. |
| Přeskočit podepisující osoby |
Toto volání přeskočí všechny podepisující osoby, které ještě nebyly dokončeny, a nastaví jejich stav na Vynecháno, což vede k označení kompletního balíčku jako Dokončeno. |
| Přidání dokumentu do balíčku |
Přidá dokument do existujícího balíčku. |
| Přidání kroku v procesu balíčku |
Přidá do procesu balíčku sadu akcí. |
| Přidání objektu actor do kroku procesu |
Přidá objekt actor do kroku procesu. |
| Přidání účastníka do balíčku |
Přidá účastníka do balíčku. |
| Stažení záznamu auditu balíčku |
Stáhněte si podepsaný záznam auditu o životnosti balíčku. |
| Stáhnout balíček |
Používá se ke stažení všech dokumentů v určitém balíčku jako soubor ZIP. |
| Stáhnout dokument z balíčku |
Stáhněte si podepsaný dokument z balíčku. Každý dokument se stáhne jako soubor PDF nebo XML. |
| Vrácení všech metod podepisování, které jsou aktuálně nakonfigurované |
Vrátí všechny metody podepisování, které jsou aktuálně nakonfigurované. |
| Vytvoření nového balíčku (standardní nebo okamžité) |
Vytvoří nový balíček. Ve výchozím nastavení se balíček vytvoří jako koncept. Chcete-li vytvořit okamžitý balíček, který je okamžitě připravený k podepisování, nastavte
Poznámka: Koncový |
| Získání balíčku podle ID |
Načte balíček podle jeho ID. |
| Získání data vypršení platnosti balíčku |
Načtení data vypršení platnosti balíčku |
| Získání stavu balíčku |
Načte aktuální stav balíčku. |
| Získání všech akcí kroku procesu |
Získá konkrétní sadu akcí, které lze dokončit paralelně z procesu. |
| Získání všech akcí v aktuálním kroku procesu |
Získá aktuální sadu akcí, které lze dokončit paralelně. |
| Získání všech balíčků |
Získá všechny balíčky, ty jsou seřazené podle creationDate |
| Získání všech kroků procesu |
Získá všechny akce, které bude nutné provést v balíčku. |
| Získání všech zúčastněných stran balíčku |
Načte zúčastněné strany balíčku. |
Aktualizace data vypršení platnosti balíčku
Aktualizace data vypršení platnosti balíčku
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Hodnota data a času ve formátu ISO 8601 |
Aktualizace stavu balíčku
Aktualizuje stav balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
body
|
body | True | string |
Načtení všech jazyků, které jsou v aplikaci povolené
Načte všechny jazyky, které jsou v aplikaci povolené.
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
EnabledLanguages
|
EnabledLanguages | array of object |
Seznam povolených jazyků |
|
ZobrazovanéJméno
|
EnabledLanguages.DisplayName | string |
Zobrazovaný název jazyka |
|
NativeName
|
EnabledLanguages.NativeName | string |
Nativní název jazyka |
|
IsoCultureCode
|
EnabledLanguages.IsoCultureCode | string |
2 písmena ISO (ISO 639-1) jazyka |
Načtení všech motivů, které lze přiřadit k balíčku
Načte všechny motivy, které lze přiřadit k balíčku. Možné stránkovat výsledek zadáním MaxQuantity a pokračováníToken
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Token pro získání další sady výsledků
|
continuationToken | string |
Token pro získání další sady výsledků |
|
|
Maximální počet výsledků, které se mají vrátit
|
maxQuantity | integer |
Maximální počet výsledků, které se mají vrátit |
|
|
Pořadí řazení výsledků
|
sortOrder | string |
Pořadí řazení výsledků |
|
|
zadejte, podle kterého pole se má seřadit.
|
sortField | string |
zadejte, podle kterého pole se má seřadit. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Token pokračování
|
ContinuationToken | string |
Token pro načtení další stránky výsledků |
|
Položky
|
Items | array of object |
Seznam obsahující motivy |
|
Code
|
Items.Code | string |
Kód motivu |
|
Název
|
Items.Name | string |
Název motivu |
|
MaxQuantity
|
MaxQuantity | integer |
Maximální počet výsledků, které se vrátí na požadavek |
|
Total
|
Total | integer |
Celkový počet výsledků |
Načtení všech skupin dokumentů, ke kterým lze balíčky přiřadit
Načte všechny skupiny dokumentů, ke kterým lze balíčky přiřadit.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název skupiny dokumentů (nebo jeho část) pro hledání
|
name | string |
Název skupiny dokumentů (nebo jeho část) pro hledání |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
DocumentGroups
|
DocumentGroups | array of object |
Seznam skupin dokumentů |
|
Code
|
DocumentGroups.Code | string |
Kód skupiny dokumentů |
|
Název
|
DocumentGroups.Name | string |
Název skupiny dokumentů |
Odeslání připomenutí balíčku
Zásady společnosti můžou vyžadovat, aby se dokument zpracovával v daném časovém rozpětí. Když se aktivuje volání "Odeslat připomenutí", vyhledá se všichni, kteří se nepřihlásili, a pošlete jim další oznámení jako připomenutí.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Odstranění balíčku podle ID
Odstraní balíček podle jeho ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Odstranění kroku procesu a všech jeho aktérů
Odstraní krok procesu a všechny jeho aktéry.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Index kroku procesu
|
stepIndex | True | integer |
Index kroku procesu |
Odstranění účastníka podle ID
Odstraní účastníka jeho ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Jedinečný identifikátor účastníka
|
stakeholderId | True | string |
Jedinečný identifikátor účastníka |
Přepsání kroků procesu balíčku
Přepíše všechny aktéry v balíčku pomocí 2D pole, kde každá sada herců jsou akce, které je možné provádět paralelně.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Typ
|
Type | True | string |
Typ akce, která se bude muset provést u balíčku |
|
Id účastníka
|
StakeholderId | True | string |
Identifikátor účastníka balíčku |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
|
identifikační číslo
|
Id | string |
Identifikátor existujícího prvku. Pokud se použije, všechna ostatní pole by měla být prázdná. |
|
|
Typ
|
Type | string |
Typ elementu |
|
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
Id dokumentu
|
DocumentId | string |
Identifikátor dokumentu v balíčku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Jazyk
|
Language | string |
2mísmenný kód ISO země (ISO 639-1) |
Přeskočit podepisující osoby
Toto volání přeskočí všechny podepisující osoby, které ještě nebyly dokončeny, a nastaví jejich stav na Vynecháno, což vede k označení kompletního balíčku jako Dokončeno.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Přidání dokumentu do balíčku
Přidá dokument do existujícího balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Název
|
Name | True | string |
Název dokumentu |
|
IsOptional
|
IsOptional | boolean |
Označuje, jestli má být dokument volitelný pro podepisování. |
|
|
Jazyk
|
Language | True | string |
2mísmenný kód ISO země (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
Globálně jedinečný identifikátor |
|
|
Typ cíle
|
TargetType | string |
Bude fungovat jenom v případě, že je server nakonfigurovaný pro převody dokumentů. |
|
|
TargetFormat
|
TargetFormat | string |
Cílový formát definuje, jestli je potřeba provést převod navíc. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Jak řešit soubory PDF obsahující drobné nedostatky |
|
|
Typ obsahu
|
ContentType | True | string |
Typ MIME dokumentu |
|
Base64Data
|
Base64Data | True | byte |
Obsah dokumentu s kódováním Base64 |
|
Typ
|
Type | True | string |
Typ elementu |
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Jazyk
|
Language | string |
2mísmenný kód ISO země (ISO 639-1) |
Návraty
- Body
- Response.Document
Přidání kroku v procesu balíčku
Přidá do procesu balíčku sadu akcí.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Typ
|
Type | True | string |
Typ akce, která se bude muset provést u balíčku |
|
Id účastníka
|
StakeholderId | True | string |
Identifikátor účastníka balíčku |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
|
identifikační číslo
|
Id | string |
Identifikátor existujícího prvku. Pokud se použije, všechna ostatní pole by měla být prázdná. |
|
|
Typ
|
Type | string |
Typ elementu |
|
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
Id dokumentu
|
DocumentId | string |
Identifikátor dokumentu v balíčku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Jazyk
|
Language | string |
2mísmenný kód ISO země (ISO 639-1) |
Návraty
Sada objektů actor v kroku procesu.
- response
- array of Response.Actor
Přidání objektu actor do kroku procesu
Přidá objekt actor do kroku procesu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Index kroku procesu
|
stepIndex | True | integer |
Index kroku procesu |
|
Typ
|
Type | True | string |
Typ akce, která se bude muset provést u balíčku |
|
Id účastníka
|
StakeholderId | True | string |
Identifikátor účastníka balíčku |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
|
identifikační číslo
|
Id | string |
Identifikátor existujícího prvku. Pokud se použije, všechna ostatní pole by měla být prázdná. |
|
|
Typ
|
Type | string |
Typ elementu |
|
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
Id dokumentu
|
DocumentId | string |
Identifikátor dokumentu v balíčku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Jazyk
|
Language | string |
2mísmenný kód ISO země (ISO 639-1) |
Návraty
- Body
- Response.Actor
Přidání účastníka do balíčku
Přidá účastníka do balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Typ
|
Type | True | string |
Typ účastníka |
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Jazyk
|
Language | True | string |
2mísmenný kód ISO země (ISO 639-1) |
|
Křestní jméno
|
FirstName | string |
Jméno účastníka |
|
|
Příjmení
|
LastName | True | string |
Příjmení účastníka |
|
E-mailová adresa
|
EmailAddress | True |
E-mailová adresa |
|
|
Datumnarození
|
BirthDate | date | ||
|
Telefonní číslo
|
PhoneNumber | string |
Telefonní číslo |
|
|
AdditionalProperties
|
AdditionalProperties | object |
Konfigurovatelné další vlastnosti účastníka |
|
|
Typ
|
Type | True | string |
Typ akce, která se bude muset provést u balíčku |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
|
Typ přesměrování
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
Adresa URL, na kterou se uživatel odešle po zavření relace |
|
|
identifikační číslo
|
Id | string |
Identifikátor existujícího prvku. Pokud se použije, všechna ostatní pole by měla být prázdná. |
|
|
Typ
|
Type | string |
Typ elementu |
|
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
Id dokumentu
|
DocumentId | string |
Identifikátor dokumentu v balíčku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Jazyk
|
Language | string |
2mísmenný kód ISO země (ISO 639-1) |
Návraty
- Body
- Response.Stakeholder
Stažení záznamu auditu balíčku
Stáhněte si podepsaný záznam auditu o životnosti balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Kód ISO (ISO 639-1)
|
culture | True | string |
Kód ISO (ISO 639-1) |
Návraty
- response
- binary
Stáhnout balíček
Používá se ke stažení všech dokumentů v určitém balíčku jako soubor ZIP.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
- response
- binary
Stáhnout dokument z balíčku
Stáhněte si podepsaný dokument z balíčku. Každý dokument se stáhne jako soubor PDF nebo XML.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Jedinečný identifikátor dokumentu obsaženého v balíčku
|
documentId | True | string |
Jedinečný identifikátor dokumentu obsaženého v balíčku |
Návraty
- response
- binary
Vrácení všech metod podepisování, které jsou aktuálně nakonfigurované
Vrátí všechny metody podepisování, které jsou aktuálně nakonfigurované.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vrátit pouze aktivní nebo neaktivní metody podepisování
|
isActive | boolean |
Vrátit pouze aktivní nebo neaktivní metody podepisování |
Návraty
- response
- array of ConfiguredSigningMethod
Vytvoření nového balíčku (standardní nebo okamžité)
Vytvoří nový balíček. Ve výchozím nastavení se balíček vytvoří jako koncept. Chcete-li vytvořit okamžitý balíček, který je okamžitě připravený k podepisování, nastavte status vlastnost na Pending.
Poznámka: Koncový POST /packages bod umožňuje vytvářet standardní i okamžité balíčky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název
|
Name | True | string |
Název balíčku |
|
Initiator
|
Initiator | True |
E-mailová adresa |
|
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Stav
|
Status | string |
Stav vytvořeného balíčku.
|
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Kód skupiny dokumentů pro balíček |
|
|
Datum vypršení platnosti
|
ExpiryDate | date-time |
Hodnota data a času ve formátu ISO 8601 |
|
|
Název
|
Name | True | string |
Název dokumentu |
|
IsOptional
|
IsOptional | boolean |
Označuje, jestli má být dokument volitelný pro podepisování. |
|
|
Jazyk
|
Language | True | string |
2mísmenný kód ISO země (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
Globálně jedinečný identifikátor |
|
|
Typ cíle
|
TargetType | string |
Bude fungovat jenom v případě, že je server nakonfigurovaný pro převody dokumentů. |
|
|
TargetFormat
|
TargetFormat | string |
Cílový formát definuje, jestli je potřeba provést převod navíc. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Jak řešit soubory PDF obsahující drobné nedostatky |
|
|
Typ obsahu
|
ContentType | True | string |
Typ MIME dokumentu |
|
Base64Data
|
Base64Data | True | byte |
Obsah dokumentu s kódováním Base64 |
|
Typ
|
Type | True | string |
Typ elementu |
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Typ
|
Type | True | string |
Typ účastníka |
|
ExternalReference
|
ExternalReference | string |
Externí referenční informace pro balíček |
|
|
Jazyk
|
Language | True | string |
2mísmenný kód ISO země (ISO 639-1) |
|
Křestní jméno
|
FirstName | string |
Jméno účastníka |
|
|
Příjmení
|
LastName | True | string |
Příjmení účastníka |
|
E-mailová adresa
|
EmailAddress | True |
E-mailová adresa |
|
|
Datumnarození
|
BirthDate | date | ||
|
Telefonní číslo
|
PhoneNumber | string |
Telefonní číslo |
|
|
AdditionalProperties
|
AdditionalProperties | object |
Konfigurovatelné další vlastnosti účastníka |
|
|
Typ
|
Type | True | string |
Typ akce, která se bude muset provést u balíčku |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
|
Typ přesměrování
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
Adresa URL, na kterou se uživatel odešle po zavření relace |
|
|
ProcessStep
|
ProcessStep | integer |
Číslo kroku procesu |
|
|
DocumentIndex
|
DocumentIndex | True | integer |
Index dokumentu v balíčku (počínaje 0) – k dispozici pouze v koncovém bodu Vytvořit balíček |
|
Typ
|
Type | True | string |
Typ elementu |
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
|
|
Šířka
|
Width | number |
Šířka elementu |
|
|
Výška
|
Height | number |
Výška prvku |
|
|
SigningMethods
|
SigningMethods | True | array of string | |
|
Název
|
Name | string |
Název právního oznámení, které se má přidat do podpisového pole. |
|
|
Content
|
Content | string |
Vlastní obsah právního oznámení |
|
|
Kód motivu
|
ThemeCode | string |
Identifikátor motivu balíčku |
|
|
CallBackUrl
|
CallBackUrl | url |
Adresa URL zpětného volání po provedení akcí |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | url |
Adresa URL zpětného volání, když podepisující uživatel požádá o novou podpisovou adresu URL |
|
|
DefaultRedirectUrl
|
DefaultRedirectUrl | url |
Adresa URL přesměrování po dokončení akce |
|
|
F2fRedirectUrl
|
F2fRedirectUrl | url |
Přesměrování adresy URL po podepisování tváří v tvář |
|
|
IsUnsignedContentDownloadable
|
IsUnsignedContentDownloadable | boolean |
Zda lze stáhnout nepodepsaný obsah |
|
|
IsReassignEnabled
|
IsReassignEnabled | boolean |
Jestli je povolené opětovné přiřazení |
Návraty
- Body
- Response.Package.Get
Získání balíčku podle ID
Načte balíček podle jeho ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
- Body
- Response.Package.Get
Získání data vypršení platnosti balíčku
Načtení data vypršení platnosti balíčku
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
Hodnota data a času ve formátu ISO 8601
- response
- Common.DateTime
Získání stavu balíčku
Načte aktuální stav balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
Získání všech akcí kroku procesu
Získá konkrétní sadu akcí, které lze dokončit paralelně z procesu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
|
Index kroku procesu
|
stepIndex | True | integer |
Index kroku procesu |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
Items | array of Response.Actor |
Získání všech akcí v aktuálním kroku procesu
Získá aktuální sadu akcí, které lze dokončit paralelně.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
Items | array of Response.Actor |
Získání všech balíčků
Získá všechny balíčky, ty jsou seřazené podle creationDate
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky, které se má načíst
|
pageNumber | integer |
Číslo stránky, které se má načíst |
|
|
Počet položek na stránku
|
pageSize | integer |
Počet položek na stránku |
|
|
Vrácení balíčků vytvořených před tímto datem
|
createdBefore | date-time |
Vrácení balíčků vytvořených před tímto datem |
|
|
Vrácení balíčků vytvořených po tomto datu
|
createdAfter | date-time |
Vrácení balíčků vytvořených po tomto datu |
|
|
Stav balíčků, které se mají filtrovat
|
status | string |
Stav balíčků, které se mají filtrovat |
|
|
Kód skupiny dokumentů pro filtrování balíčků
|
documentGroupCode | string |
Kód skupiny dokumentů pro filtrování balíčků |
|
|
E-mail iniciátoru balíčku pro filtrování
|
initiator |
E-mail iniciátoru balíčku pro filtrování |
||
|
Název balíčku, který se má filtrovat
|
packageName | string |
Název balíčku, který se má filtrovat |
|
|
Externí odkazy na balíčky filtrů
|
externalReference | string |
Externí odkazy na balíčky filtrů |
|
|
Určete, jak se výsledek seřadí, výchozí hodnota je sestupná.
|
sort | string |
Určete, jak se výsledek seřadí, výchozí hodnota je sestupná. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Číslo stránky
|
PageNumber | integer |
Číslo aktuální stránky |
|
PageSize
|
PageSize | integer |
Počet položek na stránku |
|
TotalPages
|
TotalPages | integer |
Celkový počet stránek |
|
TotalItems
|
TotalItems | integer |
Celkový počet položek |
|
Položky
|
Items | array of Response.Package.Get |
Získání všech kroků procesu
Získá všechny akce, které bude nutné provést v balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
|
array of array | ||
|
items
|
array of Response.Actor |
Sada objektů actor v kroku procesu. |
Získání všech zúčastněných stran balíčku
Načte zúčastněné strany balíčku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor balíčku
|
packageId | True | string |
Jedinečný identifikátor balíčku |
Návraty
- response
- array of Response.Stakeholder
Definice
KonfiguraceSigningMethod
Nakonfigurovaná metoda podepisování v eSignatures
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
IsActive
|
IsActive | boolean |
Zda lze podpisMethod použít k vytváření nových podpisových polí |
|
Název
|
Name | string |
Nakonfigurovaný název metody podepisování |
|
DisplayNames
|
DisplayNames | object |
Název podle jazyka, který se zobrazí podepisující znaménku |
|
DisplayNamesInitiator
|
DisplayNamesInitiator | object |
Název podle jazyka, který se má při vytváření balíčku zobrazovat iniciátoru. |
|
Popisy
|
Descriptions | object |
Popis metody podepisování podle jazyka, který poskytuje další informace o metodě podepisování během vytváření balíčku. |
|
RequiredProperties
|
RequiredProperties | array of string |
Požadované vlastnosti pro podepisování s mandátem |
|
Klíčové klíče
|
KeyPairs | array of KeyPair |
k dispozici KeyPairs, které lze použít k podepsání pomocí této metody |
KeyPair
reprezentace páru podpisových klíčů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název
|
Name | string |
Název páru klíčů |
|
DisplayNames
|
DisplayNames | object |
Název podle jazyka, který se zobrazí iniciátoru |
Common.Guid
Common.EmailAddress
Common.Language
Common.PhoneNumber
Common.ExternalReference
Common.AdditionalProperties
Konfigurovatelné další vlastnosti účastníka
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
|
object |
Konfigurovatelné další vlastnosti účastníka |
Common.DateTime
Package.Status
Package.Name
Document.Name
Document.Status
Document.DocumentOptions
Definuje volitelné parametry dokumentu.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Typ cíle
|
TargetType | string |
Bude fungovat jenom v případě, že je server nakonfigurovaný pro převody dokumentů. |
|
TargetFormat
|
PdfOptions.TargetFormat | string |
Cílový formát definuje, jestli je potřeba provést převod navíc. |
|
PdfErrorHandling
|
PdfOptions.PdfErrorHandling | string |
Jak řešit soubory PDF obsahující drobné nedostatky |
Stakeholder.FirstName
Účastník.LastName
Actor.Type
Typ akce, která se bude muset provést u balíčku
Typ akce, která se bude muset provést u balíčku
Actor.Status
Element.Type
Element.Status
Element.Location
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stránka
|
Page | integer |
Číslo stránky dokumentu |
|
Vrchol
|
Top | number |
Horní pozice v pixelech |
|
Vlevo
|
Left | number |
Pozice vlevo v pixelech |
Element.Dimensions
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Šířka
|
Width | number |
Šířka elementu |
|
Výška
|
Height | number |
Výška prvku |
Response.Package.Get
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
Id | Common.Guid |
Globálně jedinečný identifikátor |
|
Název
|
Name | Package.Name |
Název balíčku |
|
Initiator
|
Initiator | Common.EmailAddress |
E-mailová adresa |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externí referenční informace pro balíček |
|
Datum vytvoření
|
CreationDate | Common.DateTime |
Hodnota data a času ve formátu ISO 8601 |
|
Stav
|
Status | Package.Status |
Stav balíčku |
|
Datum vypršení platnosti
|
ExpiryDate | Common.DateTime |
Hodnota data a času ve formátu ISO 8601 |
|
Documents
|
Documents | array of Response.Document | |
|
Účastníci
|
Stakeholders | array of Response.Stakeholder |
Response.Document
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
Id | Common.Guid |
Globálně jedinečný identifikátor |
|
Stav
|
Status | Document.Status |
Stav dokumentu |
|
DocumentOptions
|
DocumentOptions | Document.DocumentOptions |
Definuje volitelné parametry dokumentu. |
|
Název
|
Name | Document.Name |
Název dokumentu |
|
Jazyk
|
Language | Common.Language |
2mísmenný kód ISO země (ISO 639-1) |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externí referenční informace pro balíček |
|
ProofCorrelationId
|
ProofCorrelationId | Common.Guid |
Globálně jedinečný identifikátor |
Response.Stakeholder
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Typ
|
Type | string |
Typ účastníka |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externí referenční informace pro balíček |
|
identifikační číslo
|
Id | Common.Guid |
Globálně jedinečný identifikátor |
|
Jazyk
|
Language | Common.Language |
2mísmenný kód ISO země (ISO 639-1) |
|
Křestní jméno
|
FirstName | Stakeholder.FirstName |
Jméno účastníka |
|
Příjmení
|
LastName | Stakeholder.LastName |
Příjmení účastníka |
|
E-mailová adresa
|
EmailAddress | Common.EmailAddress |
E-mailová adresa |
|
Datumnarození
|
BirthDate | date | |
|
Telefonní číslo
|
PhoneNumber | Common.PhoneNumber |
Telefonní číslo |
|
AdditionalProperties
|
AdditionalProperties | Common.AdditionalProperties |
Konfigurovatelné další vlastnosti účastníka |
|
Actors
|
Actors | array of Response.Actor |
Response.Actor
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Typ
|
Type | Actor.Type |
Typ akce, která se bude muset provést u balíčku |
|
identifikační číslo
|
Id | Common.Guid |
Globálně jedinečný identifikátor |
|
Id účastníka
|
StakeholderId | Common.Guid |
Globálně jedinečný identifikátor |
|
Stav
|
Status | Actor.Status |
Stav objektu actor |
|
Potlačení poznámek
|
SuppressNotifications | boolean |
Potlačení oznámení pro objekt actor |
|
RedirectUrl
|
RedirectUrl | url |
Adresa URL přesměrování po dokončení akce objektu actor |
|
Elements
|
Elements | array of Response.Element |
Response.Element
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Typ
|
Type | Element.Type |
Typ elementu |
|
identifikační číslo
|
Id | Common.Guid |
Globálně jedinečný identifikátor |
|
ActorId
|
ActorId | Common.Guid |
Globálně jedinečný identifikátor |
|
Id dokumentu
|
DocumentId | integer |
Identifikátor dokumentu v balíčku |
|
Stav
|
Status | Element.Status |
Stav elementu |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
Externí referenční informace pro balíček |
|
Umístění
|
Location | Element.Location | |
|
Dimenze
|
Dimensions | Element.Dimensions | |
|
SigningMethods
|
SigningMethods | array of string | |
|
UsedSigningMethod
|
UsedSigningMethod | string |
Použitá metoda podepisování |
Response.Package.Status
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
Status | Package.Status |
Stav balíčku |
binární
Toto je základní datový typ Binary.