Sdílet prostřednictvím


SignRequest (Preview)

SignRequest je zabezpečený a právně závazný nástroj pro elektronické podpisy, který vám i vašim partnerům umožňuje rychle podepsat smlouvy a další dokumenty a bez nutnosti tisknout, podepisovat a kontrolovat.

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
Email tech-support@signrequest.com
Metadata konektoru
Vydavatel SignRequest B.V.

Limity omezování

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

Akce

Odeslat žádost o podepsání

Vytvoří a odešle novou žádost SignRequest.

Odeslat žádost o podepsání

Vytvoří a odešle novou žádost SignRequest.

Parametry

Name Klíč Vyžadováno Typ Description
Automatické odstranění dnů
auto_delete_days integer

Počet dní, po kterých se automaticky odstraní hotový dokument (podepsaný, zrušený nebo odmítnutý)

Automatické vypršení platnosti dnů
auto_expire_days integer

Počet dní, po kterých se nedokončí dokument automaticky vyprší

Zakázání příloh
disable_attachments boolean

Zakázání nahrávání a přidávání příloh

Zákaz kontroly blockchainu
disable_blockchain_proof boolean

Zakáže ukládání hodnot hash kontroly časových razítek do blockchainových integrací.

Zakázat datum
disable_date boolean

Zakázání přidávání kalendářních dat

Zakázání e-mailů
disable_emails boolean

Zakažte všechny e-maily stavu SignRequest i e-mail obsahující podepsané dokumenty.

Zakázání textu
disable_text boolean

Zakázání přidávání textu

Zakázání textových podpisů
disable_text_signatures boolean

Zakázání použití podpisů generovaných zadáním (textu)

Zákaz nahrání podpisů
disable_upload_signatures boolean

Zakázání použití nahraných podpisů (obrázků)

Dokument
document uri
Adresa URL zpětného volání událostí
events_callback_url uri

Adresa URL pro příjem zpětných volání událostí pro tento dokument

Externí ID
external_id string

ID použité pro odkaz na dokument v externím systému

File
file uri

Dočasná adresa URL původního souboru vyprší za pět minut.

Soubor z obsahu
file_from_content byte

Obsah dokumentu s kódováním Base64

Soubor z názvu obsahu
file_from_content_name string

Název souboru včetně přípony Vyžaduje se při použití file_from_content.

Soubor z adresy URL
file_from_url uri

Veřejně přístupná adresa URL dokumentu, kterou má aplikace SignRequest stáhnout

Z e-mailu
from_email email

E-mail uživatele odesílajícího SignRequest (musí se jednat o ověřený e-mail)

Z e-mailového jména
from_email_name string

Jméno, které se má použít v From záhlaví e-mailu, např. {from_email_name} <no-reply@signrequest.com>

ID front-endu
frontend_id string

Sdílený tajný klíč používaný společně s klientem SignRequest-js k udělení přístupu uživatelů k dokumentu, který není členem týmu dokumentu

Připravuje se
is_being_prepared boolean

Požádejte odesílatele signRequest připravit dokument před odesláním žádosti, viz: příprava pomocí webového rozhraní

Message
message string

Zpráva, která se má zahrnout do e-mailu SignRequest, může obsahovat následující značky HTML: a, abbr, acronym, b, blockquotecode, em, uli, , lia olstrong

Název
name string

Výchozí hodnota názvu souboru, včetně přípony

Hodnota zaškrtávacího políčka Předvyplnění značek
checkbox_value boolean
Předvyplnění hodnoty data značek
date_value date
Externí ID předvyplnění značek
external_id string
Text předvyplnění značek
text string
Příprava adresy URL
prepare_url uri
Adresa URL pro přesměrování
redirect_url uri

Adresa URL, na kterou se SignRequest přesměruje při podepsání dokumentu

Adresa URL pro přesměrování se zamítla.
redirect_url_declined uri

Adresa URL, na kterou se SignRequest přesměruje, když se dokument odmítne

