Sdílet prostřednictvím

Ověřený

Konektor pro ověřené rozhraní API umožňující vytváření vlastních procesů podepisování dokumentů

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 Ověřený
URL https://verified.eu/en/#about-us
Email support@verified.eu
Metadata konektoru
Vydavatel Crm - Konsulterna i Sverige AB
Internetová stránka https://verified.eu/
Zásady ochrany osobních údajů https://verified.eu/trust-center
Kategorie Obsah a soubory; Produktivita

Ověřeno je software jako poskytovatel služeb elektronické identifikace a digitálního podepisování. Tento konektor umožňuje integraci do rozhraní API ověřeného rozhraní API a vytváření jednoduchých a intuitivních podpisových procesů v rámci vaší aplikace.

Požadavky

Abyste mohli pokračovat, budete potřebovat následující:

Jak získat přihlašovací údaje

Tento konektor používá základní ověřování. Uživatel musí při vytváření připojení prezentovat uživatelské jméno, heslo a ID společnosti. Uživatelské jméno a heslo jsou stejné jako pro přihlášení k ověřenému portálu. Pokud chcete získat ID společnosti, které musíte přihlásit k ověřenému portálu, vyberte správnou společnost, pokud máte několik a zkopírujte ID společnosti z adresy URL.

Začínáme

Běžným případem použití je zahájení a správa procesu podepisování, tj. nastavení automatizace pro odesílání dokumentů, které se mají pravidelně podepsat do ověřených a podepsaných dokumentů. Mezi běžné akce, které se používají k zahájení ověřeného procesu podepisování, patří Vytvoření obálky – popisovač nebo Vytvořit obálku – výchozí, Přidat dokument do obálky, Přidat soubor do dokumentu, Přidat příjemce do obálky a Aktualizovat stav publikování obálky. Mezi běžné akce, které se používají ke kontrole stavu ověřených dokumentů, patří Získání obálky podle ID, Získání všech dokumentů podle ID obálky, Získání souborů podle ID dokumentu, Získání adresy URL souboru podle ID. Všimněte si, že akce Generovat token zabezpečení se vždy používá jako první krok k získání tokenu zabezpečení, který se má použít v následujících krocích.

Známé problémy a omezení

V současné době jsou známa následující omezení.

  • Na začátku každého toku je nutné vytvořit ověřovací token, který se má znovu použít v každém následujícím kroku.
  • Pokud chcete přidat dokument, který musí odeslat požadavek HTTP na určitou adresu URL.
  • Pokud chcete použít nový koncový bod vyhledávání, musí být pro účet aktivován prostřednictvím ověřeného suppoertu.

časté otázky

Jak nahraji dokument do ověřeného?

Pokud chcete nahrát skutečný dokument, musíte vytvořit soubor v ověřeném rozhraní API a nahrát hodnotu hash dokumentu do adresy URL objektu blob, která odpověděla z ověřeného rozhraní API.

Jak se dá obálka po použití akce Získat ID obálky podržet?

Kroky, které vytvoří obálku s identifikátorem uid, což je úplná cesta k obálce (například :/envelopes/ABCDE). Pro další kroky jedna potřebuje jenom poslední část identifikátoru uID (což je skutečné ID obálky v našem příkladu "ABCDE").

Tady je příklad toho, jak to udělat.

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Jak získám id dokumentu po použití akce Přidat dokument k obálce?

Kroky, které vytvoří dokument, odpoví umístěním nového dokumentu v záhlaví. Umístění je úplná cesta k dokumentu (příklad: /api/envelopes/ABCDE/documents/FGHIJ). Pro následující kroky je potřeba pouze ID dokumentu (v našem případě: FGHIJ).

Tady je příklad toho, jak to udělat.

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

Jak získám ID toku z obálky?

Když jeden načte informace o obálce, související tok bude součástí odpovědi (příklad: "/flow/default"). V odpovědi se nazývá ID toku, ale jedna z nich potřebuje pouze poslední část, když další krok (například Stav toku) žádá o ID toku.

Tady je příklad toho, jak to udělat.

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

Jak můžu použít novou akci hledání?

