Udostępnij przez

RSign (wersja zapoznawcza)

RSign® to bezpieczna, prawnie wiążąca platforma podpisu elektronicznego, która usprawnia przepływy pracy dokumentów. Ten łącznik umożliwia użytkownikom automatyzowanie wysyłania żądań podpisów, śledzenie stanu koperty w czasie rzeczywistym oraz pobieranie ukończonych podpisanych dokumentów i certyfikatów podpisów. Zwiększa wydajność biznesową, cyfrując wykonywanie dokumentów i zapewniając bezpieczne, śledzone transakcje cyfrowe.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Obsługa znaku RSign
adres URL https://rsign.com/contact/questions
Email support@rpost.com
Metadane łącznika
Publisher RPost US Inc
Publisher RPost US Inc
Witryna internetowa https://rpost.com/
Zasady ochrony prywatności https://rpost.com/legal-notices/privacy-notice
Kategorie Zawartość i pliki; Produktywność

Omówienie łącznika niestandardowego RSign

Nazwa łącznika: Opis znaku RSign : RSign® to platforma do zarządzania transakcjami cyfrowymi i podpisami elektronicznymi umożliwiającą bezpieczne, prawnie wiążące i usprawnione przepływy pracy dokumentów. Wydawca: RPost

1. Możliwości łącznika

Łącznik RSign zapewnia dostęp do funkcji zarządzania podpisami elektronicznymi i dokumentami, umożliwiając użytkownikom integrowanie przepływów pracy RSign® bezpośrednio z rozwiązaniami platformy Power Platform (Power Automate, Power Apps i Logic Apps).

Kluczowe akcje

Łącznik obsługuje obecnie następujące operacje podstawowe:

  • Uzyskiwanie tokenu AuthToken: Uwierzytelnia użytkownika na podstawie poświadczeń RSign® i pobiera niezbędny token (AuthToken) wymagany dla wszystkich kolejnych wywołań interfejsu API.
  • Wyślij kopertę przy użyciu szablonu: Wysyła dokument do podpisu elektronicznego przy użyciu wstępnie skonfigurowanego szablonu RSign®, mapowania ról szablonu do określonych adresatów.
  • Wyślij kopertę przy użyciu reguły: Wysyła dokument do podpisu elektronicznego przy użyciu wstępnie skonfigurowanej reguły znaku RSign®, co umożliwia dostarczenie dokumentów jako danych Base64 w treści żądania.
  • Pobieranie informacji o szablonie: Pobiera szczegółowe informacje o określonym szablonie lub regule RSign®, w tym o zdefiniowanych dokumentach i rolach adresatów (RoleID).
  • Pobierz stan koperty: Pobiera stan żądania podpisu elektronicznego przy użyciu kodu koperty.
  • Pobierz dokumenty koperty: Pobiera dokumenty skojarzone z kodem koperty (oryginalne i/lub końcowe podpisane dokumenty).

2. Konfiguracja uwierzytelniania

Łącznik RSign® używa niestandardowego schematu uwierzytelniania, który wymaga pomyślnego wywołania Get AuthToken akcji przed wykonaniem jakiejkolwiek innej akcji.

Akcja uwierzytelniania (Get AuthToken)

Ta akcja wymaga następujących poświadczeń, które muszą zostać uzyskane z platformy RSign®:

Nazwa parametru Typ Opis Widoczność
ReferenceKey ciąg Klucz odwołania skojarzony z kontem RPost®. Ważne
EmailId ciąg Adres e-mail konta RSign®. Ważne
Password hasło Hasło do konta RSign®. Ważne

Korzystanie z elementu AuthToken

Akcja Get AuthToken zwraca element AuthToken w treści odpowiedzi. Ten token należy następnie przekazać w kolejnych wywołaniach interfejsu API do wszystkich innych obsługiwanych akcji.

Uwaga: Obiekt AuthToken ma czas wygaśnięcia (AuthTokenExpires) i powinien być zarządzany w ramach przepływu lub logiki aplikacji, aby upewnić się, że nowy token jest używany po wygaśnięciu istniejącego tokenu.

3. Wymagania wstępne