Požadovaný název přílohy
name True string
Požadovaný identifikátor Uuid přílohy
uuid string
Odeslání připomenutí
send_reminders boolean

Automatické připomenutí podepisující osoby k podepsání dokumentu, viz: automatické připomenutí

Podepisující osoby po dokumentu
after_document uri
Schválení jenom podepisující osoby
approve_only boolean

Vyžadování schválení dokumentu uživatelem (bez přidání podpisu) najdete v tématu : Schválení pouze

File
file uri
Požadovaný název přílohy
name True string
Požadovaný identifikátor Uuid přílohy
uuid string
Název
name string

Výchozí hodnota názvu souboru

Uuid
uuid string
Podepisující osoby odmítnuty
declined boolean
Signer Declined On
declined_on date-time
Zobrazovaný název podepisující osoby
display_name string
Stažené podepisující osoby
downloaded boolean
E-mail podepisující osoby
email True email
Zobrazený e-mail podepisující osoby
email_viewed boolean
Podepisující e-mail
emailed boolean
Adresa URL pro vložení podepisující osoby
embed_url uri
ID uživatele adresy URL pro vložení podepisující osoby
embed_url_user_id string
Jméno podepisující osoby
first_name string
Jazyk vynucení podepisující osoby
force_language boolean
Předané podepisující osoby
forwarded boolean
Signer Forwarded On
forwarded_on date-time
Důvod přeposlání podepisující osoby
forwarded_reason string
Podepisující příjemce přeposlaný na e-mail
forwarded_to_email email
Přihlašovací osoba
in_person boolean

Pokud se použije v kombinaci s adresou URL pro vložení odesílatele, po podepsání odesílatele se přesměruje na další in_person podepisující osobu, viz: Přihlášení osobou

Hodnota zaškrtávacího políčka
checkbox_value boolean
Hodnota data
date_value date
Externí ID
external_id string
Index stránky
page_index True integer
Zástupný symbol uuid
placeholder_uuid string
Text
text string
Typ
type string
Jazyk podepisující osoby
language string
Příjmení podepisující osoby
last_name string
Zpráva podepisující osoby
message string
Podepisující uživatel musí podepsat
needs_to_sign boolean

Pokud false uživatel nemusí podepsat, ale obdrží kopii podepsaného dokumentu a podpisového protokolu, přečtěte si téma: Pouze kopírování

Pouze oznámení podepisující osoby
notify_only boolean

Odesílání oznámení o dokumentu a kopii podepsaného dokumentu a podpisového protokolu, ale nevyžaduje je k provedení žádné akce, viz: Pouze upozornění

Pořadí podepisující osoby
order integer
Heslo podepisující osoby
password string

Před podepsáním dokumentu vyžadovat, aby podepisující správce zadal toto heslo. Toto pole je jen pro zápis.

Adresa URL pro přesměrování podepisující osoby
redirect_url uri
Adresa URL pro přesměrování podepisující osoby byla odmítnuta.
redirect_url_declined uri
Podepsaná podepisující osoby
signed boolean
Přihlášení podepisující osoby
signed_on date-time
Podpis používá razítko pouze ke schválení
use_stamp_for_approve_only boolean

Když podepisující podepisující dokument schválí dokument, umístěte na dokument schvalovací razítko.

Ověření bankovního účtu podepisující osoby
verify_bank_account string
Podepisující osoby – Ověření telefonního čísla
verify_phone_number string
Zobrazení podepisující osoby
viewed boolean
Tým
subdomain string
Předmět
subject string

Předmět e-mailu SignRequest

Template
template uri
Ověření textové zprávy je uzamčené
text_message_verification_locked boolean

Pokud je potřeba ověřit textovou zprávu, než podepisující uživatel uvidí dokument

URL
url uri
Uuid
uuid string
Kdo
who string

m: pouze já, mo: já a ostatní, o: pouze ostatní

Návraty

Aktivační události

Když se změní stav dokumentu

Aktivuje se, když se změní stav dokumentu signRequest.

Když se změní stav dokumentu

Aktivuje se, když se změní stav dokumentu signRequest.

