Dokobit Universal API

Dokobit Universal API je univerzální nástroj, který umožňuje interně podepisování dokumentů v rámci vašeho systému a shromažďování podpisů od třetích stran mimo váš systém v celé Evropě. Podepisování dokumentů probíhá v podepisování Dokobit bez účtu (kde pozvaní účastníci můžou podepsat dokumenty bez registrace na portálu Dokobit) rozhraní s brandingem vaší organizace.

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	Dokobit
URL	https://support.dokobit.com
Email	developers@dokobit.com

Metadata konektoru
Vydavatel	Dokobit
Internetová stránka	https://www.dokobit.com/solutions
Zásady ochrany osobních údajů	https://www.dokobit.com/compliance/privacy-policy
Kategorie	Produktivita

Dokobit Universal API je univerzální nástroj, který umožňuje interně podepisování dokumentů v rámci vašeho systému a shromažďování podpisů od třetích stran mimo váš systém v celé Evropě. Podepisování dokumentů probíhá v podepisování Dokobit bez účtu (kde pozvaní účastníci můžou podepsat dokumenty bez registrace na portálu Dokobit) rozhraní s brandingem vaší organizace.

Požadavky

Pokud chcete použít rozhraní Dokobit Universal API, kontaktujte nás, sales@dokobit.com abychom získali přístupový token rozhraní API.

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

Obraťte se na sales a získejte přístupový token rozhraní API.

Začínáme s konektorem

• Podepisování dokumentů je možné zahájit pomocí akcí DokobitUniversalAPICreateExternalSigning nebo DokobitUniversalAPICreateInternalSigning. Když použijete DokobitUniversalAPICreateExternalSigning, pošlete účastníkům podpisovou pozvánku. DokobitUniversalAPICreateInternalSigning vygeneruje podpisovou adresu URL, kde je možné uživatele přesměrovat.
• Podepisování pak můžete spravovat pomocí odpovídajících akcí, které vám umožní přidávat nebo odebírat účastníky, posílat připomenutí nebo kontrolovat stav podepisování dokumentů.
• Po podepsání dokumentu je možné dokument stáhnout pomocí akcí DokobitUniversalAPIDownloadDocumentExternal nebo DokobitUniversalAPIDownloadDocumentInternal.

Známé problémy a omezení

Aktuální implementace podporuje shromažďování podpisů u souborů PDF a podporuje kontejnery ASiCe, ADoc, BDoc nebo EDoc.

Běžné chyby a nápravné prostředky

• Soubor musí být zadaný jako obsah souboru s kódováním Base64.
• Pokud je podpis dokumentu Type nastavený na pdf, při zahájení podepisování dokumentu se přijme jeden dokument PDF. U více souborů nastavte podpis Type na asice nebo jiný formát kontejneru.

Vytvoření připojení

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

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

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

Název	Typ	Description	Povinné
Klíč rozhraní API	securestring	Klíč rozhraní API pro toto rozhraní API	Pravdivé

Limity omezování

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

Akce