Aby bylo možné používat novou akci hledání, musí být koncový bod vyhledávání aktivován pro vaši ověřenou organizaci. K tomu musíte napsat e-mail na ověřenou podporu včetně ID vaší organizace, aby mohl aktivovat koncový bod za vás.

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é
uživatelské jméno securestring Uživatelské jméno pro toto rozhraní API Pravdivé
heslo securestring Heslo pro toto rozhraní API Pravdivé
ID společnosti řetězec ID společnosti je poskytováno ověřením. Adresu URL najdete tak, že se přihlásíte k app.verified.eu Pravdivé

Limity omezování

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

Akce

Aktualizace nastavení obálky

Aktualizuje nastavení dané obálky.
Aktualizace příjemce podle ID

Aktualizuje příjemce.
Aktualizace stavu publikování pro obálku

Aktualizuje stav publikování dané obálky.
Dotazování na všechny obálky (zastaralé)

Dotazuje všechny obálky odpovídající danému filtru. (Zastaralé)
Generování dokumentu ze šablony

Vygeneruje dokument z předkonfigurované šablony.
Generování tokenu zabezpečení

Získá ověřovací token z ověřeného rozhraní API.
Hledat všechny obálky

Prohledejte všechny obálky odpovídající danému filtru.
Nastavení stavu koše obálky

Nastaví stav dané obálky na vyhození.
Nastavení stavu přerušení dokumentu

Nastaví stav daného dokumentu na přerušený.
Nastavení stavu přerušení obálky

Nastaví stav dané obálky na přerušenou.
Odeslat oznámení

Odešle oznámení, aby se znovu zobrazila daná obálka.
Odstranění dokumentu podle ID

Odstraní daný dokument.
Odstranění obálky podle ID

Odstraní danou obálku.
Přidání dokumentu do obálky

Přidá nový dokument do existující obálky.
Přidání příjemce do obálky

Přidá příjemce na danou obálku.
Přidání souboru do dokumentu

Přidá soubor do existujícího dokumentu.
Vytvoření obálky – popisovač

Vytvoří obálku založenou na konkrétním popisovači.
Vytvoření obálky – výchozí

Vytvoří novou obálku pomocí výchozího popisovače.
Vytvořit odkaz na podpis

Vytvoří odkaz na podpis. Implementace je specifická a může chybět pro váš konkrétní tok.
Získání adresy URL souboru podle ID

Získá adresu URL k danému souboru.
Získání dokumentu podle ID

Získá informace o daném dokumentu.
Získání informací o uživateli

Získá informace o aktuálně přihlášeného uživatele.
Získání konkrétního příjemce obálky

Získá konkrétního příjemce pro danou obálku.
Získání obálky podle ID

Získá podrobnosti o dané obálce.
Získání popisovače podle ID

Získá informace o daném popisovači.
Získání souboru podle ID

Získá informace o daném souboru.
Získání souborů podle ID dokumentu

Získá všechny soubory připojené k danému dokumentu.
Získání společnosti podle ID

Získá informace o dané společnosti.
Získání stavu toku podle ID obálky

Získá aktuální stav toku dané obálky.
Získání uživatelských nastavení

Získá nastavení daného uživatele.
Získání výchozího popisovače

Získá výchozí popisovač pro obálky.
Získání všech dokumentů podle ID obálky

Získá všechny dokumenty související s danou obálkou.
Získání všech popisovačů

Získá seznam všech popisovačů, které jsou přítomné v aktuální společnosti. Seznam je možné filtrovat.
Získání všech příjemců obálky

Získá všechny příjemce dané obálky.

Aktualizace nastavení obálky

ID operace:
PutEnvelopesEnvelopeId

Aktualizuje nastavení dané obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Sekvenční podepisování
 sequentialSigning boolean
Pozdrav
 greeting string
Vypršení platnosti
 expiration date

Datum v následujícím formátu 2017-02-26T21:59:59.999Z
Automatické připomenutí
 automaticReminders number

X dny před vypršením platnosti

Aktualizace příjemce podle ID

ID operace:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Aktualizuje příjemce.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID příjemce
 recipient-id True string

ID dotčených příjemců
Křestní jméno
 givenName True string
Příjmení
 familyName True string
Jazyk
 language True string
Metoda podepisování
 signingMethod True string
Metoda oznámení
 notificationMethod string
E-mail
 email True string
Telefon
 telephone string

Formát by měl být +<countryCode><telephonenumber>
Objednávka
 order integer
Činnost
 action True string

Ověřený název akce, která má příjemce provést.
Označení
 label True string

Popisek role nebo akce příjemce
Název
 name True string