Aby pomyślnie użyć tego łącznika niestandardowego RSign®, użytkownicy muszą spełnić następujące wymagania:

  • Prawidłowa licencja RSign®: Użytkownicy muszą mieć aktywną i prawidłową licencję użytkownika RSign®.
  • Dostęp do interfejsu API: Konto RSign® skojarzone z podanymi poświadczeniami musi mieć włączoną i płatną funkcję dostępu do interfejsu API. Ta funkcja jest wymagana do wygenerowania ReferenceKey i pomyślnego użycia łącznika RSign®.

Jeśli obecnie nie spełniasz tych wymagań lub nie masz pewności co do bieżącej konfiguracji konta RSign®, skontaktuj się z przedstawicielem RPost®.

4. Ważne uwagi dotyczące integracji

Użycie szablonu i reguły

  • Kod szablonu/kod reguły: Obie Send Envelope akcje wymagają TemplateCode (lub kodu reguły), który identyfikuje wstępnie skonfigurowany dokument i pola podpisywania w podpisie RSign®.
  • Mapowanie ról: Podczas wysyłania koperty należy wypełnić tablicę TemplateRoleRecipientMapping . Element RoleID dla każdego adresata należy pobrać najpierw przy użyciu Retrieve Template Information akcji . Gwarantuje to, że adresaci są poprawnie mapowane na pola podpisu zdefiniowane w szablonie.

Obsługa dokumentów

  • Wyślij kopertę przy użyciu reguły: Ta akcja wymaga przekazania zawartości dokumentu jako ciągu zakodowanego w formacie Base64 (DocumentBase64Data).
  • Pobierz dokumenty koperty: Dokumenty są zwracane w treści odpowiedzi jako ciągi Base64 (ByteArray). Aby zapisać plik, przepływ zużywania musi dekodować ten ciąg.

Obsługa błędów

Wszystkie akcje zwracają informacje o stanie w treści odpowiedzi, w tym:

  • StatusCode (liczba całkowita)
  • StatusMessage (ciąg)
  • Message (ciąg)

Użytkownicy powinni zaimplementować sprawdzanie błędów na StatusCode podstawie elementu , aby zapewnić pomyślne wykonanie operacji.

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Pobieranie dokumentów koperty

Pobiera część dokumentów koperty na podstawie jego kodu koperty. Spowoduje to pobranie oryginalnych dokumentów i/lub końcowych podpisanych dokumentów w zależności od stanu koperty.
Pobieranie informacji o szablonie

Pobiera informacje o szablonie lub regule na podstawie jego kodu. Wśród zwróconych informacji jest nazwa szablonu, dokumenty i role zdefiniowane.
Pobieranie stanu koperty

Pobiera stan koperty na podstawie jego kodu koperty. Możesz wybrać szczegółowy lub podsumowany raport.
Uzyskiwanie tokenu AuthToken

Zwraca token AuthToken do użycia we wszystkich innych obsługiwanych akcjach RSign.
Wysyłanie koperty przy użyciu reguły

Wysyła żądanie eSign do wybranych adresatów przy użyciu wskazanej reguły znaku RSign.
Wysyłanie koperty przy użyciu szablonu

Wysyła żądanie eSign do wybranych adresatów przy użyciu wskazanego szablonu RSign.

Pobieranie dokumentów koperty

ID operacji:
DownloadEnvelopeDocuments

Pobiera część dokumentów koperty na podstawie jego kodu koperty. Spowoduje to pobranie oryginalnych dokumentów i/lub końcowych podpisanych dokumentów w zależności od stanu koperty.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod koperty
 EnvelopeCode True string

Kod koperty do pobrania.
Token uwierzytelniania
 AuthToken True string

AuthToken pobrany z akcji "Pobierz AuthToken".

Zwraca

Nazwa Ścieżka Typ Opis
Stan
 Status boolean

Flaga powodzenia stanu.
Kod stanu
 StatusCode integer

Kod stanu odpowiedzi.
Message
 Message string

Opis stanu odpowiedzi.
Komunikat o stanie
 StatusMessage string

Komunikat o stanie odpowiedzi.
Kod koperty
 Data.EnvelopeCode string

Kod koperty przekazany jako parametr.
Lista dokumentów
 Data.DocumentList array of object