Aktualizace externího podepisování	Umožňuje aktualizovat atributy existujícího podepisování dokumentů.
Aktualizace interního podepisování	Umožňuje aktualizovat atributy existujícího podepisování dokumentů.
e-Delivery	E-Delivery dokumentů se používá k bezpečnému sdílení dokumentů pomocí univerzálního rozhraní API Dokobit.
Interní stažení dokumentu	Stáhne podepsaný dokument.
Kontrola interního stavu podepisování	Vrátí informace o dokumentu se stavem podepisování.
Kontrola stavu externího podepisování	Vrátí informace o dokumentu se stavem podepisování.
Odeslat připomenutí	Umožňuje odeslat e-mail s připomenutím pro účastníka, pouze pokud osoba ještě nepodepsal dokument. Funguje jenom s externím podpisovým tokem.
Odstranit externí podepisující osoby	Přístup k dokumentu bude odvolán pro uvedeného účastníka.
Odstranit interní podepisování	Dokument se odebere z účtu vlastníka. Zůstane přístupný ostatním účastníkům.
Odstranit interní podepisující osoby	Přístup k dokumentu bude odvolán pro uvedeného účastníka.
Odstranění externího podepisování	Dokument se odebere z účtu vlastníka. Zůstane přístupný ostatním účastníkům.
Ověření – Diagnostická data XML	Stáhněte si diagnostická data ve formátu XML.
Ověření – podrobná sestava PDF	Stáhněte si podrobnou ověřovací sestavu ve formátu PDF.
Ověření – sestava PDF	Stáhněte si ověřovací zprávu ve formátu PDF.
Ověření – sestava XML	Stáhněte si ověřovací sestavu ve formátu XML.
Přidat externí podepisující osoby	Označení účastníci získají přístup k dokumentu s vybranou rolí.
Přidání interního podepisujícího	Označení účastníci získají přístup k dokumentu s vybranou rolí.
Stáhnout externí dokument	Stáhne podepsaný dokument.
Validation	Dokobit je poskytovatel služeb certifikovaný společností eIDAS pro ověření elektronického podpisu a e-sealu. Tato akce slouží k nahrání podepsaného souboru pro ověření. Podporované typy souborů: asice, asics, sce, bdocedoc, pdf, p7s, , xml.
Vytvoření externího podepisování	Externí podepisování inicializuje asynchronní podpisový požadavek z vašeho systému. V takovém případě uživatel obdrží e-mail pro podepsání a jakmile dokument podepíše, dostanete zpětné volání.
Vytvoření interního podepisování	Interní podepisování inicializuje žádost o podepsání ze systému. V takovém případě se vygeneruje podpisová adresa URL, kde by měl být účastník přesměrován.
Zapečetění podepisování	Dokument bude zapečetěn elektronickým zapečetěním vaší organizace. Pokud chcete získat kvalifikovaný certifikát pro e-těsnění, kontaktujte prosím naši podporu developers@dokobit.com .

Aktualizace externího podepisování

ID operace:

DokobitUniversalAPIUpdateExternalSigning

Umožňuje aktualizovat atributy existujícího podepisování dokumentů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Deadline	deadline		date-time	Datum podepsání konečného termínu se zadaným fragmentem časového pásma Příklad: 2018-11-05T13:15:30Z.
Pevný termín	hard_deadline		boolean	Pokud nastavíte true účastníky, nebudou moct tento dokument po nastavení deadlinepodepsat ani schválit . Výchozí hodnota: false.
Vyžadovat kvalifikované podpisy	require_qualified_signatures		boolean	Povolit podepisování pouze s kvalifikovanými podpisy. Výchozí hodnota: false.
Povolit identifikaci videa	allow_video_identification		boolean	Povolit podepisování pomocí identifikace založené na videu Výchozí hodnota: false.
Povolit ukládání dokumentů	allow_document_saving		boolean	Umožňuje uživateli uložit dokument na portál Dokobit a provést další akce. Výchozí hodnota: true.
Povolené metody podepisování	allowed_signing_methods		array of string	Povolte pouze konkrétní metody podepisování. Dostupné hodnoty: mobile, smartid, smartcard, , bankid_noaudkenni_appelectronic_idftnbankid_seeparaksts_mobileitsmeidinmitid, . sms_otpswisscom

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Aktualizace interního podepisování

ID operace:

DokobitUniversalAPIUpdateInternalSigning

Umožňuje aktualizovat atributy existujícího podepisování dokumentů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Vyžadovat kvalifikované podpisy	require_qualified_signatures		boolean	Povolit podepisování pouze s kvalifikovanými podpisy. Výchozí hodnota: false.
Povolit identifikaci videa	allow_video_identification		boolean	Povolit podepisování pomocí identifikace založené na videu Výchozí hodnota: false.
Povolené metody podepisování	allowed_signing_methods		array of string	Povolte pouze konkrétní metody podepisování. Dostupné hodnoty: mobile, smartid, smartcard, , bankid_noaudkenni_appelectronic_idftnbankid_seeparaksts_mobileitsmeidinmitid, . sms_otpswisscom

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

e-Delivery

ID operace:

DokobitUniversalAPIeDelivery