Ověřený název role příjemce
Bezpečný
 secure boolean
služba SMS
 sms boolean
ČSP
 ssn string
Banka
 bank string

Aktualizace stavu publikování pro obálku

ID operace:
PutEnvelopesEnvelopeIdPublishStatus

Aktualizuje stav publikování dané obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Publikováno
 published True boolean

Dotazování na všechny obálky (zastaralé)

ID operace:
GetQueryEnvelopes

Dotazuje všechny obálky odpovídající danému filtru. (Zastaralé)

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
Filtry
 filters string

Filtrování dotazu pro výběr dílčího připojení
Od
 from integer

Od data
Omezení
 limit integer

Částka limitu
Seřadit
 sort string

Seřadit podle

Návraty

response
array of EnvelopeDescriptorString

Generování dokumentu ze šablony

ID operace:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Vygeneruje dokument z předkonfigurované šablony.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu
ID šablony
 template-id True string

ID šablony, která se má použít
object

Generování tokenu zabezpečení

ID operace:
PostAuthenticate

Získá ověřovací token z ověřeného rozhraní API.

Parametry

Name Klíč Vyžadováno Typ Description
Bez uzamčení IP adresy
 withoutIpLock True integer

Jestli ověření aktivuje zámek PROTOKOLU IP (0, výchozí) nebo ne (1)

Návraty

Name Cesta Typ Description
Žeton
 token string

Token přístupu

Hledat všechny obálky

ID operace:
GetSearchEnvelopes

Prohledejte všechny obálky odpovídající danému filtru.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
Filtry
 filters string

Filtrování dotazu pro výběr dílčího připojení
Od
 from integer

Od data
Omezení
 limit integer

Částka limitu
Seřadit
 sort string

Seřadit podle

Návraty

response
array of EnvelopeDescriptorString

Nastavení stavu koše obálky

ID operace:
PutEnvelopesEnvelopeIdTrashStatus

Nastaví stav dané obálky na vyhození.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Comment
 comment string

Nastavení stavu přerušení dokumentu

ID operace:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Nastaví stav daného dokumentu na přerušený.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu

Nastavení stavu přerušení obálky

ID operace:
PutEnvelopesEnvelopeIdAbortStatus

Nastaví stav dané obálky na přerušenou.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
komentář
 comment string

Odeslat oznámení

ID operace:
PostEnvelopesEnvelopIdJobsSendNotification

Odešle oznámení, aby se znovu zobrazila daná obálka.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Pozdrav
 greeting string
ID příjemce
 id True string

ID příjemce, na který má být oznámení odesláno.

Odstranění dokumentu podle ID

ID operace:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Odstraní daný dokument.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu

Odstranění obálky podle ID

ID operace:
DeleteEnvelopesEnvelopeId

Odstraní danou obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky

Přidání dokumentu do obálky

ID operace:
PostEnvelopesEnvelopeIdDocuments

Přidá nový dokument do existující obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Hash
 hash integer
Název
 name True string
Zdroj
 source string

Přidání příjemce do obálky

ID operace:
PostEnvelopesEnvelopeIdRecipients

Přidá příjemce na danou obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
Křestní jméno
 givenName True string
Příjmení
 familyName True string
Jazyk
 language True string
Metoda podepisování
 signingMethod True string
Metoda oznámení
 notificationMethod string
E-mail
 email True string
Telefon
 telephone string

Formát by měl být +<countryCode><telephonenumber>
Objednávka
 order integer
Činnost
 action True string

Ověřený název akce, která má příjemce provést.
Označení
 label True string

Popisek role nebo akce příjemce
Název
 name True string

Ověřený název role příjemce
Bezpečný
 secure boolean
služba SMS
 sms boolean
ČSP
 ssn string
Banka
 bank string

Přidání souboru do dokumentu

ID operace:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Přidá soubor do existujícího dokumentu.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu
Název
 name True string
FileType
 fileType True string
Hash
 hash string

Návraty

File
File

Vytvoření obálky – popisovač

ID operace:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Vytvoří obálku založenou na konkrétním popisovači.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID popisovače obálky
 envelope-descriptor-id True string

ID popisovače obálky
Email
 email string
Křestní jméno
 givenName string
Příjmení
 familyName string
Automatické připomenutí
 automaticReminders number
Vypršení platnosti
 expiration string
Hash
 hash string