Lista dokumentów.
Typ dokumentu
 Data.DocumentList.DocumentType string

Typ załącznika.
Nazwa pliku
 Data.DocumentList.FileName string

Nazwa pliku.
Opis
 Data.DocumentList.Description string

Opis dokumentu.
Tablica bajtów
 Data.DocumentList.ByteArray string

Plik w formacie Base64.
Informacje dodatkowe
 Data.DocumentList.AdditionalInfo string

Dodatkowe informacje.
Opis załącznika
 Data.DocumentList.AttachmentDescription string

Informacyjny opis zawartości pliku.
Przeczytaj mnie
 Data.ReadMe string

Plik tekstowy w formacie Base64, który wskazuje nazwę podpisanego dokumentu i oryginalny plik.
Połączony plik zip
 Data.CombinedZip string

Plik zip zawierający wszystkie dokumenty koperty.
Łączna liczba
 TotalCount integer

Łączna liczba.
Czy istnieją przekazywanie załączników
 IsAttachmentUploadsExist string

Czy przekazywanie załączników istnieje.

Pobieranie informacji o szablonie

ID operacji:
GetTemplateInfo

Pobiera informacje o szablonie lub regule na podstawie jego kodu. Wśród zwróconych informacji jest nazwa szablonu, dokumenty i role zdefiniowane.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kod szablonu
 TemplateCode True string

Kod szablonu do pobrania.
Token uwierzytelniania
 AuthToken True string

AuthToken pobrany z akcji "Pobierz AuthToken".

Zwraca

Nazwa Ścieżka Typ Opis
Kod stanu
 StatusCode integer

Kod stanu odpowiedzi.
Komunikat o stanie
 StatusMessage string

Komunikat o stanie odpowiedzi.
Message
 Message string

Opis stanu odpowiedzi.
Identyfikator szablonu
 TemplateId string

Identyfikator szablonu.
Identyfikator szablonu
 TemplateBasicInfo.TemplateId string

Identyfikator szablonu.
Kod szablonu
 TemplateBasicInfo.TemplateCode integer

Kod szablonu do użycia w innych akcjach.
Adres e-mail użytkownika
 TemplateBasicInfo.UserEmail string

Adres e-mail właściciela użytkownika szablonu.
Nazwa szablonu
 TemplateBasicInfo.TemplateName string

Nazwa szablonu.
Opis szablonu
 TemplateBasicInfo.TemplateDescription string

Opis szablonu.
Jest statyczny
 TemplateBasicInfo.IsStatic string

Wskazuje, czy szablon można modyfikować, czy nie.
Data wygaśnięcia
 TemplateBasicInfo.ExpiryDate string

Data wygaśnięcia szablonu.
Data utworzenia
 TemplateBasicInfo.CreatedDate string

Data utworzenia szablonu.
Data ostatniej modyfikacji
 TemplateBasicInfo.LastModifiedDate string

Data, w której szablon został zmodyfikowany po raz ostatni.
Temat
 TemplateBasicInfo.Subject string

Temat szablonu wiadomości e-mail.
Body
 TemplateBasicInfo.Body string

Treść szablonu wiadomości e-mail. Kodowanie HTML.
Nazwa typu
 TemplateBasicInfo.TypeName string

Typ szablonu (możliwe wartości: Szablon, Reguła).
Lista dokumentów
 TemplateBasicInfo.DocumentList array of object

Lista dokumentów.
Identyfikator dokumentu
 TemplateBasicInfo.DocumentList.DocumentId string

Identyfikator części dokumentu szablonu.
Nazwa dokumentu
 TemplateBasicInfo.DocumentList.DocumentName string

Nazwa części dokumentu szablonu.
Zamówienie
 TemplateBasicInfo.DocumentList.Order integer

Kolejność części dokumentu szablonu na liście dokumentów.
Szczegóły zawartości dokumentu
 TemplateBasicInfo.DocumentList.documentContentDetails array of object

Szczegóły zawartości dokumentu.
Identyfikator kontrolny
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlID string

Wewnętrzny identyfikator kontrolki używanej w dokumencie.
Nazwa kontrolki
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlName string

Nazwa kontrolki używanej w dokumencie.
Kontrolowanie identyfikatora HTML
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID string