Parametry

Name Klíč Vyžadováno Typ Description
Vytvořené
created date-time
Typ události
event_type True string
Název
name string

Nepovinný název pro snadnou identifikaci toho, k čemu se webhook používá

Tým
subdomain string
Název týmu
name string
Subdoména týmu
subdomain uri
Adresa URL týmu
url uri
URL
url uri
Uuid
uuid string

Návraty

Name Cesta Typ Description
dokument
document Document

Definice

Dokument

Name Cesta Typ Description
Použité rozhraní API dokumentů
api_used boolean

Určuje, jestli byl dokument vytvořen pomocí rozhraní API.

attachments
attachments array of DocumentAttachment
Automatické odstranění dokumentu po
auto_delete_after date-time

Datum a čas vypočítaný pomocí auto_delete_days , po kterém se automaticky odstraní hotový dokument (podepsaný, zrušený nebo odmítnutý).

Dny automatického odstranění dokumentu
auto_delete_days integer

Počet dní, po kterých se automaticky odstraní hotový dokument (podepsaný, zrušený nebo odmítnutý)

Platnost automatického vypršení platnosti dokumentu po
auto_expire_after date-time

Datum a čas počítaný pomocí auto_expire_days toho, po kterém se nedokončí dokument automaticky vyprší

Dny automatického vypršení platnosti dokumentu
auto_expire_days integer

Počet dní, po kterých se nedokončí dokument automaticky vyprší

Adresa URL zpětného volání událostí dokumentu
events_callback_url uri

Adresa URL pro příjem zpětných volání událostí pro tento dokument

Externí ID dokumentu
external_id string

ID použité pro odkaz na dokument v externím systému

Soubor dokumentu
file uri

Dočasná adresa URL původního souboru vyprší za pět minut.

Soubor dokumentu jako pdf
file_as_pdf uri

Dočasná adresa URL původního souboru ve formátu PDF vyprší za pět minut.

Soubor dokumentu z obsahu
file_from_content string

Obsah dokumentu s kódováním Base64

Soubor dokumentu z názvu obsahu
file_from_content_name string

Název souboru včetně přípony Vyžaduje se při použití file_from_content.

Soubor ze sf
file_from_sf FileFromSf
Soubor dokumentu z adresy URL
file_from_url uri

Veřejně přístupná adresa URL dokumentu, kterou má aplikace SignRequest stáhnout

ID front-endu dokumentu
frontend_id string

Sdílený tajný klíč používaný společně s klientem SignRequest-js k udělení přístupu uživatelů k dokumentu, který není členem týmu dokumentu

Název dokumentu
name string

Výchozí hodnota názvu souboru, včetně přípony

Dokument PDF
pdf uri

Dočasná adresa URL podepsaného dokumentu ve formátu PDF vyprší za pět minut.

prefill_tags
prefill_tags array of InlinePrefillTags

Vstupní data předvyplnění podepisující osoby, viz značky předběžného vyplňování

Zpracování dokumentů
processing boolean

Určuje, zda se změna dokumentu zpracovává a pdf může být zastaralý. Před stažením souboru PDF se doporučuje počkat na dokončení zpracování. Webhooky se neodesílají, dokud se zpracování nedokončilo.

Sandbox dokumentu
sandbox boolean

Označuje, jestli byl dokument vytvořen jako součást týmu sandboxu.

Hodnota hash zabezpečení dokumentu
security_hash string

Hash SHA256 obsahu PDF

Podpisový protokol PDF
signing_log.pdf uri

Dočasná adresa URL pro podpisový protokol vyprší za pět minut.

Podpisová hodnota hash zabezpečení protokolu
signing_log.security_hash string

Hash SHA256 obsahu PDF

Signrequest Disable Attachments
signrequest.disable_attachments boolean

Zakázání nahrávání a přidávání příloh

Signrequest Disable Blockchain Proof
signrequest.disable_blockchain_proof boolean

Zakáže ukládání hodnot hash kontroly časových razítek do blockchainových integrací.