E-Delivery dokumentů se používá k bezpečnému sdílení dokumentů pomocí univerzálního rozhraní API Dokobit.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ	type	True	string	Formát dokumentu Dostupné hodnoty: pdf.
Název	name	True	string	Zobrazovaný název dokumentu pro uživatele
Adresa URL zpětného odeslání	postback_url		string	Adresa URL systému pro zpracování webhooků
Comment	comment		string	Zpráva pro příjemce
Název	name	True	string	Název souboru
Content	content	True	string	Obsah souboru s kódováním Base64
Externí ID	external_id	True	string	Jedinečný náhodný identifikátor účastníka z vašeho systému. Pokud ho nemáte, můžete vygenerovat jedinečné náhodné identifikátory.
Code	code	True	string	Osobní kód příjemce (číslo národního ID).
Kód země	country_code	True	string	Kód země příjemce. Vyžaduje se, pokud je k dispozici osobní kód. Dostupné hodnoty: lt, lv, ee, is.
E-mail	email		string	E-mail příjemce pro odeslání dokumentu Vyžaduje se, pokud telefon není nastavený.
telefon	phone		string	Telefonní číslo příjemce pro odesílání sms dokumentu. Vyžaduje se, pokud e-mail není nastavený. SMS se odešle jenom v případech, kdy není zadaný e-mail.
Jazyk oznámení	notifications_language		string	Nastaví jazyk pro oznámení. Dostupné hodnoty: en, lt, lv, et, is, no, 'fr', 'se', 'de'.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.
Token dokumentu	token	string	Token dokumentu.
Příjemci	recipients	array of object	Informace o příjemci.
Externí ID	recipients.external_id	string	Jedinečný náhodný identifikátor účastníka z vašeho systému.
Žeton	recipients.token	string	Token příjemce.
Code	recipients.code	string	Osobní kód příjemce (číslo národního ID).
Country	recipients.country	string	Země příjemce.
E-mail	recipients.email	string	E-mail příjemce.

Interní stažení dokumentu

ID operace:

DokobitUniversalAPIDownloadDocumentInternal

Stáhne podepsaný dokument.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

response

object

Kontrola interního stavu podepisování

ID operace:

DokobitUniversalAPICheckInternalSigningStatus

Vrátí informace o dokumentu se stavem podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

Name	Cesta	Typ	Description
Stav podepisování	status	string	Stav podepsání dokumentu
Název	name	string	Zobrazovaný podpisový název uživatele
Typ	type	string	Typ dokumentu.
Datum vytvoření	date_created	string	Datum zahájení podepisování dokumentu
Deadline	deadline	date-time	Datum podepsání konečného termínu se zadaným fragmentem časového pásma Příklad: 2018-11-05T13:15:30Z.
Název souboru	filename	string	Název souboru.
Files	files	array of object
Název	files.name	string	Název souboru.
Adresa URL pro stažení	files.url	string	Adresa URL pro stažení souboru
Typ MIME	files.mime_type	string	Typ MIME souboru.
Signatáři	signers	array of object	Informace o účastníkovi.
Žeton	signers.token	string	Token účastníka.
Název	signers.first_name	string	Jméno účastníka.
Surname	signers.last_name	string	Příjmení účastníka.
Code	signers.code	string	Kód účastníka.
Country	signers.country	string	Země účastníka.
E-mail	signers.email	string	E-mail účastníka.
Typ	signers.type	string	Typ:
Stav	signers.status	string	Stav účastníka.

Kontrola stavu externího podepisování

ID operace:

DokobitUniversalAPICheckExternalSigningStatus

Vrátí informace o dokumentu se stavem podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

Name	Cesta	Typ	Description
Stav podepisování	status	string	Stav podepsání dokumentu
Název	name	string	Zobrazovaný podpisový název uživatele
Typ	type	string	Typ dokumentu.
Datum vytvoření	date_created	string	Datum zahájení podepisování dokumentu
Deadline	deadline	date-time	Datum podepsání konečného termínu se zadaným fragmentem časového pásma Příklad: 2018-11-05T13:15:30Z.
Název souboru	filename	string	Název souboru.
Files	files	array of object
Název	files.name	string	Název souboru.
Adresa URL pro stažení	files.url	string	Adresa URL pro stažení souboru
Typ MIME	files.mime_type	string	Typ MIME souboru.
Signatáři	signers	array of object	Informace o účastníkovi.
Žeton	signers.token	string	Token účastníka.
Název	signers.first_name	string	Jméno účastníka.
Surname	signers.last_name	string	Příjmení účastníka.
Code	signers.code	string	Kód účastníka.
Country	signers.country	string	Země účastníka.
E-mail	signers.email	string	E-mail účastníka.
Typ	signers.type	string	Typ:
Stav	signers.status	string	Stav účastníka.