Identyfikator HTML kontrolki używanej w dokumencie.
Nazwa grupy
 TemplateBasicInfo.DocumentList.documentContentDetails.GroupName string

Nazwa grupy zawierającej kontrolkę.
Etykieta
 TemplateBasicInfo.DocumentList.documentContentDetails.Label string

Nazwa kontrolki, która ma być wyświetlana w dokumencie.
Brak strony
 TemplateBasicInfo.DocumentList.documentContentDetails.PageNo integer

Strona w dokumencie, w którym znajduje się kontrolka.
Required
 TemplateBasicInfo.DocumentList.documentContentDetails.Required boolean

Czy kontrolka jest wymagana, czy nie.
Wartość kontrolki
 TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue string

Wstępnie wypełniona wartość kontrolki.
Identyfikator roli
 TemplateBasicInfo.DocumentList.documentContentDetails.RoleId string

Identyfikator roli, która musi wypełnić kontrolkę.
Nazwa roli
 TemplateBasicInfo.DocumentList.documentContentDetails.RoleName string

Nazwa roli, która musi wypełnić kontrolkę.
Wybieranie opcji kontrolki
 TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions array of string

Wybierz pozycję Opcje kontrolki.
Lista ról szablonu
 TemplateBasicInfo.TemplateRoleList array of object

Lista adresatów.
Identyfikator roli
 TemplateBasicInfo.TemplateRoleList.RoleID string

Identyfikator części roli tego szablonu.
Nazwa roli
 TemplateBasicInfo.TemplateRoleList.RoleName string

Nazwa części roli tego szablonu.
Zamówienie
 TemplateBasicInfo.TemplateRoleList.Order integer

Kolejność, w której rola (odbiorca) musi ukończyć szablon.
Adres e-mail adresata
 TemplateBasicInfo.TemplateRoleList.RecipientEmail string

Wstępnie wypełniona wiadomość e-mail adresata części tego szablonu.
Nazwa adresata
 TemplateBasicInfo.TemplateRoleList.RecipientName string

Wstępnie wypełniona nazwa części adresata tego szablonu.
Identyfikator typu adresata
 TemplateBasicInfo.TemplateRoleList.RecipientTypeID string

Wewnętrzny identyfikator typu adresata.
Identyfikator adresata
 TemplateBasicInfo.TemplateRoleList.RecipientID string

Identyfikator części adresata tego szablonu.
Typ adresata
 TemplateBasicInfo.TemplateRoleList.RecipientType string

Typ adresata.
Typ znakatora DW
 TemplateBasicInfo.TemplateRoleList.CcSignerType string

Typ adresata CC.
Informacje o kulturze
 TemplateBasicInfo.TemplateRoleList.CultureInfo string

Jest to język usługi użytkownika w momencie tworzenia szablonu/reguły.
Tryb dostarczania
 TemplateBasicInfo.TemplateRoleList.DeliveryMode integer

Wskazuje kanał, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Numer kierunkowy
 TemplateBasicInfo.TemplateRoleList.DialCode string

Numer kierunkowy kraju, w którym wysłano żądanie podpisu i kod dostępu.
Kod kraju
 TemplateBasicInfo.TemplateRoleList.CountryCode string

Kod kraju, w którym wysłano żądanie podpisu i kod dostępu.
Numer telefonu komórkowego
 TemplateBasicInfo.TemplateRoleList.Mobile string

Numer telefonu komórkowego odbiorcy.
Tryb mobilny
 TemplateBasicInfo.TemplateRoleList.MobileMode integer

Wskazuje kanał mobilny, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Adres e-mail
 TemplateBasicInfo.TemplateRoleList.EmailAddress string

Adres e-mail odbiorcy.
Włączanie komunikatu na urządzeniu przenośnym
 TemplateBasicInfo.EnableMessageToMobile boolean

Włącz funkcję Message to Mobile.
Data wygaśnięcia łącza statycznego
 TemplateBasicInfo.StaticLinkExpiryDate string

Data wygaśnięcia łącza statycznego.
Lista szablonów
 TemplateList string

Lista szablonów.

Pobieranie stanu koperty

ID operacji:
GetEnvelopeStatusInfo