Signrequest Disable Date
signrequest.disable_date boolean

Zakázání přidávání kalendářních dat

Signrequest Disable Email
signrequest.disable_emails boolean

Zakažte všechny e-maily stavu SignRequest i e-mail obsahující podepsané dokumenty.

Signrequest Disable Text
signrequest.disable_text boolean

Zakázání přidávání textu

Signrequest Disable Text Signatures
signrequest.disable_text_signatures boolean

Zakázání použití podpisů generovaných zadáním (textu)

Signrequest Disable Upload Signatures
signrequest.disable_upload_signatures boolean

Zakázání použití nahraných podpisů (obrázků)

Signrequest From Email
signrequest.from_email email

E-mail uživatele odesílajícího SignRequest (musí se jednat o ověřený e-mail)

Signrequest From Email Name
signrequest.from_email_name string

Jméno, které se má použít v From záhlaví e-mailu, např. {from_email_name} <no-reply@signrequest.com>

Signrequest Is Being Prepared
signrequest.is_being_prepared boolean

Požádejte odesílatele signRequest připravit dokument před odesláním žádosti, viz: příprava pomocí webového rozhraní

Zpráva signrequest
signrequest.message string

Zpráva, která se má zahrnout do e-mailu SignRequest, může obsahovat následující značky HTML: a, abbr, acronym, b, blockquotecode, em, uli, , lia olstrong

Přihlašovací adresa URL pro přípravu
signrequest.prepare_url uri
Adresa URL pro přesměrování signrequest
signrequest.redirect_url uri

Adresa URL, na kterou se SignRequest přesměruje při podepsání dokumentu

Adresa URL pro přesměrování signrequest byla odmítnuta.
signrequest.redirect_url_declined uri

Adresa URL, na kterou se SignRequest přesměruje, když se dokument odmítne

required_attachments
signrequest.required_attachments array of RequiredAttachment
Odeslání připomenutí signrequest
signrequest.send_reminders boolean

Automatické připomenutí podepisující osoby k podepsání dokumentu, viz: automatické připomenutí

Signatáři
signrequest.signers array of Signer
Předmět signrequest
signrequest.subject string

Předmět e-mailu SignRequest

Ověření textové zprávy signrequest uzamčeno
signrequest.text_message_verification_locked boolean

Pokud je potřeba ověřit textovou zprávu, než podepisující uživatel uvidí dokument

Signrequest Uuid
signrequest.uuid string
Signrequest Who
signrequest.who string

m: pouze já, mo: já a ostatní, o: pouze ostatní

Stav dokumentu
status string

co: converting, ne: new, se: sent, vi: viewed, si: signed, do: downloaded, sd: signed and downloaded, ca: cancelled, de: declined, ec: error converting, es: error sending, xp: expired

Název týmu
team.name string
Subdoména týmu
team.subdomain uri
Adresa URL týmu
team.url uri
Šablona dokumentu
template uri
Adresa URL dokumentu
url uri
Uživatel
user User
Uuid dokumentu
uuid string

Připojení k dokumentu

Name Cesta Typ Description
Dokument přílohy dokumentu
document uri
Soubor přílohy dokumentu
file uri

Dočasná adresa URL přílohy dokumentu vyprší za pět minut.

Soubor přílohy dokumentu z obsahu
file_from_content string

Obsah dokumentu s kódováním Base64

Soubor přílohy dokumentu z názvu obsahu
file_from_content_name string

Název souboru včetně přípony Vyžaduje se při použití file_from_content.

Soubor přílohy dokumentu z adresy URL
file_from_url uri

Veřejně přístupná adresa URL dokumentu, kterou má aplikace SignRequest stáhnout

Název přílohy dokumentu
name string

Výchozí hodnota názvu souboru, včetně přípony

Adresa URL přílohy dokumentu
url uri
Uuid přílohy dokumentu
uuid string

FileFromSf

Name Cesta Typ Description
ID objektu
object_id string
Typ objektu
object_type string
Uid
uid string

InlinePrefillTags