Odeslat připomenutí

ID operace:

DokobitUniversalAPIReminder

Umožňuje odeslat e-mail s připomenutím pro účastníka, pouze pokud osoba ještě nepodepsal dokument. Funguje jenom s externím podpisovým tokem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Token podepisující osoby	signer	True	string	Token účastníka.
Message	message		string	Zpráva s připomenutím pro podepisující osoby.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Odstranit externí podepisující osoby

ID operace:

DokobitUniversalAPIDeleteExternalSigner

Přístup k dokumentu bude odvolán pro uvedeného účastníka.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Žeton	token	True	string	Token účastníka.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Odstranit interní podepisování

ID operace:

DokobitUniversalAPIDeleteInternalSigning

Dokument se odebere z účtu vlastníka. Zůstane přístupný ostatním účastníkům.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Odstranit interní podepisující osoby

ID operace:

DokobitUniversalAPIDeleteInternalSigner

Přístup k dokumentu bude odvolán pro uvedeného účastníka.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Žeton	token	True	string	Token účastníka.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Odstranění externího podepisování

ID operace:

DokobitUniversalAPIDeleteExternalSigning

Dokument se odebere z účtu vlastníka. Zůstane přístupný ostatním účastníkům.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Ověření – Diagnostická data XML

ID operace:

DokobitUniversalAPIValidationXMLDiagnosticData

Stáhněte si diagnostická data ve formátu XML.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Ověřovací token	token	True	string	Ověřovací token přijatý z akce DokobitUniversalAPIValidation

Návraty

response

object

Ověření – podrobná sestava PDF

ID operace:

DokobitUniversalAPIValidationDetailedPDFReport

Stáhněte si podrobnou ověřovací sestavu ve formátu PDF.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Ověřovací token	token	True	string	Ověřovací token přijatý z akce DokobitUniversalAPIValidation

Návraty

response

object

Ověření – sestava PDF

ID operace:

DokobitUniversalAPIValidationPDFReport

Stáhněte si ověřovací zprávu ve formátu PDF.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Ověřovací token	token	True	string	Ověřovací token přijatý z akce DokobitUniversalAPIValidation

Návraty

response

object

Ověření – sestava XML

ID operace:

DokobitUniversalAPIValidationXMLReport

Stáhněte si ověřovací sestavu ve formátu XML.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Ověřovací token	token	True	string	Ověřovací token přijatý z akce DokobitUniversalAPIValidation

Návraty

response

object

Přidat externí podepisující osoby

ID operace:

DokobitUniversalAPIAddExternalSigner

Označení účastníci získají přístup k dokumentu s vybranou rolí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Externí ID	external_id	True	string	Jedinečný náhodný identifikátor účastníka z vašeho systému. Pokud ho nemáte, můžete vygenerovat jedinečné náhodné identifikátory.
Název	name		string	Jméno účastníka.
Surname	surname		string	Příjmení účastníka.
E-mail	email		string	E-mail účastníka.
Code	code		string	Kód účastníka.
Kód země	country_code		string	Kód země účastníka. Vyžaduje se, pokud je k dispozici osobní kód. Dostupné hodnoty: LT, LV, EE, IS, NOFI, BE, , SE.
Role	role		string	Role účastníka. Dostupné hodnoty: signer, viewer. Výchozí hodnota: signer.
Společnost	company		string	Účastnické společnosti.
Position	position		string	Pozice účastníka.
telefon	phone		string	Telefon účastníka.
Vlastní důvod	custom_reason		string	Důvod vlastního podpisu.
Jazyk oznámení	notifications_language		string	Nastaví jazyk pro oznámení. Dostupné hodnoty: en, lt, , lv, issefretdeno, fidk, . nl
Stránka	page		string	Index stránky pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice shora	top		string	Pozice (v bodech) shora pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice zleva	left		string	Pozice (v bodech) zleva pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Jazyk	language		string	Jazyk viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Dostupné hodnoty: en, lt, lv, et, is
Comment	comment		string	Zpráva pro účastníky

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.
Signatáři	signers	array of object	Informace o účastníkovi.
Externí ID	signers.external_id	string	Jedinečný náhodný identifikátor účastníka z vašeho systému.
Žeton	signers.token	string	Token účastníka.
Název	signers.name	string	Jméno účastníka.
Surname	signers.surname	string	Příjmení účastníka.
E-mail	signers.email	string	E-mail účastníka.
Code	signers.code	string	Osobní kód účastníka (číslo národního ID).
Kód země	signers.country_code	string	Země účastníka.
Role	signers.role	string	Role účastníka.
Společnost	signers.company	string	Účastnické společnosti.
Position	signers.position	string	Pozice účastníka.
Jazyk oznámení	signers.notifications_language	string	Nastaví jazyk pro oznámení. Dostupné hodnoty: en, lt, lv, et, is, no, 'fr', 'se', 'de'.
telefon	signers.phone	string	Telefon účastníka.