Pobiera stan koperty na podstawie jego kodu koperty. Możesz wybrać szczegółowy lub podsumowany raport.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token uwierzytelniania
 AuthToken True string

AuthToken pobrany z akcji "Pobierz AuthToken".
Kod koperty
 EnvelopeCode True string

Kod koperty.
DetailOrSummary
 DetailOrSummary True string

Wybierz odpowiedni typ raportu.

Zwraca

Nazwa Ścieżka Typ Opis
Stan
 Status boolean

Stan żądania.
Kod stanu
 StatusCode integer

Kod stanu odpowiedzi.
Message
 Message string

Opis stanu odpowiedzi.
Komunikat o stanie
 StatusMessage string

Komunikat o stanie odpowiedzi.
Lista danych koperty
 Data array of object
Kod koperty
 Data.EnvelopeCode string

Identyfikator koperty.
Identyfikator koperty
 Data.EnvelopeID string

Wewnętrzny identyfikator koperty.
Temat
 Data.Subject string

Temat wiadomości e-mail z kopertą.
Stan koperty
 Data.Status string

Stan żądanej koperty.
IsEnvelopeComplete
 Data.IsEnvelopeComplete boolean

Wskazuje, czy koperta została ukończona.
Data wysłania
 Data.SentDate string

Data wysłania koperty.
Data ostatniej modyfikacji
 Data.LastModifiedDate string

Data ostatniej modyfikacji.
SenderName
 Data.SenderName string

Nazwa nadawcy.
SenderEmail
 Data.SenderEmail string

Adres e-mail nadawcy.
Szczegóły adresata
 Data.RecipientDetails array of object
Identyfikator adresata
 Data.RecipientDetails.RecipientID string

Identyfikator części adresata obecnej koperty.
Identyfikator typu adresata
 Data.RecipientDetails.RecipientTypeID string

Wpisz identyfikator części adresata obecnej koperty.
Typ adresata
 Data.RecipientDetails.RecipientType string

Typ adresata części obecnej koperty. Możliwe wartości to: Signer i Prefill.
Nazwa adresata
 Data.RecipientDetails.RecipientName string

Nazwa adresata.
Email
 Data.RecipientDetails.Email string

Adres e-mail odbiorcy.
Zamówienie
 Data.RecipientDetails.Order integer

Kolejność, w której odbiorca musi uzyskać dostęp do ukończenia koperty.
Identyfikator stanu
 Data.RecipientDetails.StatusId string

Identyfikator stanu.
Stan podpisywania
 Data.RecipientDetails.SigningStatus string

Stan podpisu odbiorcy koperty.
Data ostatniej modyfikacji
 Data.RecipientDetails.LastModifiedDate string

Data ostatniej modyfikacji.
Kod referencyjny
 Data.ReferenceCode string

Część kodu referencyjnego obecnej koperty.
Adres e-mail referencyjny
 Data.ReferenceEmail string

Odwołanie do części wiadomości e-mail obecnej koperty.
TotalCount
 TotalCount integer

Łączna ilość kopert spełniających żądane kryteria.
IsAttachmentUploadsExist
 IsAttachmentUploadsExist string

Czy przekazywanie załączników istnieje.

Uzyskiwanie tokenu AuthToken

ID operacji:
GetAuthToken

Zwraca token AuthToken do użycia we wszystkich innych obsługiwanych akcjach RSign.

Parametry

Nazwa Klucz Wymagane Typ Opis
ReferenceKey
 ReferenceKey True string

Unikatowy identyfikator konta firmy.
Identyfikator e-mail
 EmailId True string

Adres e-mail konta RSign.
Hasło
 Password True password

Hasło konta RSign.

Zwraca

Nazwa Ścieżka Typ Opis
Komunikat uwierzytelniania
 AuthMessage string

Komunikat o stanie odpowiedzi.
Token uwierzytelniania
 AuthToken string

Token uwierzytelniania do użycia w innych akcjach RSign.
Odśwież token
 RefreshToken string

Odśwież token.
Odświeżanie tokenu wygasa
 RefreshTokenExpires string

Data wygaśnięcia bieżącego tokenu odświeżania.
Token uwierzytelniania wygasa
 AuthTokenExpires string