Návraty

Name Cesta Typ Description
uid
 uid string

Vytvoření obálky – výchozí

ID operace:
PostEnvelopeDescriptorsDefaultEnvelopes

Vytvoří novou obálku pomocí výchozího popisovače.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
Email
 email string
Křestní jméno
 givenName string
Příjmení
 familyName string
Automatické připomenutí
 automaticReminders number
Vypršení platnosti
 expiration string
Hash
 hash string

Návraty

Name Cesta Typ Description
uid
 uid string

Vytvořit odkaz na podpis

ID operace:
PostEnvelopesEnvelopeIdJobsGetSignLink

Vytvoří odkaz na podpis. Implementace je specifická a může chybět pro váš konkrétní tok.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
identifikační číslo
 id string
Přesměrovat na
 redirectTo uri

Úplná adresa URL pro přesměrování uživatele na po podepsání

Návraty

Name Cesta Typ Description
URL
 getSignLink.recipient.{recipient-id}.url string

Získání adresy URL souboru podle ID

ID operace:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Získá adresu URL k danému souboru.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu
ID souboru
 file-id True string

ID příslušného souboru
Jako objekt
 asObject boolean

Definuje, jestli je odpovědí objekt.

Návraty

Name Cesta Typ Description
URL
 url string

Adresa URL souboru

Získání dokumentu podle ID

ID operace:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Získá informace o daném dokumentu.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu

Návraty

Dokument
Document

Získání informací o uživateli

ID operace:
GetAuthUserinfo

Získá informace o aktuálně přihlášeného uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení

Návraty

Body
UserInfo

Získání konkrétního příjemce obálky

ID operace:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Získá konkrétního příjemce pro danou obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID příjemce
 recipient-id True string

ID dotčených příjemců

Návraty

Recipient
Recipient

Získání obálky podle ID

ID operace:
GetEnvelopesEnvelopeId

Získá podrobnosti o dané obálce.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky

Návraty

Obálka
Envelope

Získání popisovače podle ID

ID operace:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Získá informace o daném popisovači.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID popisovače obálky
 envelope-descriptor-id True string

ID popisovače obálky

Návraty

Popisovač
Descriptor

Získání souboru podle ID

ID operace:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Získá informace o daném souboru.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu
ID souboru
 file-id True string

ID příslušného souboru

Návraty

File
File

Získání souborů podle ID dokumentu

ID operace:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Získá všechny soubory připojené k danému dokumentu.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID dokumentu
 document-id True string

ID příslušného dokumentu

Návraty

response
array of File

Získání společnosti podle ID

ID operace:
GetCompaniesCompanyId

Získá informace o dané společnosti.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 company-id True string

ID dotčené společnosti

Návraty

Společnost
Company

Získání stavu toku podle ID obálky

ID operace:
GetFlowsFlowIdJobsEnvelopeId

Získá aktuální stav toku dané obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky
ID toku
 flow-id True string

ID příslušného toku

Návraty

Name Cesta Typ Description
Žeton
 token string

Získání uživatelských nastavení

ID operace:
GetCompaniesCompanyIdUsersUserIdSettings

Získá nastavení daného uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 company-id True string

ID dotčené společnosti
ID uživatele
 user-id True string

ID příslušného uživatele

Návraty

Body
Setting

Získání výchozího popisovače

ID operace:
GetEnvelopeDescriptorsDefault

Získá výchozí popisovač pro obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
Filtry
 filters string

Filtrování dotazu pro výběr dílčího připojení

Návraty

Popisovač
Descriptor

Získání všech dokumentů podle ID obálky

ID operace:
GetEnvelopesEnvelopeIdDocuments

Získá všechny dokumenty související s danou obálkou.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky

Návraty

response
array of Document

Získání všech popisovačů

ID operace:
GetEnvelopeDescriptors

Získá seznam všech popisovačů, které jsou přítomné v aktuální společnosti. Seznam je možné filtrovat.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
Filtry
 filters string

Filtrování dotazu pro výběr dílčího připojení

Návraty

response
array of Descriptor

Získání všech příjemců obálky

ID operace:
GetEnvelopesEnvelopeIdRecipients

Získá všechny příjemce dané obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Žeton
 token True string

Token přijatý z akce Generovat token zabezpečení
ID společnosti
 x-namespace string