Přidání interního podepisujícího

ID operace:

DokobitUniversalAPIAddInternalSigner

Označení účastníci získají přístup k dokumentu s vybranou rolí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Externí ID	external_id	True	string	Jedinečný náhodný identifikátor účastníka z vašeho systému. Pokud ho nemáte, můžete vygenerovat jedinečné náhodné identifikátory.
Role	role		string	Role účastníka. Dostupné hodnoty: signer, viewer. Výchozí hodnota: signer.
Code	code		string	Kód účastníka.
Kód země	country_code		string	Kód země účastníka. Vyžaduje se, pokud je k dispozici osobní kód. Dostupné hodnoty: LT, LV, EE, IS, NO. PLSEFIBE
telefon	phone		string	Telefon účastníka.
Jazyk oznámení	language		string	Nastaví jazyk uživatelského rozhraní. Dostupné hodnoty: en, lt, , lv, issefretdeno, fidk, . nl
Stránka	page		string	Index stránky pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice shora	top		string	Pozice (v bodech) shora pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice zleva	left		string	Pozice (v bodech) zleva pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Jazyk	language		string	Jazyk viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Dostupné hodnoty: en, lt, lv, et, is
Vlastní důvod	custom_reason		string	Důvod vlastního podpisu.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.
Signatáři	signers	array of object	Informace o účastníkovi.
Externí ID	signers.external_id	string	Jedinečný náhodný identifikátor účastníka z vašeho systému.
Žeton	signers.token	string	Token účastníka.
Název	signers.name	string	Jméno účastníka.
Surname	signers.surname	string	Příjmení účastníka.
E-mail	signers.email	string	E-mail účastníka.
Code	signers.code	string	Osobní kód účastníka (číslo národního ID).
Kód země	signers.country_code	string	Země účastníka.
Role	signers.role	string	Role účastníka.
Společnost	signers.company	string	Účastnické společnosti.
Position	signers.position	string	Pozice účastníka.
telefon	signers.phone	string	Telefon účastníka.

Stáhnout externí dokument

ID operace:

DokobitUniversalAPIDownloadDocumentExternal

Stáhne podepsaný dokument.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.

Návraty

response

object

Validation

ID operace:

DokobitUniversalAPIValidation

Dokobit je poskytovatel služeb certifikovaný společností eIDAS pro ověření elektronického podpisu a e-sealu. Tato akce slouží k nahrání podepsaného souboru pro ověření. Podporované typy souborů: asice, asics, sce, bdocedoc, pdf, p7s, , xml.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name	True	string	Název souboru
Content	content	True	string	Obsah souboru s kódováním Base64

Návraty

Name	Cesta	Typ	Description
Stav nahrání	status	string	Stav nahrání
Ověřovací token	token	string	Ověřovací token.

Vytvoření externího podepisování

ID operace:

DokobitUniversalAPICreateExternalSigning