Data wygaśnięcia bieżącego tokenu uwierzytelniania.
Identyfikator wiadomości e-mail
 EmailId string

Adres e-mail uwierzytelnionego użytkownika.
Identyfikator interfejsu API
 ApiId string

Identyfikator interfejsu API.

Wysyłanie koperty przy użyciu reguły

ID operacji:
SendEnvelopeFromRule

Wysyła żądanie eSign do wybranych adresatów przy użyciu wskazanej reguły znaku RSign.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token uwierzytelniania
 AuthToken True string

AuthToken pobrany z akcji "Pobierz AuthToken".
TemplateCode
 TemplateCode True string

Identyfikator reguły do użycia.
Name
 Name True string

Nazwa dokumentu. Dołącz rozszerzenie (na przykład: Agreement.docx).
DocumentBase64Data
 DocumentBase64Data True string

Dokument do wysłania w formacie Base64.
Klucz aplikacji
 AppKey string

Unikatowy identyfikator systemu przy użyciu łącznika. Poproś go o pomoc techniczną RPost®.
Identyfikator roli
 RoleID True string

Identyfikator roli odbiorcy. Pobrano z akcji "Pobierz informacje o szablonie".
Adresaci
 RecipientEmail True string

Adres e-mail odbiorcy.
Nazwa odbiorcy
 RecipientName True string

Nazwa adresata.
Mobile
 Mobile string

Numer telefonu komórkowego odbiorcy. Jeśli reguła nie wymaga tej reguły, pozostaw ją pustą.

Zwraca

Nazwa Ścieżka Typ Opis
Kod koperty
 EnvelopeCode string

Identyfikator koperty.
Przezroczystość zmienionego komunikatu
 TransparencyChangedMessage string

Przezroczystość zmieniona wiadomość.
Komunikat interfejsu API oparty na języku
 LanguageBasedApiMessge string

Komunikat interfejsu API oparty na języku.
Identyfikator odbiorcy wstępnego wypełniania
 PrefillRecipientId string

Wstępnie wypełnij identyfikator adresata.
Publikowanie strony nawigacji
 PostSendingNavigationPage string

Witryna internetowa, do której odbiorca zostanie przekierowany po zakończeniu podpisywania koperty.
Czy nowy interfejs użytkownika logowania jest włączony
 IsNewSignerUIEnabled boolean

Czy jest włączony nowy interfejs użytkownika logowania.
Kod stanu
 StatusCode integer

Kod stanu odpowiedzi.
Komunikat o stanie
 StatusMessage string

Komunikat o stanie odpowiedzi.
Message
 Message string

Opis stanu odpowiedzi.
Identyfikator koperty
 EnvelopeId string

Wewnętrzny identyfikator wygenerowanej koperty.
Adres URL dokumentu podpisywania
 SignDoumentUrl string

Globalny adres URL podpisu koperty.
Lista adresatów
 RecipientList array of object

Szczegóły adresatów
Nazwa adresata
 RecipientList.RecipientName string

Nazwa adresata.
Adres e-mail adresata
 RecipientList.RecipientEmail string

Adres e-mail odbiorcy.
Zamówienie
 RecipientList.Order integer

Kolejność, w której odbiorca musi uzyskać dostęp do ukończenia koperty.
Typ
 RecipientList.Type string

Typ adresata części obecnej koperty. Możliwe wartości to: Signer i Prefill.
Tryb dostarczania
 RecipientList.DeliveryMode integer

Wskazuje kanał, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Numer kierunkowy
 RecipientList.DialCode string

Numer kierunkowy kraju, w którym wysłano żądanie podpisu i kod dostępu.
Kod kraju
 RecipientList.CountryCode string

Kod kraju, w którym wysłano żądanie podpisu i kod dostępu.
Numer telefonu komórkowego
 RecipientList.Mobile string

Numer telefonu komórkowego odbiorcy.
Tryb mobilny
 RecipientList.MobileMode integer

Wskazuje kanał mobilny, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Adres URL podpisywania
 RecipientList.SigningUrl string

Adres URL używany przez adresata do uzyskiwania dostępu do koperty i podpisywania jej.
Lista rozwijana kodu wybierania numerów
 DialCodeDropdownList string

