RSign (Preview)
RSign® je zabezpečená právně závazná platforma elektronického podpisu, která zjednodušuje pracovní postupy dokumentů. Tento konektor umožňuje uživatelům automatizovat odesílání žádostí o podpis, sledovat stav obálky v reálném čase a načítat dokončené podepsané dokumenty a podpisové certifikáty. Zvyšuje obchodní efektivitu tím, že digitalizuje provádění dokumentů a zajišťuje zabezpečené, sledovatelné digitální transakce.
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 RSign |
| URL | https://rsign.com/contact/questions |
| support@rpost.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | RPost US Inc |
| Vydavatel | RPost US Inc |
| Internetová stránka | https://rpost.com/ |
| Zásady ochrany osobních údajů | https://rpost.com/legal-notices/privacy-notice |
| Kategorie | Obsah a soubory; Produktivita |
Přehled vlastního konektoru RSign
Název konektoru: Popis RSign : RSign® je platforma elektronického podpisu a správy digitálních transakcí pro zabezpečené, právně závazné a zjednodušené pracovní postupy dokumentů. Vydavatel: RPost
1. Možnosti konektoru
Konektor RSign® poskytuje přístup k funkcím pro správu elektronických podpisů a dokumentů, které uživatelům umožňují integrovat pracovní postupy RSign přímo do svých řešení Power Platform (Power Automate, Power Apps a Logic Apps).
Klíčové akce
Konektor aktuálně podporuje následující primární operace:
-
Získání ověřovacího tokenu: Ověřuje uživatele na základě přihlašovacích údajů RSign® a načte potřebný token (
AuthToken) vyžadovaný pro všechna následná volání rozhraní API. - Odeslání obálky pomocí šablony: Odešle dokument pro e-podpis pomocí předem nakonfigurované šablony RSign® a mapuje role šablony konkrétním příjemcům.
- Odeslat obálku pomocí pravidla: Odešle dokument pro podpis e-podpis pomocí předem nakonfigurovaného pravidla RSign®, které umožňuje zadat dokumenty jako data Base64 v textu požadavku.
-
Načtení informací o šabloně: Načte podrobnosti o konkrétní šabloně nebo pravidle RSign®, včetně definovaných dokumentů a rolí příjemců (
RoleID). - Načíst stav obálky: Načte stav žádosti o podpis e pomocí kódu obálky.
- Načíst dokumenty obálky: Stáhne dokumenty přidružené k obálce (původní nebo konečné podepsané dokumenty).
2. Nastavení ověřování
Konektor RSign® používá vlastní schéma ověřování, které před provedením jakékoli jiné akce vyžaduje úspěšné volání Get AuthToken akce.
Akce ověřování (Get AuthToken)
Tato akce vyžaduje následující přihlašovací údaje, které je nutné získat z platformy RSign®:
| Název parametru | Typ | Description | Viditelnost |
|---|---|---|---|
ReferenceKey |
řetězec | Referenční klíč přidružený k vašemu účtu RPost®. | Důležité |
EmailId |
řetězec | E-mailová adresa vašeho účtu RSign®. | Důležité |
Password |
heslo | Heslo pro váš účet RSign®. | Důležité |
Použití AuthToken
Akce Get AuthToken vrátí AuthToken v textu odpovědi. Tento token se pak musí předat v následných voláních rozhraní API všem ostatním podporovaným akcím.
Poznámka: Má AuthToken čas vypršení platnosti (AuthTokenExpires) a měl by být spravován v rámci toku nebo logiky aplikace, aby se zajistilo, že se při vypršení platnosti existujícího tokenu použije nový token.
3. Požadavky
Aby uživatelé mohli úspěšně používat tento vlastní konektor RSign®, musí splňovat následující požadavky:
- Platná licence RSign®: Uživatelé musí mít aktivní a platnou uživatelskou licenci RSign®.
-
Přístup k rozhraní API: Účet RSign® přidružený k zadaným přihlašovacím údajům musí mít povolenou a placenou funkci API Access. Tato funkce je nutná k vygenerování
ReferenceKeya úspěšnému využití konektoru RSign®.
Pokud tyto požadavky aktuálně nesplňujete nebo si nejste jisti, jestli máte aktuální nastavení účtu RSign®, obraťte se na zástupce RPost®.
4. Důležité poznámky k integraci
Použití šablony a pravidla
-
Kód šablony / kód pravidla: Obě
Send Envelopeakce vyžadujíTemplateCode(nebo kód pravidla), který identifikuje předkonfigurovaná pole dokumentu a podpisových polí v RSignu®. -
Mapování rolí: Při odesílání obálky
TemplateRoleRecipientMappingmusí být pole vyplněno. ProRoleIDkaždého příjemce je nutné nejprve načíst akciRetrieve Template Information. Tím zajistíte, že příjemci budou správně namapováni na pole podpisu definovaná v šabloně.
Zpracování dokumentů
-
Odeslat obálku pomocí pravidla: Tato akce vyžaduje, aby byl obsah dokumentu předán jako řetězec s kódováním Base64 (
DocumentBase64Data). -
Načíst dokumenty obálky: Dokumenty se vrátí v textu odpovědi jako řetězce Base64 (
ByteArray). Tento řetězec musí tento řetězec dekódovat, aby se soubor uložil.
Zpracování chyb
Všechny akce vrací informace o stavu v textu odpovědi, včetně:
-
StatusCode(celé číslo) -
StatusMessage(řetězec) -
Message(řetězec)
Uživatelé by měli implementovat kontrolu chyb na StatusCode základě toho, aby se zajistilo úspěšné spuštění operace.
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Načtení dokumentů obálky |
Načte dokumenty, které jsou součástí obálky, na základě jeho kódu obálky. V závislosti na stavu Obálka se načte původní dokumenty nebo konečné podepsané dokumenty. |
| Načtení informací o šabloně |
Načte informace o šabloně nebo pravidle na základě jeho kódu. Mezi vrácené informace patří název šablony, dokumenty a role definované. |
| Načtení stavu obálky |
Načte stav obálky na základě jeho kódu obálky. Můžete vybrat podrobnou nebo souhrnnou sestavu. |
| Odeslání obálky pomocí pravidla |
Odešle žádost eSign vybraným příjemcům pomocí uvedeného pravidla RSign. |
| Odeslání obálky pomocí šablony |
Odešle žádost eSign vybraným příjemcům pomocí určené šablony RSign. |
| Získání ověřovacího tokenu |
Vrátí AuthToken, který se použije ve všech ostatních podporovaných akcích RSign. |
Načtení dokumentů obálky
Načte dokumenty, které jsou součástí obálky, na základě jeho kódu obálky. V závislosti na stavu Obálka se načte původní dokumenty nebo konečné podepsané dokumenty.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Kód obálky
|
EnvelopeCode | True | string |
Kód obálky, která se má načíst. |
|
Ověřovací token
|
AuthToken | True | string |
AuthToken načtený z akce Get AuthToken |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
Status | boolean |
Příznak úspěšného stavu |
|
Kód stavu
|
StatusCode | integer |
Stavový kód odpovědi |
|
Message
|
Message | string |
Popis stavu odpovědi |
|
Stavová zpráva
|
StatusMessage | string |
Stavová zpráva odpovědi |
|
Kód obálky
|
Data.EnvelopeCode | string |
Kód obálky předaný jako parametr. |
|
Seznam dokumentů
|
Data.DocumentList | array of object |
Seznam dokumentů |
|
Typ dokumentu
|
Data.DocumentList.DocumentType | string |
Typ přílohy. |
|
Název souboru
|
Data.DocumentList.FileName | string |
Název souboru |
|
Description
|
Data.DocumentList.Description | string |
Popis dokumentu |
|
Bajtové
|
Data.DocumentList.ByteArray | string |
Soubor ve formátu Base64 |
|
Další informace
|
Data.DocumentList.AdditionalInfo | string |
Další informace. |
|
Popis přílohy
|
Data.DocumentList.AttachmentDescription | string |
Informativní popis obsahu souboru |
|
Přečíst mi
|
Data.ReadMe | string |
Textový soubor ve formátu Base64, který označuje název podepsaného dokumentu a původního souboru. |
|
Kombinovaný zip
|
Data.CombinedZip | string |
Soubor ZIP obsahující všechny dokumenty obálky. |
|
Celkový počet
|
TotalCount | integer |
Celkový počet. |
|
Existuje odesílání příloh.
|
IsAttachmentUploadsExist | string |
Existuje odesílání příloh. |
Načtení informací o šabloně
Načte informace o šabloně nebo pravidle na základě jeho kódu. Mezi vrácené informace patří název šablony, dokumenty a role definované.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Kód šablony
|
TemplateCode | True | string |
Kód šablony, která se má načíst. |
|
Ověřovací token
|
AuthToken | True | string |
AuthToken načtený z akce Get AuthToken |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód stavu
|
StatusCode | integer |
Stavový kód odpovědi |
|
Stavová zpráva
|
StatusMessage | string |
Stavová zpráva odpovědi |
|
Message
|
Message | string |
Popis stavu odpovědi |
|
ID šablony
|
TemplateId | string |
ID šablony. |
|
ID šablony
|
TemplateBasicInfo.TemplateId | string |
ID šablony. |
|
Kód šablony
|
TemplateBasicInfo.TemplateCode | integer |
Kód šablony, který se má použít v jiných akcích. |
|
E-mail uživatele
|
TemplateBasicInfo.UserEmail | string |
E-mail vlastníka šablony uživatele |
|
Název šablony
|
TemplateBasicInfo.TemplateName | string |
Název šablony. |
|
Popis šablony
|
TemplateBasicInfo.TemplateDescription | string |
Popis šablony |
|
Je statická
|
TemplateBasicInfo.IsStatic | string |
Určuje, zda lze šablonu upravit, nebo ne. |
|
Datum vypršení platnosti
|
TemplateBasicInfo.ExpiryDate | string |
Datum, kdy platnost šablony vyprší. |
|
Datum vytvoření
|
TemplateBasicInfo.CreatedDate | string |
Datum vytvoření šablony |
|
Datum poslední změny
|
TemplateBasicInfo.LastModifiedDate | string |
Datum, kdy byla šablona naposledy změněna. |
|
Předmět
|
TemplateBasicInfo.Subject | string |
Předmět šablony e-mailu |
|
Body
|
TemplateBasicInfo.Body | string |
Text šablony e-mailu Kódovaný kód HTML. |
|
Název typu
|
TemplateBasicInfo.TypeName | string |
Typ šablony (možné hodnoty: Šablona, pravidlo). |
|
Seznam dokumentů
|
TemplateBasicInfo.DocumentList | array of object |
Seznam dokumentů |
|
ID dokumentu
|
TemplateBasicInfo.DocumentList.DocumentId | string |
ID části dokumentu šablony. |
|
Název dokumentu
|
TemplateBasicInfo.DocumentList.DocumentName | string |
Název části dokumentu šablony |
|
Objednávka
|
TemplateBasicInfo.DocumentList.Order | integer |
Pořadí části dokumentu šablony v seznamu dokumentů |
|
Podrobnosti o obsahu dokumentu
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
Podrobnosti o obsahu dokumentu |
|
ID ovládacího prvku
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
Interní ID ovládacího prvku použitého v dokumentu |
|
Název ovládacího prvku
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
Název ovládacího prvku použitého v dokumentu |
|
Ovládací prvek HTML ID
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
ID HTML ovládacího prvku použitého v dokumentu |
|
Název skupiny
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
Název skupiny, která obsahuje ovládací prvek. |
|
Označení
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
Název ovládacího prvku, který se má zobrazit v dokumentu. |
|
Číslo stránky
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
Stránka v dokumentu, ve kterém je ovládací prvek umístěn. |
|
Povinné
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
Jestli je ovládací prvek povinný, nebo ne. |
|
Hodnota ovládacího prvku
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
Předem vyplněná hodnota ovládacího prvku. |
|
Role Id
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
ID role, která potřebuje vyplnit ovládací prvek. |
|
Název role
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
Název role, která potřebuje vyplnit ovládací prvek. |
|
Vybrat možnosti ovládacího prvku
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
Vyberte Možnosti ovládacího prvku. |
|
Seznam rolí šablon
|
TemplateBasicInfo.TemplateRoleList | array of object |
Seznam příjemců |
|
Role ID
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
ID části role této šablony. |
|
Název role
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
Název části role této šablony. |
|
Objednávka
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
Pořadí, ve kterém role (příjemce) potřebuje šablonu dokončit. |
|
E-mail příjemce
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
Předem vyplněný e-mail příjemce části této šablony. |
|
Jméno příjemce
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
Předem vyplněné jméno části této šablony příjemce |
|
ID typu příjemce
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
Interní ID typu příjemce. |
|
ID příjemce
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
ID části této šablony příjemce. |
|
Typ příjemce
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
Typ příjemce |
|
Typ podepisující osoby kopie
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
Typ příjemce kopie. |
|
Informace o kultuře
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
Jedná se o jazyk služby uživatele v okamžiku vytvoření šablony nebo pravidla. |
|
Režim doručení
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
Označuje kanál, přes který se příjemci odeslal požadavek na podpis a přístupový kód. |
|
Číselný kód
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
Vytočte kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Kód země
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
Kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Číslo mobilního zařízení
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
Číslo příjemce mobilního zařízení |
|
Mobilní režim
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
Označuje mobilní kanál, prostřednictvím kterého se příjemci odeslal požadavek na podpis a přístupový kód. |
|
E-mailová adresa
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
E-mailová adresa příjemce |
|
Povolit zprávu na mobilní zařízení
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
Povolte zprávu na mobilní zařízení. |
|
Datum vypršení platnosti statického propojení
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
Datum vypršení platnosti statického propojení |
|
Seznam šablon
|
TemplateList | string |
Seznam šablon |
Načtení stavu obálky
Načte stav obálky na základě jeho kódu obálky. Můžete vybrat podrobnou nebo souhrnnou sestavu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Ověřovací token
|
AuthToken | True | string |
AuthToken načtený z akce Get AuthToken |
|
EnvelopeCode
|
EnvelopeCode | True | string |
Kód obálky. |
|
DetailOrSummary
|
DetailOrSummary | True | string |
Vyberte požadovaný typ sestavy. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Stav
|
Status | boolean |
Stav žádosti |
|
Kód stavu
|
StatusCode | integer |
Stavový kód odpovědi |
|
Message
|
Message | string |
Popis stavu odpovědi |
|
Stavová zpráva
|
StatusMessage | string |
Stavová zpráva odpovědi |
|
Seznam dat obálky
|
Data | array of object | |
|
Kód obálky
|
Data.EnvelopeCode | string |
ID obálky. |
|
ID obálky
|
Data.EnvelopeID | string |
Interní ID obálky. |
|
Předmět
|
Data.Subject | string |
Předmět obálky e-mailem. |
|
Stav obálky
|
Data.Status | string |
Stav požadované obálky |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
Označuje, zda je obálka dokončena. |
|
Datum odeslání
|
Data.SentDate | string |
Datum odeslání obálky. |
|
Datum poslední změny
|
Data.LastModifiedDate | string |
Datum poslední změny. |
|
SenderName
|
Data.SenderName | string |
Jméno odesílatele. |
|
SenderEmail
|
Data.SenderEmail | string |
E-mail odesílatele |
|
Podrobnosti o příjemci
|
Data.RecipientDetails | array of object | |
|
ID příjemce
|
Data.RecipientDetails.RecipientID | string |
ID části obálky příjemce. |
|
ID typu příjemce
|
Data.RecipientDetails.RecipientTypeID | string |
Zadejte ID příjemce části aktuální obálky. |
|
Typ příjemce
|
Data.RecipientDetails.RecipientType | string |
Typ příjemce části obálky. Možné hodnoty jsou: Podepisující a předvyplnění. |
|
Jméno příjemce
|
Data.RecipientDetails.RecipientName | string |
Jméno příjemce. |
|
Email
|
Data.RecipientDetails.Email | string |
E-mailová adresa příjemce |
|
Objednávka
|
Data.RecipientDetails.Order | integer |
Pořadí, ve kterém příjemce potřebuje přístup k dokončení obálky. |
|
ID stavu
|
Data.RecipientDetails.StatusId | string |
ID stavu |
|
Stav podepisování
|
Data.RecipientDetails.SigningStatus | string |
Stav podpisu pro příjemce obálky |
|
Datum poslední změny
|
Data.RecipientDetails.LastModifiedDate | string |
Datum poslední změny. |
|
Referenční kód
|
Data.ReferenceCode | string |
Část referenčního kódu obálky. |
|
Referenční e-mail
|
Data.ReferenceEmail | string |
Referenční e-mailová část obálky. |
|
TotalCount
|
TotalCount | integer |
Celkové množství obálek odpovídajících požadovaným kritériím. |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
Existuje odesílání příloh. |
Odeslání obálky pomocí pravidla
Odešle žádost eSign vybraným příjemcům pomocí uvedeného pravidla RSign.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Ověřovací token
|
AuthToken | True | string |
AuthToken načtený z akce Get AuthToken |
|
TemplateCode
|
TemplateCode | True | string |
ID pravidla, které se má použít. |
|
Název
|
Name | True | string |
Název dokumentu Zahrňte příponu (příklad: Agreement.docx). |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Dokument, který se má odeslat ve formátu Base64 |
|
Klíč aplikace
|
AppKey | string |
Jedinečný identifikátor systému, který používá konektor. Požádejte ho o podporu RPost®. |
|
|
ID role
|
RoleID | True | string |
ID role pro příjemce Načteno z akce Načíst informace o šabloně. |
|
Příjemce E-mailu
|
RecipientEmail | True | string |
E-mailová adresa příjemce |
|
Jméno příjemce
|
RecipientName | True | string |
Jméno příjemce. |
|
Mobilní zařízení
|
Mobile | string |
Číslo příjemce mobilního zařízení Pokud pravidlo nevyžaduje, nechejte prázdné. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód obálky
|
EnvelopeCode | string |
ID obálky. |
|
Zpráva změněná průhledností
|
TransparencyChangedMessage | string |
Zpráva se změněnou průhledností |
|
Zpráva rozhraní API na základě jazyka
|
LanguageBasedApiMessge | string |
Zpráva rozhraní API založená na jazyce |
|
Předvyplnění ID příjemce
|
PrefillRecipientId | string |
Předem vyplňte ID příjemce. |
|
Po odeslání navigační stránky
|
PostSendingNavigationPage | string |
Web, na který se příjemce přesměruje, až dokončí podepsání obálky. |
|
Je povolené nové uživatelské rozhraní podepisující osoby
|
IsNewSignerUIEnabled | boolean |
Je povolené nové uživatelské rozhraní podepisující osoby. |
|
Kód stavu
|
StatusCode | integer |
Stavový kód odpovědi |
|
Stavová zpráva
|
StatusMessage | string |
Stavová zpráva odpovědi |
|
Message
|
Message | string |
Popis stavu odpovědi |
|
ID obálky
|
EnvelopeId | string |
Interní ID vygenerované obálky. |
|
Podepsat adresu URL dokumentu
|
SignDoumentUrl | string |
Globální adresa URL podpisu obálky |
|
Seznam příjemců
|
RecipientList | array of object |
Podrobnosti o příjemci |
|
Jméno příjemce
|
RecipientList.RecipientName | string |
Jméno příjemce. |
|
E-mail příjemce
|
RecipientList.RecipientEmail | string |
E-mailová adresa příjemce |
|
Objednávka
|
RecipientList.Order | integer |
Pořadí, ve kterém příjemce potřebuje přístup k dokončení obálky. |
|
Typ
|
RecipientList.Type | string |
Typ příjemce části obálky. Možné hodnoty jsou: Podepisující a předvyplnění. |
|
Režim doručení
|
RecipientList.DeliveryMode | integer |
Označuje kanál, přes který se příjemci odeslal požadavek na podpis a přístupový kód. |
|
Číselný kód
|
RecipientList.DialCode | string |
Vytočte kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Kód země
|
RecipientList.CountryCode | string |
Kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Číslo mobilního zařízení
|
RecipientList.Mobile | string |
Číslo příjemce mobilního zařízení |
|
Mobilní režim
|
RecipientList.MobileMode | integer |
Označuje mobilní kanál, prostřednictvím kterého se příjemci odeslal požadavek na podpis a přístupový kód. |
|
Podpisová adresa URL
|
RecipientList.SigningUrl | string |
Adresa URL, kterou příjemce použije pro přístup a podepsání obálky. |
|
Rozevírací seznam čísel čísel
|
DialCodeDropdownList | string |
Číselný rozevírací seznam kódu |
|
Povolit zprávu na mobilní zařízení
|
EnableMessageToMobile | string |
Povolte zprávu na mobilní zařízení. |
Odeslání obálky pomocí šablony
Odešle žádost eSign vybraným příjemcům pomocí určené šablony RSign.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Ověřovací token
|
AuthToken | True | string |
AuthToken načtený z akce Get AuthToken |
|
TemplateCode
|
TemplateCode | True | string |
ID šablony, která se má použít. |
|
Klíč aplikace
|
AppKey | string |
Jedinečný identifikátor systému, který používá konektor. Požádejte ho o podporu RPost®. |
|
|
ID role
|
RoleID | True | string |
ID role pro příjemce Načteno z akce Načíst informace o šabloně. |
|
Příjemce E-mailu
|
RecipientEmail | True | string |
E-mailová adresa příjemce |
|
Jméno příjemce
|
RecipientName | True | string |
Jméno příjemce. |
|
Mobilní zařízení
|
Mobile | string |
Číslo příjemce mobilního zařízení Pokud ji vaše šablona nevyžaduje, nechte prázdnou. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód obálky
|
EnvelopeCode | string |
ID obálky. |
|
Zpráva změněná průhledností
|
TransparencyChangedMessage | string |
Zpráva se změněnou průhledností |
|
Zpráva rozhraní API na základě jazyka
|
LanguageBasedApiMessge | string |
Zpráva rozhraní API založená na jazyce |
|
Předvyplnění ID příjemce
|
PrefillRecipientId | string |
Předem vyplňte ID příjemce. |
|
Po odeslání navigační stránky
|
PostSendingNavigationPage | string |
Web, na který se příjemce přesměruje, až dokončí podepsání obálky. |
|
Je povolené nové uživatelské rozhraní podepisující osoby
|
IsNewSignerUIEnabled | boolean |
Je povolené nové uživatelské rozhraní podepisující osoby. |
|
Kód stavu
|
StatusCode | integer |
Stavový kód odpovědi |
|
Stavová zpráva
|
StatusMessage | string |
Stavová zpráva odpovědi |
|
Message
|
Message | string |
Popis stavu odpovědi |
|
ID obálky
|
EnvelopeId | string |
Interní ID vygenerované obálky. |
|
Podepsat adresu URL dokumentu
|
SignDoumentUrl | string |
Globální adresa URL podpisu obálky |
|
Seznam příjemců
|
RecipientList | array of object |
Podrobnosti o příjemci |
|
Jméno příjemce
|
RecipientList.RecipientName | string |
Jméno příjemce části obálky. |
|
E-mail příjemce
|
RecipientList.RecipientEmail | string |
E-mailová adresa příjemce části obálky. |
|
Objednávka
|
RecipientList.Order | integer |
Pořadí, ve kterém příjemce potřebuje přístup k dokončení obálky. |
|
Typ
|
RecipientList.Type | string |
Typ příjemce části obálky. Možné hodnoty jsou: Podepisující a předvyplnění. |
|
Režim doručení
|
RecipientList.DeliveryMode | integer |
Označuje kanál, přes který se příjemci odeslal požadavek na podpis a přístupový kód. |
|
Číselný kód
|
RecipientList.DialCode | string |
Vytočte kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Kód země
|
RecipientList.CountryCode | string |
Kód země, kde se odeslala žádost o podpis a přístupový kód. |
|
Číslo mobilního zařízení
|
RecipientList.Mobile | string |
Číslo příjemce mobilního zařízení |
|
Mobilní režim
|
RecipientList.MobileMode | integer |
Označuje mobilní kanál, prostřednictvím kterého se příjemci odeslal požadavek na podpis a přístupový kód. |
|
Podpisová adresa URL
|
RecipientList.SigningUrl | string |
Adresa URL, kterou příjemce použije pro přístup a podepsání obálky. |
|
Rozevírací seznam čísel čísel
|
DialCodeDropdownList | string |
Číselný rozevírací seznam kódu |
|
Povolit zprávu na mobilní zařízení
|
EnableMessageToMobile | string |
Povolte zprávu na mobilní zařízení. |
Získání ověřovacího tokenu
Vrátí AuthToken, který se použije ve všech ostatních podporovaných akcích RSign.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
Jedinečný identifikátor vašeho účtu společnosti. |
|
Id e-mailu
|
EmailId | True | string |
E-mailová adresa vašeho účtu RSign. |
|
Heslo
|
Password | True | password |
Heslo účtu RSign. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Ověřovací zpráva
|
AuthMessage | string |
Stavová zpráva odpovědi |
|
Ověřovací token
|
AuthToken | string |
Ověřovací token, který se má použít v jiných akcích RSign. |
|
Obnovovací token
|
RefreshToken | string |
Obnovte token. |
|
Platnost obnovovacího tokenu vyprší
|
RefreshTokenExpires | string |
Datum, kdy vyprší platnost aktuálního obnovovacího tokenu. |
|
Platnost ověřovacího tokenu vyprší
|
AuthTokenExpires | string |
Datum, kdy vyprší platnost aktuálního ověřovacího tokenu. |
|
ID e-mailu
|
EmailId | string |
E-mail ověřeného uživatele |
|
API Id
|
ApiId | string |
ID rozhraní API. |