Externí podepisování inicializuje asynchronní podpisový požadavek z vašeho systému. V takovém případě uživatel obdrží e-mail pro podepsání a jakmile dokument podepíše, dostanete zpětné volání.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ	type	True	string	Formát dokumentu Dostupné hodnoty: pdf, asice, bdoc, edoc, adoc, . adoc.cedoc
Název	name	True	string	Zobrazovaný podpisový název uživatele
Adresa URL zpětného odeslání	postback_url		string	Adresa URL systému pro zpracování webhooků
Deadline	deadline		date-time	Datum podepsání konečného termínu se zadaným fragmentem časového pásma Příklad: 2018-11-05T13:15:30Z.
Pevný termín	hard_deadline		boolean	Pokud nastavíte true účastníky, nebude možné po nastavení deadlinepodepsat tento dokument . Výchozí hodnota: false.
Vyžadovat kvalifikované podpisy	require_qualified_signatures		boolean	Povolit podepisování pouze s kvalifikovanými podpisy. Výchozí hodnota: false.
Pozice poznámky	annotation_position		string	Umístění poznámek podpisu můžete zvolit v dokumentu PDF. Dostupné hodnoty: first_top, first_bottom, last_top, last_bottom, none. Výchozí hodnota: first_top.
Osobní kód poznámek	annotation_personal_code		boolean	Pokud je nastavená na true osobní kód, zobrazí se v poznámce. Platí jenom pro podepisování typu PDF. Výchozí hodnota: false.
Comment	comment		string	Zpráva pro účastníky
Povolit identifikaci videa	allow_video_identification		boolean	Povolit podepisování pomocí identifikace založené na videu Výchozí hodnota: false.
Povolit ukládání dokumentů	allow_document_saving		boolean	Umožňuje uživateli uložit dokument na portál Dokobit a provést další akce. Výchozí hodnota: true.
Zploštěné PDF	flatten_pdf		boolean	Pokud je nastavena hodnota true, dokument bude zploštěný tak, aby pole formuláře byla součástí obsahu dokumentu a po podepsání nelze upravit. Platí jenom pro podepisování typu PDF. Výchozí hodnota: false.
Povolené metody podepisování	allowed_signing_methods		array of string	Povolte pouze konkrétní metody podepisování. Dostupné hodnoty: mobile, smartid, smartcard, , bankid_noaudkenni_appelectronic_idftnbankid_seeparaksts_mobileitsmeidinmitid, . sms_otpswisscom
Název	name	True	string	Název souboru
Content	content	True	string	Obsah souboru s kódováním Base64
Externí ID	external_id	True	string	Jedinečný náhodný identifikátor účastníka z vašeho systému. Pokud ho nemáte, můžete vygenerovat jedinečné náhodné identifikátory.
Název	name		string	Jméno účastníka.
Surname	surname		string	Příjmení účastníka.
E-mail	email		string	E-mail účastníka.
Code	code		string	Osobní kód účastníka (číslo národního ID).
Kód země	country_code		string	Kód země účastníka. Vyžaduje se, pokud je k dispozici osobní kód. Dostupné hodnoty: LT, LV, EE, IS, NOFI, BE, , SE.
Role	role		string	Role účastníka. Dostupné hodnoty: signer, viewer. Výchozí hodnota: signer.
Společnost	company		string	Název společnosti účastníka.
Position	position		string	Pozice účastníka.
telefon	phone		string	Telefonní číslo účastníka.
Sekvence	sequence		integer	Umožňuje nastavit pořadí pořadí schvalování a podepisování dokumentů.
Jazyk oznámení	notifications_language		string	Nastaví jazyk pro oznámení. Dostupné hodnoty: en, lt, , lv, issefretdeno, fidk, . nl
Vlastní důvod	custom_reason		string	Důvod vlastního podpisu.
Stránka	page		string	Index stránky pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice shora	top		string	Pozice (v bodech) shora pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice zleva	left		string	Pozice (v bodech) zleva pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Jazyk	language		string	Jazyk viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Dostupné hodnoty: en, lt, lv, et, is

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.
Podpisový token	token	string	Podpisový token.
Signatáři	signers	array of object	Informace o účastníkovi.
Externí ID	signers.external_id	string	Jedinečný náhodný identifikátor účastníka z vašeho systému.
Žeton	signers.token	string	Token účastníka.
Název	signers.first_name	string	Jméno účastníka.
Surname	signers.last_name	string	Příjmení účastníka.
Code	signers.code	string	Osobní kód účastníka (číslo národního ID).
Country	signers.country	string	Země účastníka.
E-mail	signers.email	string	E-mail účastníka.

Vytvoření interního podepisování

ID operace:

DokobitUniversalAPICreateInternalSigning