Lista rozwijana kodu wybierania numerów.
Włączanie komunikatu na urządzeniu przenośnym
 EnableMessageToMobile string

Włącz funkcję Message to Mobile.

Wysyłanie koperty przy użyciu szablonu

ID operacji:
SendEnvelopeFromTemplate

Wysyła żądanie eSign do wybranych adresatów przy użyciu wskazanego szablonu RSign.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token uwierzytelniania
 AuthToken True string

AuthToken pobrany z akcji "Pobierz AuthToken".
TemplateCode
 TemplateCode True string

Identyfikator szablonu do użycia.
Klucz aplikacji
 AppKey string

Unikatowy identyfikator systemu przy użyciu łącznika. Poproś go o pomoc techniczną RPost®.
Identyfikator roli
 RoleID True string

Identyfikator roli odbiorcy. Pobrano z akcji "Pobierz informacje o szablonie".
Adresaci
 RecipientEmail True string

Adres e-mail odbiorcy.
Nazwa odbiorcy
 RecipientName True string

Nazwa adresata.
Mobile
 Mobile string

Numer telefonu komórkowego odbiorcy. Jeśli szablon nie wymaga go, pozostaw to pole puste.

Zwraca

Nazwa Ścieżka Typ Opis
Kod koperty
 EnvelopeCode string

Identyfikator koperty.
Przezroczystość zmienionego komunikatu
 TransparencyChangedMessage string

Przezroczystość zmieniona wiadomość.
Komunikat interfejsu API oparty na języku
 LanguageBasedApiMessge string

Komunikat interfejsu API oparty na języku.
Identyfikator odbiorcy wstępnego wypełniania
 PrefillRecipientId string

Wstępnie wypełnij identyfikator adresata.
Publikowanie strony nawigacji
 PostSendingNavigationPage string

Witryna internetowa, do której odbiorca zostanie przekierowany po zakończeniu podpisywania koperty.
Czy nowy interfejs użytkownika logowania jest włączony
 IsNewSignerUIEnabled boolean

Czy jest włączony nowy interfejs użytkownika logowania.
Kod stanu
 StatusCode integer

Kod stanu odpowiedzi.
Komunikat o stanie
 StatusMessage string

Komunikat o stanie odpowiedzi.
Message
 Message string

Opis stanu odpowiedzi.
Identyfikator koperty
 EnvelopeId string

Wewnętrzny identyfikator wygenerowanej koperty.
Adres URL dokumentu podpisywania
 SignDoumentUrl string

Globalny adres URL podpisu koperty.
Lista adresatów
 RecipientList array of object

Szczegóły adresatów
Nazwa adresata
 RecipientList.RecipientName string

Nazwa części adresata obecnej koperty.
Adres e-mail adresata
 RecipientList.RecipientEmail string

Adres e-mail odbiorcy części obecnej koperty.
Zamówienie
 RecipientList.Order integer

Kolejność, w której odbiorca musi uzyskać dostęp do ukończenia koperty.
Typ
 RecipientList.Type string

Typ adresata części obecnej koperty. Możliwe wartości to: Signer i Prefill.
Tryb dostarczania
 RecipientList.DeliveryMode integer

Wskazuje kanał, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Numer kierunkowy
 RecipientList.DialCode string

Numer kierunkowy kraju, w którym wysłano żądanie podpisu i kod dostępu.
Kod kraju
 RecipientList.CountryCode string

Kod kraju, w którym wysłano żądanie podpisu i kod dostępu.
Numer telefonu komórkowego
 RecipientList.Mobile string

Numer telefonu komórkowego odbiorcy.
Tryb mobilny
 RecipientList.MobileMode integer

Wskazuje kanał mobilny, za pośrednictwem którego wysłano żądanie podpisu i kod dostępu do adresata.
Adres URL podpisywania
 RecipientList.SigningUrl string

Adres URL używany przez adresata do uzyskiwania dostępu do koperty i podpisywania jej.
Lista rozwijana kodu wybierania numerów
 DialCodeDropdownList string

Lista rozwijana kodu wybierania numerów.
Włączanie komunikatu na urządzeniu przenośnym
 EnableMessageToMobile string

Włącz funkcję Message to Mobile.