ID společnosti, které by se mělo použít pro akci. Formát /companies/<company ID>. Ve výchozím nastavení se nastaví ID společnosti, pokud není nastavené.
ID obálky
 envelope-id True string

ID příslušné obálky

Návraty

response
array of Recipient

Definice

Setting

Name Cesta Typ Description
Global
 global string
Signatář jazyk
 preferences.signatoryLanguage string
Pozdrav
 preferences.greeting string
Metoda podepisování
 preferences.signingMethod string
Posun připomenutí
 preferences.reminderOffset string

Informace o uživateli

Name Cesta Typ Description
Křestní jméno
 givenName string
Příjmení
 familyName string
Email
 email string
Jazyk
 metadata.language string
Chybějící heslo
 missingPassword boolean
Je povoleno
 isEnabled boolean
Namespace
 namespace string
Enabled
 enabled boolean
UID
 uid string
identifikační číslo
 id string
Seznam rolí
 roles array of Role
Validated
 validated boolean

Společnost

Name Cesta Typ Description
Název
 name string
Číslo reg.
 regNumber string
Vytvořené
 created string
Změněno
 modified string
Address
 address string
City
 city string
PSČ
 zipCode string
Logo
 logo string
Country
 country string
Uid
 uid string
identifikační číslo
 id string

Recipient

Name Cesta Typ Description
UID
 uid string

UID příjemce
Namespace
 namespace string

Obor názvů příjemce
Vytvořené
 created string

Příjemce byl vytvořen.
Role
 role RoleActionString
Příjmení
 familyName string

Příjmení příjemce
Křestní jméno
 givenName string

Jméno frist příjemce
Jazyk
 language string

Jazyk příjemce
Email
 email string

E-mail příjemce
Metoda podepisování
 signingMethod string

Podpis příjemce – Methid
Metoda oznámení
 notificationMethod string
Objednávka
 order integer

Objednávka příjemce
identifikační číslo
 id string

ID příjemce
Změněno
 modified string

Příjemce změněn
Oznámeno
 notified boolean
Dokončeno
 completed boolean
demandAttachment
 demandAttachment boolean
ČSP
 ssn string
Banka
 bank string
Bezpečný
 secure boolean
služba SMS
 sms boolean
Telefon
 telephone string
podpisy
 signatures object
Notifications
 notifications array of Notification

Role

Name Cesta Typ Description
Typ
 action.type string
metody
 action.methods array of string
Označení
 label string

Označení
Num. Max
 numMax integer

Num. Max
Num. Minuta
 numMin integer

Num. Minuta
Název role
 roleName string

RoleActionString

Name Cesta Typ Description
Činnost
 action ActionString

Činnost
Označení
 label string

Označení
Num. Max
 numMax integer

Num. Max
Num. Minuta
 numMin integer

Num. Minuta
Název role
 roleName string

ActionString

Činnost

Činnost

Činnost
string

Obálka

Name Cesta Typ Description
identifikační číslo
 id string

ID obálky
UID
 uid string

UID obálky
Namespace
 namespace string

Obor názvů obálky
Version
 version integer

Verze obálky
Publikováno
 published boolean

Obálka publikovaná
Complete
 completed boolean

Obálka dokončena
Přerušeno
 aborted boolean

Obálka avorted
Opilý
 trashed boolean

Obálka v koši
Sekvenční podepisování
 sequentialSigning boolean
Autmatic Reminders
 automaticReminders integer
Vytvořené
 created string

Obálka vytvořená
Změněno
 modified string

Obálka změněna
Platnost vypršela
 expired boolean

Platnost obálky vypršela
Flow
 flow Flow
Popisovač
 descriptor Descriptor
Person
 sender Person
Documents
 documents array of Document
Příjemci
 recipients array of Recipient
Štítky
 tags array of object
Majitelé
 owners array of Person

ObálkaDescriptorString

Name Cesta Typ Description
identifikační číslo
 id string

ID obálky
UID
 uid string

UID obálky
Namespace
 namespace string

Obor názvů obálky
Version
 version integer

Verze obálky
Publikováno
 published boolean

Obálka publikovaná
Complete
 completed boolean

Obálka dokončena
Přerušeno
 aborted boolean

Obálka avorted
Opilý
 trashed boolean

Obálka v koši
Sekvenční podepisování
 sequentialSigning boolean
Autmatic Reminders
 automaticReminders integer