Interní podepisování inicializuje žádost o podepsání ze systému. V takovém případě se vygeneruje podpisová adresa URL, kde by měl být účastník přesměrován.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ	type	True	string	Formát dokumentu Dostupné hodnoty: pdf, asice, bdoc, edoc, adoc, . adoc.cedoc
Název	name	True	string	Zobrazovaný podpisový název uživatele
Přesměrování URI	redirect_uri	True	string	Identifikátor URI přesměrování, který se použije pro přesměrování podepisující osoby po dokončení podepisování.
Adresa URL zpětného odeslání	postback_url		string	Adresa URL systému pro zpracování webhooků
Vyžadovat kvalifikované podpisy	require_qualified_signatures		boolean	Povolit podepisování pouze s kvalifikovanými podpisy. Výchozí hodnota: false.
Pozice poznámky	annotation_position		string	Umístění poznámek podpisu můžete zvolit v dokumentu PDF. Dostupné hodnoty: first_top, first_bottom, last_top, last_bottom, none. Výchozí hodnota: first_top.
Osobní kód poznámek	annotation_personal_code		boolean	Pokud je nastavená na true osobní kód, zobrazí se v poznámce. Platí jenom pro podepisování typu PDF. Výchozí hodnota: false.
Povolit identifikaci videa	allow_video_identification		boolean	Povolit podepisování pomocí identifikace založené na videu Výchozí hodnota: false.
Zploštěné PDF	flatten_pdf		boolean	Pokud je nastavena hodnota true, dokument bude zploštěný tak, aby pole formuláře byla součástí obsahu dokumentu a po podepsání nelze upravit. Platí jenom pro podepisování typu PDF. Výchozí hodnota: false.
Povolené metody podepisování	allowed_signing_methods		array of string	Povolte pouze konkrétní metody podepisování. Dostupné hodnoty: mobile, smartid, smartcard, , bankid_noaudkenni_appelectronic_idftnbankid_seeparaksts_mobileitsmeidinmitid, . sms_otpswisscom
Název	name	True	string	Název souboru
Content	content	True	string	Obsah souboru s kódováním Base64
Externí ID	external_id	True	string	Jedinečný náhodný identifikátor účastníka z vašeho systému. Pokud ho nemáte, můžete vygenerovat jedinečné náhodné identifikátory.
Role	role		string	Role účastníka. Dostupné hodnoty: signer, viewer. Výchozí hodnota: signer.
Code	code		string	Kód účastníka.
Kód země	country_code		string	Kód země účastníka. Vyžaduje se, pokud je k dispozici osobní kód. Dostupné hodnoty: LT, LV, EE, IS, NO. PLSEFIBE
telefon	phone		string	Telefon účastníka.
Jazyk oznámení	language		string	Nastaví jazyk uživatelského rozhraní. Dostupné hodnoty: en, lt, , lv, issefretdeno, fidk, . nl
Stránka	page		string	Index stránky pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice shora	top		string	Pozice (v bodech) shora pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice zleva	left		string	Pozice (v bodech) zleva pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Jazyk	language		string	Jazyk viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Dostupné hodnoty: en, lt, lv, et, is
Vlastní důvod	custom_reason		string	Důvod vlastního podpisu.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.
Podpisový token	token	string	Podpisový token.
Signatáři	signers	array of object	Informace o účastníkovi.
Externí ID	signers.external_id	string	Jedinečný náhodný identifikátor účastníka z vašeho systému.
Žeton	signers.token	string	Token účastníka.
Přesměrování URI	signers.redirect_uri	string	Adresa URL pro podepisování.

Zapečetění podepisování

ID operace:

DokobitUniversalAPISealSigning

Dokument bude zapečetěn elektronickým zapečetěním vaší organizace. Pokud chcete získat kvalifikovaný certifikát pro e-těsnění, kontaktujte prosím naši podporu developers@dokobit.com .

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Podpisový token	token	True	string	Podpisový token.
Vlastní důvod	custom_reason		string	Důvod vlastního podpisu.
Stránka	page		string	Index stránky pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice shora	top		string	Pozice (v bodech) shora pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.
Pozice zleva	left		string	Pozice (v bodech) zleva pro viditelné poznámky k podpisu PDF Platí jenom pro podepisování typu PDF. Výchozí hodnota: 1.

Návraty

Name	Cesta	Typ	Description
Stav	status	string	Stav.

Definice

objekt

Toto je typ "object".