Vstupní data předvyplnění podepisující osoby, viz značky předběžného vyplňování

Name Cesta Typ Description
Hodnota zaškrtávacího políčka Předvyplnění značek
checkbox_value boolean
Předvyplnění hodnoty data značek
date_value date
Externí ID předvyplnění značek
external_id string
Text předvyplnění značek
text string

Povinné připojení

Name Cesta Typ Description
Požadovaný název přílohy
name string
Požadovaný identifikátor Uuid přílohy
uuid string

SignRequestQuickCreate

Name Cesta Typ Description
Automatické odstranění dnů
auto_delete_days integer

Počet dní, po kterých se automaticky odstraní hotový dokument (podepsaný, zrušený nebo odmítnutý)

Automatické vypršení platnosti dnů
auto_expire_days integer

Počet dní, po kterých se nedokončí dokument automaticky vyprší

Zakázání příloh
disable_attachments boolean

Zakázání nahrávání a přidávání příloh

Zákaz kontroly blockchainu
disable_blockchain_proof boolean

Zakáže ukládání hodnot hash kontroly časových razítek do blockchainových integrací.

Zakázat datum
disable_date boolean

Zakázání přidávání kalendářních dat

Zakázání e-mailů
disable_emails boolean

Zakažte všechny e-maily stavu SignRequest i e-mail obsahující podepsané dokumenty.

Zakázání textu
disable_text boolean

Zakázání přidávání textu

Zakázání textových podpisů
disable_text_signatures boolean

Zakázání použití podpisů generovaných zadáním (textu)

Zákaz nahrání podpisů
disable_upload_signatures boolean

Zakázání použití nahraných podpisů (obrázků)

Dokument
document uri
Adresa URL zpětného volání událostí
events_callback_url uri

Adresa URL pro příjem zpětných volání událostí pro tento dokument

Externí ID
external_id string

ID použité pro odkaz na dokument v externím systému

File
file uri

Dočasná adresa URL původního souboru vyprší za pět minut.

Soubor z obsahu
file_from_content byte

Obsah dokumentu s kódováním Base64

Soubor z názvu obsahu
file_from_content_name string

Název souboru včetně přípony Vyžaduje se při použití file_from_content.

Soubor z adresy URL
file_from_url uri

Veřejně přístupná adresa URL dokumentu, kterou má aplikace SignRequest stáhnout

Z e-mailu
from_email email

E-mail uživatele odesílajícího SignRequest (musí se jednat o ověřený e-mail)

Z e-mailového jména
from_email_name string

Jméno, které se má použít v From záhlaví e-mailu, např. {from_email_name} <no-reply@signrequest.com>

ID front-endu
frontend_id string

Sdílený tajný klíč používaný společně s klientem SignRequest-js k udělení přístupu uživatelů k dokumentu, který není členem týmu dokumentu

Připravuje se
is_being_prepared boolean

Požádejte odesílatele signRequest připravit dokument před odesláním žádosti, viz: příprava pomocí webového rozhraní

Message
message string

Zpráva, která se má zahrnout do e-mailu SignRequest, může obsahovat následující značky HTML: a, abbr, acronym, b, blockquotecode, em, uli, , lia olstrong

Název
name string

Výchozí hodnota názvu souboru, včetně přípony

prefill_tags
prefill_tags array of InlinePrefillTags

Vstupní data předvyplnění podepisující osoby, viz značky předběžného vyplňování

Příprava adresy URL
prepare_url uri
Adresa URL pro přesměrování
redirect_url uri

Adresa URL, na kterou se SignRequest přesměruje při podepsání dokumentu

Adresa URL pro přesměrování se zamítla.
redirect_url_declined uri

Adresa URL, na kterou se SignRequest přesměruje, když se dokument odmítne

required_attachments
required_attachments array of RequiredAttachment

Přílohy, které podepisující osoby vyžadují k nahrání

Odeslání připomenutí
send_reminders boolean

Automatické připomenutí podepisující osoby k podepsání dokumentu, viz: automatické připomenutí