Vytvořené
 created string

Obálka vytvořená
Změněno
 modified string

Obálka změněna
Platnost vypršela
 expired boolean

Platnost obálky vypršela
Flow
 flow Flow
Popisovač
 descriptor string

Popisovač obálek
Person
 sender Person
Documents
 documents array of Document
Příjemci
 recipients array of Recipient
Štítky
 tags array of object
Majitelé
 owners array of Person

File

Name Cesta Typ Description
identifikační číslo
 id string

ID souboru
URL
 url string

Adresa URL souboru
Název
 name string

Název souboru
Typ mime.
 mimeType string
Typ souboru
 fileType string
Cesta k úložišti
 storagePath string
Odesláno na
 uploadedAt string
Vytvořené
 created string

Soubor byl vytvořen.
Majitelé
 owners array of object
UID
 owners.uid string

UID vlastníka souboru
identifikační číslo
 owners._id string

ID vlastníka souboru
Namespace
 namespace string
UID
 uid string

UID souboru

Flow

Name Cesta Typ Description
identifikační číslo
 id string

ID toku
Název
 name string

Název toku

Popisovač

Name Cesta Typ Description
Název
 name string

Název popisovače
Version
 version integer

Verze popisovače
UID
 uid string

UID popisovače
Odstraněné
 deleted boolean

Popisovač deletd
Public
 public boolean

Veřejný popisovač
Platnost vypršela
 expired boolean

Platnost popisovače vypršela.
identifikační číslo
 id string

ID popisovače
Povinné
 mandatory boolean

Povinný popisovač
Označení
 label string

Popisek popisovače
Typ
 type string

Typ popisovače
Seznam rolí
 roles array of Role
Majitelé
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
Instances
 instances array of object

Person

Name Cesta Typ Description
UID
 uid string

UID osoby
Křestní jméno
 givenName string

Jméno osoby
Příjmení
 familyName string

Příjmení osoby
Email
 email string

E-mail osoby
Jazyk
 language string

Jazyk osoby
Objednávka
 order integer

Pořadí osob

Dokument

Name Cesta Typ Description
Označení
 label string

Popisek dokumentu
Typ
 type string

Typ dokumentu
Hash
 hash integer

Hodnota hash dokumentu
Num. Max
 numMax integer

Číslo dokumentu Max
Num. Minuta
 numMin integer

Číslo dokumentu Minuta
UID
 uid string

UID dokumentu
Namespace
 namespace string

Obor názvů dokumentů
Zdroj
 source string

Zdroj dokumentu
Vytvořené
 created string

Dokument byl vytvořen.
Název
 name string

Název dokumentu
identifikační číslo
 id string

ID dokumentu
Změněno
 modified string

Dokument změněn
Zamítnuto
 rejected boolean

Dokument byl odmítnut.
Podepsaný
 signed boolean

Dokument podepsaný
Opilý
 trashed boolean

Dokument je v koši
Přerušeno
 aborted boolean

Dokument byl přerušen.
Version
 version integer

Verze dokumentu
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
Popisovač
 descriptor Descriptor
podpisy
 signatures array of Signature

Příloha

Name Cesta Typ Description
Označení
 label string

Popisek přílohy
Num. Max
 numMax integer

Číslo přílohy Max
Num. Minuta
 numMin integer

Příloha Num.Min
Hash
 hash integer

Hodnota hash přílohy

Template

Name Cesta Typ Description
Typ
 type string

Typ šablony
jazyk HTML
 html string
PDFHTML
 pdfHtml string
identifikační číslo
 id string
UID
 uid string
Namespace
 namespace string
Version
 version integer
Vytvořené
 created string
Změněno
 modified string
Změněno
 published boolean
Dokončeno
 completed boolean
Přerušeno
 aborted boolean

Signature

Name Cesta Typ Description
ID
 id string
Původ
 origin string
Křestní jméno
 givenName string

Křestní jméno
Příjmení
 familyName string

Příjmení
Email
 email string

Email
IP
 ip string
Date
 date string
Stav
 status string
Comment
 comment string

Výchozí hodnoty

defaultValues

Name Cesta Typ Description
Person
 signer Person
Person
 reviewer Person

Notification

Name Cesta Typ Description
ID
 id string
UID
 uid string
Namespace
 namespace string
Stav
 status string
Objednávka
 order integer
Podrobnosti
 details object
Date
 date string