PKIsigning (Preview)
Automatizujte potřeby podepisování dokumentů pomocí konektoru platformy PKIsigning. Odesílání dokumentů do platformy PKIsigning; odešle pozvánky a načte podepsané dokumenty.
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 pkIsigningu |
| URL | https://pkisigning.nl/support |
| support@pkisigning.nl |
| Metadata konektoru | |
|---|---|
| Vydavatel | SBRS B.V. |
| Internetová stránka | https://pkisigning.nl |
| Zásady ochrany osobních údajů | https://pkisigning.nl/privacy |
| Kategorie | Spolupráce; Produktivita |
PkIsigning umožňuje organizacím automatizovat, zjednodušit a zabezpečit proces schvalování, podepisování a odesílání dokumentů zákazníkům a třetím stranám. Platforma podporuje všechny osobní podpisové certifikáty eIDAS od holandských kvalifikovaných poskytovatelů důvěryhodných služeb a je ISO27001 certifikována. Díky tomu je infrastruktura veřejných klíčů ideálním partnerem pro právní, finanční a zdravotnické organizace a vlády. Připojte se pomocí PKisigningu, abyste mohli automatizovat, zjednodušit a zabezpečit proces podepisování dokumentů.
Požadavky
Pokud chcete použít konektor PKIsigning, vyžaduje se účet platformy PKIsigning v rámci "profesionálního" předplatného. Pokud chcete zaregistrovat placené předplatné, obraťte se na PKIsigning .
Jak získat přihlašovací údaje
Po registraci předplatného dostanou uživatelé e-mail s pozvánkou k nastavení svého účtu. Po registraci je možné tento účet použít přímo s tímto konektorem.
Začínáme s konektorem
Výchozí tok pro zahájení podepisování dokumentů je následující:
- Vytvoření dokumentace
- Přidání dokumentů
- Přidání objektů actor
- Spustit pracovní postup
- Oznámení o změnách stavu pomocí triggeru
- Stáhnout dokumentaci
Dokumenty
PkIsigning očekává, že nejprve vždy vytvoříte dokumentaci. Dokumentace funguje jako kontejner dokumentů a subjektů. Dokumentaci lze vytvořit s Dossiers_Create akcí. Po vytvoření dokumentace použijte vrácenou hodnotu PkisId jako referenci pro budoucí akce.
Documents
Po vytvoření dokumentace můžete přidat dokumenty s Documents_Add akcí pomocí správného id dokumentace. Akce nepotřebuje žádné další parametry, protože jsou rozptylovány od samotných souborů dokumentu. Počet dokumentů v dokumentaci není omezen. Všechny dokumenty budou zobrazitelné a ke stažení pro všechny přidané aktéry.
Důležité: Dokument potřebuje jeden nebo více jedinečných textových zástupných symbolů v závislosti na počtu podpisů, aby bylo možné určit, kde musí být podpis umístěn a jaký objekt actor. Může se jednat o jakýkoli text na libovolném místě v dokumentu. Při přidávání objektů actor můžete zástupný symbol definovat pomocí parametru zástupného symbolu. Např: podpis1, podpis2 atd.
Actors
Třetí krok se skládá z přidání herců do dokumentů. To se provádí s akcí Actor_Create pomocí správného id dokumentace a documentId.
Spustit pracovní postup
Pokud chcete zahájit pracovní postup a efektivně odeslat pozvánky všem účastníkům, aby podepsali nebo stáhli dokumenty v poskytnutém pořadí, použijte Dossiers_StartWorkflow akci se správným ID dokumentace.
Oznámení o změnách stavu pomocí triggeru
Pokud chcete dokument získat po podepsání, přihlaste se k odběru oznámení pomocí triggeru. Pokud chcete dostávat oznámení o stavu, zadejte v poli Události stav.
Stáhnout dokumentaci
Když je trigger upozorněn na aktualizaci stavu, zkontrolujte, jestli je stav dokumentu Dokončeno. Od této chvíle je možné stáhnout všechny dokumenty v dokumentaci v jediném souboru ZIP. Pokud je zadána v nastaveních v rámci platformy PKIsigning, kterou má být generován audittrail, bude zahrnuta také.
Známé problémy a omezení
V okamžiku publikování nejsou známé žádné problémy.
Běžné chyby a nápravné prostředky
Žádné aktualizace stavu prostřednictvím triggeru
Pokud trigger nereaguje na aktualizace stavu, zkontrolujte, jestli byla v poli Události zadána hodnota Stav.
Chyba HTTP 402 Vyžaduje se platba
Platforma PKIsigning vyžadovala kredity k provádění akcí. Při přidání herců jsou kredity rezervované, aby se zajistilo, že akce může proběhnout, a pozvaní účastníci nebudou čelit problémům souvisejícím s nedostatečným počtem kreditů, které jsou k dispozici. Pokud se herci posílají velké množství pozvánek, může dojít k tomu, že kreditový balíček nemá k dispozici žádné další kredity, které by se daly rezervovat. V tuto chvíli se vrátí chyba HTTP 402.
Pokud chcete tento problém vyřešit, buď podpora pkIsigningu k topování zůstatku kreditu, nebo vyčistěte všechny neodeslané dokumentace s aktéry v odpadkovém koši na platformě. Nevyužité kredity se pak znovu zpřístupní.
časté otázky
Projděte si naši znalostní bázi nebo nás kontaktujte na adrese
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace dokumentu |
Změní data pro konkrétní dokument. |
| Aktualizace objektu actor |
Změní data pro konkrétní objekt actor. |
| Odeslat požadavek |
Spustí pracovní postup a odešle pozvánku prvnímu objektu actor v řádku pro konkrétní požadavek. |
| Odstranit dokument |
Trvale odstraní určitý dokument. |
| Odstranění objektu actor |
Trvale odstraní konkrétní objekt actor. |
| Odstranění požadavku |
Trvale odstraní konkrétní požadavek. |
| Odvolání pozvánky |
Stáhne pozvánku pro aktuálního aktéra v řádku pro konkrétní žádost. |
| Opětovné odeslání pozvánky |
Znovu odešle pozvánku pro aktuálního aktéra v řádku pro konkrétní žádost. |
| Vytvoření dokumentu |
Vytvoří nový dokument a přidá ho do konkrétního požadavku. |
| Vytvoření objektu actor |
Vytvoří nový objekt actor a přidá ho do dokumentu. |
| Vytvoření požadavku |
Vytvořte novou žádost. |
| Získání dat dokumentu |
Vrátí všechna (meta)data pro určitý dokument. |
| Získání dat objektu actor |
Vrátí všechna data pro konkrétní objekt actor. |
| Získání dat objektu actor podle dokumentu |
Vrátí všechna data všech herců pro určitý dokument. |
| Získání dat objektu actor podle požadavku |
Vrátí všechna data všech objektů actor pro konkrétní požadavek. |
| Získání dat žádosti |
Vrátí všechna (meta)data pro konkrétní požadavek. |
| Získání pracovních skupin pro organizaci |
Vrátí seznam všech pracovních skupin pro určitou organizaci. |
| Získání pracovních skupin pro uživatele |
Vrátí seznam všech pracovních skupin pro konkrétního uživatele konkrétní organizace. |
| Žádost o aktualizaci |
Změní data pro konkrétní požadavek. |
| Žádost o stažení |
Stáhne požadavky a jeho obsah jako soubor .zip. |
Aktualizace dokumentu
Změní data pro konkrétní dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Název dokumentu
|
name | string |
Název konkrétního dokumentu |
|
|
Název souboru dokumentu
|
filename | string |
Název souboru pro konkrétní dokument |
|
|
Typ dokumentu
|
documentType | True | string |
Typ konkrétního dokumentu. (Např. pravidelná PDF, fiskální výkaz, zpráva auditorů atd.). |
Návraty
Obecná metadata dokumentu
Aktualizace objektu actor
Změní data pro konkrétní objekt actor.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Actor ID
|
actorId | True | guid |
Jedinečné ID objektu actor. |
|
Činnost
|
action | True | string |
Akce, kterou musí objekt actor provést. |
|
Křestní jméno
|
firstname | True | string |
Jméno herce. |
|
Předpona
|
prefix | string |
Předpona objektu actor. |
|
|
Příjmení
|
lastname | True | string |
Příjmení herce. |
|
E-mailová adresa
|
True | string |
E-mailová adresa objektu actor. |
|
|
Telefonní číslo na mobil
|
mobile | True | string |
Číslo mobilního telefonu aktéra. |
|
Deadline
|
deadline | True | date-time |
Datum a čas, kdy akce musí být provedena aktérem. |
|
Jazyk
|
language | True | string |
Jazyk pozvánky |
|
Použití silného ověření
|
validateRealIdentity | True | boolean |
Pro tohoto aktéra použijte silnější metodu identifikace. |
|
dokumentacePersonId
|
dossierPersonId | integer | ||
|
zpráva
|
message | string |
Návraty
- Body
- ExtendedSignerModel
Odeslat požadavek
Spustí pracovní postup a odešle pozvánku prvnímu objektu actor v řádku pro konkrétní požadavek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
Odstranit dokument
Trvale odstraní určitý dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
Odstranění objektu actor
Trvale odstraní konkrétní objekt actor.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Actor ID
|
actorId | True | guid |
Jedinečné ID objektu actor. |
Odstranění požadavku
Trvale odstraní konkrétní požadavek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
Odvolání pozvánky
Stáhne pozvánku pro aktuálního aktéra v řádku pro konkrétní žádost.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
Opětovné odeslání pozvánky
Znovu odešle pozvánku pro aktuálního aktéra v řádku pro konkrétní žádost.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
Vytvoření dokumentu
Vytvoří nový dokument a přidá ho do konkrétního požadavku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku, do kterého bude tento dokument patřit. |
|
File
|
file | True | file |
Soubor, který se má zpracovat (pouze konkrétní typy souborů). |
Návraty
Obecná metadata dokumentu
Vytvoření objektu actor
Vytvoří nový objekt actor a přidá ho do dokumentu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Činnost
|
action | True | string |
Akce, kterou musí objekt actor provést. |
|
Křestní jméno
|
firstname | True | string |
Jméno herce. |
|
Předpona
|
prefix | string |
Předpona objektu actor. |
|
|
Příjmení
|
lastname | True | string |
Příjmení herce. |
|
E-mailová adresa
|
True | string |
E-mailová adresa objektu actor. |
|
|
Telefonní číslo na mobil
|
mobile | True | string |
Číslo mobilního telefonu aktéra. |
|
Deadline
|
deadline | True | date-time |
Datum a čas, kdy akce musí být provedena aktérem. |
|
Jazyk
|
language | True | string |
Jazyk pozvánky |
|
Použití silného ověření
|
validateRealIdentity | True | boolean |
Pro tohoto aktéra použijte silnější metodu identifikace. |
|
dokumentacePersonId
|
dossierPersonId | integer | ||
|
zpráva
|
message | string | ||
|
Pole podepisování
|
fieldName | string |
Název existujícího podpisového pole v dokumentu pro podepsání tohoto objektu actor. |
|
|
Placeholder
|
placeholder | string |
Text konkrétního zástupného symbolu v dokumentu, kam musí objekt actor umístit podpis. |
Návraty
- Body
- ExtendedSignerModel
Vytvoření požadavku
Vytvořte novou žádost.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název žádosti
|
name | True | string |
Název konkrétního požadavku |
|
ID pracovní skupiny
|
workgroupId | guid |
Jedinečné ID pracovní skupiny |
|
|
Úroveň bezpečnostních údajů
|
clearancelevel | True | integer |
Úroveň bezpečnostních údajů pro konkrétní žádost. |
|
Požádat vlastníka
|
owner |
Uživatel, který je vlastníkem konkrétní žádosti. |
Návraty
- Body
- RequestModel
Získání dat dokumentu
Vrátí všechna (meta)data pro určitý dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
Návraty
Obecná metadata dokumentu
Získání dat objektu actor
Vrátí všechna data pro konkrétní objekt actor.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Actor ID
|
actorId | True | guid |
Jedinečné ID objektu actor. |
Návraty
- Body
- ExtendedSignerModel
Získání dat objektu actor podle dokumentu
Vrátí všechna data všech herců pro určitý dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
ID dokumentu
|
documentId | True | guid |
Jedinečné ID dokumentu |
|
Akce byla dokončena.
|
hasActed | boolean |
Vrátí jenom aktéry, kteří mají nebo nedokončili svoji akci, a nechejte prázdné, aby se vrátili všichni aktéři. |
Návraty
- response
- array of ExtendedSignerModel
Získání dat objektu actor podle požadavku
Vrátí všechna data všech objektů actor pro konkrétní požadavek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
Aktér se na žádost choval
|
hasActed | boolean |
Hodnota jen pro čtení, která kontroluje, jestli objekt actor už na dokumentu jednal. |
Návraty
- response
- array of ExtendedSignerModel
Získání dat žádosti
Vrátí všechna (meta)data pro konkrétní požadavek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
Ověřovací klíč
|
callbackAuthenticationKey | string |
Ověřovací klíč zadaný triggerem |
Návraty
- Body
- RequestModel
Získání pracovních skupin pro organizaci
Vrátí seznam všech pracovních skupin pro určitou organizaci.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID organizace
|
organisationId | True | guid |
Jedinečné ID organizace. |
Návraty
- response
- array of OrganisationWorkgroup
Získání pracovních skupin pro uživatele
Vrátí seznam všech pracovních skupin pro konkrétního uživatele konkrétní organizace.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID organizace
|
organisationId | True | guid |
Jedinečné ID organizace. |
|
Uživatelské jméno
|
username | True |
E-mailová adresa uživatele |
Návraty
- response
- array of OrganisationWorkgroup
Žádost o aktualizaci
Změní data pro konkrétní požadavek.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
|
Název žádosti
|
name | True | string |
Název konkrétního požadavku |
|
ID pracovní skupiny
|
workgroupId | guid |
Jedinečné ID pracovní skupiny |
|
|
Úroveň bezpečnostních údajů
|
clearancelevel | True | integer |
Úroveň bezpečnostních údajů pro konkrétní žádost. |
|
Požádat vlastníka
|
owner |
Uživatel, který je vlastníkem konkrétní žádosti. |
Návraty
- Body
- RequestModel
Žádost o stažení
Stáhne požadavky a jeho obsah jako soubor .zip.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID žádosti
|
requestId | True | guid |
Jedinečné ID požadavku |
Návraty
- response
- file
Aktivační události
| Když na požadavku dojde k události |
Zaregistrujte adresu URL pro zpětné volání při stavovéange. Platforma PKIsigning bude na tuto adresu URL hlásit veškeré aktualizace stavu dokumentace v této organizaci. |
Když na požadavku dojde k události
Zaregistrujte adresu URL pro zpětné volání při stavovéange. Platforma PKIsigning bude na tuto adresu URL hlásit veškeré aktualizace stavu dokumentace v této organizaci.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typy událostí
|
Events | True | array of string |
Seznam typů událostí, ke kterým dojde na žádost, o které bude tento trigger upozorněn |
|
ID organizace
|
organisationId | True | guid |
Jedinečné ID organizace. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID žádosti
|
PkisId | guid |
Jedinečné ID požadavku |
|
Stav žádosti
|
DossierStatus | string |
Stav dokumentace. |
|
Důvod
|
Reason | string |
Důvod změny. |
|
Ověřovací klíč
|
AuthenticationKey | string |
Hlavička pro získání metadat v požadavku. |
Definice
ExtendedSignerModel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Pole podepisování
|
fieldName | string |
Název existujícího podpisového pole v dokumentu pro podepsání tohoto objektu actor. |
|
Placeholder
|
placeholder | string |
Text konkrétního zástupného symbolu v dokumentu, kam musí objekt actor umístit podpis. |
|
Činnost
|
action | string |
Akce, kterou musí objekt actor provést. |
|
Křestní jméno
|
firstname | string |
Jméno herce. |
|
Předpona
|
prefix | string |
Předpona objektu actor. |
|
Příjmení
|
lastname | string |
Příjmení herce. |
|
E-mailová adresa
|
string |
E-mailová adresa objektu actor. |
|
|
Telefonní číslo na mobil
|
mobile | string |
Číslo mobilního telefonu aktéra. |
|
Deadline
|
deadline | date-time |
Datum a čas, kdy akce musí být provedena aktérem. |
|
Jazyk
|
language | string |
Jazyk pozvánky |
|
Použití silného ověření
|
validateRealIdentity | boolean |
Pro tohoto aktéra použijte silnější metodu identifikace. |
|
dokumentacePersonId
|
dossierPersonId | integer | |
|
zpráva
|
message | string | |
|
Actor ID
|
id | guid |
Jedinečné ID konkrétního objektu actor. |
|
Datum dokončení
|
signingDate | date-time |
Datum a čas provedení akce objektu actor. |
|
Akce byla dokončena.
|
hasSigned | boolean | |
|
Jméno a příjmení
|
fullName | string |
Zkombinované jméno, předpona a příjmení objektu actor. |
|
Informace o stavu
|
emailActivity | array of EmailActivity |
Informace o stavu procesu provádění akce objektem actor. |
|
documentId
|
documentId | guid |
E-mailová aktivita
Metadata e-mailové zprávy odeslané objektu actor
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
E-mailová aktivita
|
event | string |
E-mailová aktivita pro konkrétní žádost a objekt actor |
|
Informace o protokolu SMTP
|
reason | string |
Informace o protokolu SMTP pro e-maily odeslané konkrétnímu objektu actor v rámci žádosti |
|
Datum e-mailu
|
timestamp | date-time |
Datum odeslání e-mailu určitému objektu actor v rámci žádosti |
|
Typ e-mailu
|
pkisMessageType | string |
Zadejte e-mail odeslaný konkrétnímu objektu actor jako součást žádosti (např. Pozvání, Připomenutí atd.). |
|
ID e-mailové žádosti
|
pkisInviteId | string |
Jedinečné ID e-mailu odeslaného konkrétnímu objektu actor v rámci žádosti |
|
E-mailová adresa
|
string |
E-mailová adresa e-mailu odeslaného konkrétnímu objektu actor v rámci žádosti |
SignerModel
Speciální typ objektu actor
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Činnost
|
action | string |
Akce, kterou musí objekt actor provést. |
|
Křestní jméno
|
firstname | string |
Jméno herce. |
|
Předpona
|
prefix | string |
Předpona objektu actor. |
|
Příjmení
|
lastname | string |
Příjmení herce. |
|
E-mailová adresa
|
string |
E-mailová adresa objektu actor. |
|
|
Telefonní číslo na mobil
|
mobile | string |
Číslo mobilního telefonu aktéra. |
|
Deadline
|
deadline | date-time |
Datum a čas, kdy akce musí být provedena aktérem. |
|
Jazyk
|
language | string |
Jazyk pozvánky |
|
Použití silného ověření
|
validateRealIdentity | boolean |
Pro tohoto aktéra použijte silnější metodu identifikace. |
|
dokumentacePersonId
|
dossierPersonId | integer | |
|
zpráva
|
message | string | |
|
Pole podepisování
|
fieldName | string |
Název existujícího podpisového pole v dokumentu pro podepsání tohoto objektu actor. |
|
Placeholder
|
placeholder | string |
Text konkrétního zástupného symbolu v dokumentu, kam musí objekt actor umístit podpis. |
DocumentMetaDataModel
Obecná metadata dokumentu
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název dokumentu
|
name | string |
Název konkrétního dokumentu |
|
Poslední aktualizace dokumentu
|
lastUpdate | date-time |
Datum poslední aktualizace konkrétního dokumentu |
|
Počet stránek dokumentu
|
pages | integer |
Počet stránek pro konkrétní dokument |
|
Datum vytvoření dokumentu
|
created | date-time |
Datum vytvoření konkrétního dokumentu |
|
ID dokumentu
|
id | guid |
Jedinečné ID dokumentu |
|
Stav dokumentu
|
status | string |
Stav určitého dokumentu (Např. nový, dokončený atd.). |
|
Dokument obsahuje podpis
|
signed | boolean |
Určuje, zda určitý dokument již obsahuje jeden nebo více podpisů. |
|
Podpisy dokumentů
|
signatures | array of SignatureData |
Seznam všech podpisů pro konkrétní dokument |
|
Pole prázdného podpisu dokumentu
|
emptySignatureFields | array of SignatureField |
Seznam všech prázdných polí podpisu pro určitý dokument |
|
Prázdná pole podpisu
|
containsBlankSignatureFields | boolean |
Určuje, zda určitý dokument obsahuje prázdná pole podpisu. |
|
Aktéři dokumentů
|
actors | array of ExtendedSignerModel |
Seznam všech herců pro konkrétní dokument |
|
ID žádosti
|
requestId | guid |
Jedinečné ID požadavku |
|
Index požadavku
|
dossierIndex | integer |
Index všech dokumentů patřících ke konkrétnímu požadavku. |
|
documentSize
|
documentSize | integer |
Velikost dokumentu patřícího konkrétnímu požadavku. |
|
documentType
|
documentType | string |
Typ dokumentu, který patří do konkrétního požadavku. |
SignatureData
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Pole předmětu certifikátu
|
subject | array of KeyValuePairOfStringAndString |
Pole z řádku předmětu certifikátu použitého pro určitý podpis |
|
Pole vystavitele certifikátu
|
issuer | array of KeyValuePairOfStringAndString |
Pole z řádku vystavitele certifikátu použitého pro určitý podpis |
|
Datum podpisu
|
date | date-time |
Datum a čas umístění konkrétního podpisu |
|
Umístění podepisování
|
location | string |
Zeměpisné umístění konkrétního aktéra v době podepisování. |
|
Důvod podepsání
|
reason | string |
Důvod podepisování, který poskytuje konkrétní aktér v době podepisování. |
|
Kvalifikovaný elektronický podpis
|
euQualified | boolean |
Určuje, jestli je určitý podpis kvalifikovaný (QeS) v souladu s předpisy eIDAS. |
|
Rozšířený elektronický podpis
|
advanced | boolean |
Určuje, jestli je určitý podpis rozšířený (AeS) v souladu s předpisy eIDAS. |
|
Kvalifikovaný eSeal
|
eSeal | boolean |
Určuje, zda je určitý certifikát použitý k podepisování nebo zapečetění kvalifikovaný eSeal shodný s předpisy eIDAS. |
|
IP adresa objektu actor
|
ipAddress | string |
IP adresa konkrétního objektu actor |
|
Pole Podpis
|
signatureField | string |
Pole, které bylo podepsáno |
|
Obrázek podpisu
|
signatureImage | string |
Soubor obrázku, který byl použit pro určitý podpis zvolený objektem actor. |
KeyValuePairOfStringAndString
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
klíč
|
key | string | |
|
value
|
value | string |
SignatureField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název pole podpisu
|
name | string |
Název konkrétního pole podpisu |
|
Stránka pole Podpis
|
page | integer |
Stránka, kde je pro konkrétní dokument umístěné konkrétní pole podpisu. |
|
Souřadnice šířky pole podpisu
|
x | double |
Hodnota šířky pozice pro konkrétní pole podpisu vzhledem ke stránce, kterou je umístěna v určitém dokumentu. |
|
Souřadnice pole podpisu
|
y | double |
Vysoká hodnota pozice pro konkrétní pole podpisu vzhledem ke stránce, kterou je umístěna v určitém dokumentu. |
|
Vysoká úroveň pole podpisu
|
height | double |
Vysoká hodnota pro konkrétní pole podpisu. |
|
Šířka pole podpisu
|
width | double |
Hodnota šířky pro konkrétní pole podpisu |
OrganizaceWorkgroup
Pracovní skupina, která se používá v dokumentaci
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pracovní skupiny
|
id | guid |
Jedinečné ID pracovní skupiny |
|
Název pracovní skupiny
|
name | string |
Název konkrétní pracovní skupiny |
RequestModel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID žádosti
|
id | guid |
Jedinečné ID požadavku |
|
Název žádosti
|
dossierName | string |
Název konkrétního požadavku |
|
Vyžádání dokumentů
|
documents | array of DocumentModel |
Seznam dokumentů zahrnutých v této žádosti |
|
Stav žádosti
|
status | string |
Stav konkrétní žádosti (Např. nový, dokončený atd.). |
|
Žádosti o aktéry
|
actors | array of ExtendedSignerModel |
Seznam všech subjektů pro konkrétní požadavek |
|
Podpisy dokumentů
|
signatures | array of SignatureData |
Seznam všech podpisů pro konkrétní požadavek |
|
Typ požadavku
|
dossierType | string |
Typ konkrétního požadavku. (E.g. PDF, SBR Assurance atd.). |
|
Důvod zrušení
|
reasons | string |
Důvod zrušení konkrétní žádosti uživatelem nebo aktérem |
|
Poznámka podepisující osoby
|
signerNote | string |
Poznámka pro jednoho nebo více objektů actor, které nemají jinou akci než znaménko. |
|
Poznámka příjemce
|
recipientNote | string |
Poznámka pro jednoho nebo více objektů actor, které nemají jinou akci než stažení. |
|
Poznámka schvalovatele
|
accorderNote | string |
Poznámka pro jednoho nebo více objektů actor, které nemají jinou akci než schválit žádost. |
|
Datum vypršení platnosti žádosti
|
expires | date-time |
Datum a čas vypršení platnosti konkrétního požadavku |
|
Informace o stavu
|
emailActivity | array of EmailActivity |
Informace o stavu procesu provádění akce objektem actor. |
|
Moje žádost
|
myDossier | boolean |
Určuje, jestli jste vlastníkem konkrétní žádosti. |
|
ID pracovní skupiny
|
workgroup | guid |
Jedinečné ID pracovní skupiny |
|
Úroveň bezpečnostních údajů
|
clearancelevel | integer |
Úroveň bezpečnostních údajů pro konkrétní žádost. |
DocumentModel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
id | guid |
Jedinečné ID dokumentu |
|
Název dokumentu
|
name | string |
Název konkrétního dokumentu |
|
Typ dokumentu
|
documentType | string |
Zadejte konkrétní dokument. |
|
Index požadavku
|
dossierIndex | integer |
Index všech dokumentů patřících ke konkrétnímu požadavku. |
|
Stav dokumentu
|
documentstatus | string |
Stav určitého dokumentu (Např. nový, dokončený atd.). |
|
Aktéři dokumentů
|
actors | array of SignerModel |
Seznam všech herců pro konkrétní dokument |
soubor
Toto je základní datový typ "file".