Signatáři
signers array of Signer
Tým
subdomain string
Předmět
subject string

Předmět e-mailu SignRequest

Template
template uri
Ověření textové zprávy je uzamčené
text_message_verification_locked boolean

Pokud je potřeba ověřit textovou zprávu, než podepisující uživatel uvidí dokument

URL
url uri
Uuid
uuid string
Kdo
who string

m: pouze já, mo: já a ostatní, o: pouze ostatní

Signatář

Name Cesta Typ Description
Podepisující osoby po dokumentu
after_document uri
Schválení jenom podepisující osoby
approve_only boolean

Vyžadování schválení dokumentu uživatelem (bez přidání podpisu) najdete v tématu : Schválení pouze

attachments
attachments array of SignerAttachment
Podepisující osoby odmítnuty
declined boolean
Signer Declined On
declined_on date-time
Zobrazovaný název podepisující osoby
display_name string
Stažené podepisující osoby
downloaded boolean
E-mail podepisující osoby
email email
Zobrazený e-mail podepisující osoby
email_viewed boolean
Podepisující e-mail
emailed boolean
Adresa URL pro vložení podepisující osoby
embed_url uri
ID uživatele adresy URL pro vložení podepisující osoby
embed_url_user_id string
Jméno podepisující osoby
first_name string
Jazyk vynucení podepisující osoby
force_language boolean
Předané podepisující osoby
forwarded boolean
Signer Forwarded On
forwarded_on date-time
Důvod přeposlání podepisující osoby
forwarded_reason string
Podepisující příjemce přeposlaný na e-mail
forwarded_to_email email
Přihlašovací osoba
in_person boolean

Pokud se použije v kombinaci s adresou URL pro vložení odesílatele, po podepsání odesílatele se přesměruje na další in_person podepisující osobu, viz: Přihlášení osobou

vstupy
inputs array of SignerInputs
Jazyk podepisující osoby
language string
Příjmení podepisující osoby
last_name string
Zpráva podepisující osoby
message string
Podepisující uživatel musí podepsat
needs_to_sign boolean

Pokud false uživatel nemusí podepsat, ale obdrží kopii podepsaného dokumentu a podpisového protokolu, přečtěte si téma: Pouze kopírování

Pouze oznámení podepisující osoby
notify_only boolean

Odesílání oznámení o dokumentu a kopii podepsaného dokumentu a podpisového protokolu, ale nevyžaduje je k provedení žádné akce, viz: Pouze upozornění

Pořadí podepisující osoby
order integer
Heslo podepisující osoby
password string

Před podepsáním dokumentu vyžadovat, aby podepisující správce zadal toto heslo. Toto pole je jen pro zápis.

Adresa URL pro přesměrování podepisující osoby
redirect_url uri
Adresa URL pro přesměrování podepisující osoby byla odmítnuta.
redirect_url_declined uri
Podepsaná podepisující osoby
signed boolean
Přihlášení podepisující osoby
signed_on date-time
Podpis používá razítko pouze ke schválení
use_stamp_for_approve_only boolean

Když podepisující podepisující dokument schválí dokument, umístěte na dokument schvalovací razítko.

Ověření bankovního účtu podepisující osoby
verify_bank_account string
Podepisující osoby – Ověření telefonního čísla
verify_phone_number string
Zobrazení podepisující osoby
viewed boolean

Připojení podepisující osoby

Name Cesta Typ Description
File
file uri
for_attachment
for_attachment RequiredAttachment
Název
name string

Výchozí hodnota názvu souboru

Uuid
uuid string

SignerInputs

Name Cesta Typ Description
Hodnota zaškrtávacího políčka
checkbox_value boolean
Hodnota data
date_value date
Externí ID
external_id string
Index stránky
page_index integer
Zástupný symbol uuid
placeholder_uuid string
Text
text string
Typ
type string

Uživatel

Name Cesta Typ Description
Zobrazované jméno uživatele
display_name string
E-mailová adresa uživatele
email email
Jméno uživatele
first_name string
Příjmení uživatele
last_name string