BoldSign (wersja zapoznawcza)
BoldSign to bezpieczne, łatwe w użyciu rozwiązanie do podpisu elektronicznego, które zapewnia prawnie wiążące sposoby wysyłania dokumentów, podpisywania i zarządzania nimi.
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 | 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 funkcji BoldSign |
| adres URL | https://support.boldsign.com |
| support@boldsign.com |
| Metadane łącznika | |
|---|---|
| Publisher | Syncfusion-Inc |
| Witryna internetowa | https://boldsign.com/ |
| Kategorie | Zawartość i pliki; Produktywność |
| Zasady ochrony prywatności | https://boldsign.com/privacy-policy/ |
BoldSign to aplikacja podpisów elektronicznych online, a łącznik BoldSign obejmuje następujące scenariusze
- Użytkownik może nasłuchiwać wyzwalacza i wysyłać dokument do podpisywania na podstawie informacji z wyzwalacza.
- Użytkownik może nasłuchiwać zdarzenia zakończonego dokumentu i pobrać podpisany dokument PDF, aby zapisać go w preferowanym magazynie w chmurze lub dowolną preferowaną akcję.
- Użytkownik może monitorować stan lub pobierać stan dokumentu i wykonywać na jego podstawie akcje, takie jak wysyłanie przypomnienia za pośrednictwem poczty e-mail lub wiadomości SMS za pośrednictwem innej usługi lub łącznika.
- Użytkownik może nasłuchiwać wielu zdarzeń, takich jak wysłane, uwierzytelnianie nie powiodło się, odrzucone, wygasło itp., aby wykonywać akcje na podstawie informacji dostarczonych za pośrednictwem wyzwalacza zdarzenia.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Wybierz region | ciąg | Wybierz regionalne centrum danych BoldSign, w którym znajduje się konto |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobierz dokument |
Pobiera plik PDF danego identyfikatora dokumentu. |
|
Pobierz plik Audit |
Pobierz dziennik inspekcji ukończonego dokumentu. |
| Uzyskiwanie stanu dokumentu |
Pobiera stan dokumentu i jego informacje o dokumencie. |
| Wysyłanie dokumentu przy użyciu szablonu z adresatem |
Wyślij dokument do podpisu przy użyciu określonego szablonu do adresata. |
Pobierz dokument
Pobiera plik PDF danego identyfikatora dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Podaj identyfikator dokumentu |
|
W imieniu
|
onBehalfOf | string |
Wybierz adres e-mail, aby wykonać akcję w imieniu innej osoby |
Pobierz plik AuditTrail
Pobierz dziennik inspekcji ukończonego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Podaj identyfikator dokumentu |
|
W imieniu
|
onBehalfOf | string |
Wybierz adres e-mail, aby wykonać akcję w imieniu innej osoby |
Uzyskiwanie stanu dokumentu
Pobiera stan dokumentu i jego informacje o dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Podaj identyfikator dokumentu |
Zwraca
Obiekt odpowiedzi żądania właściwości dokumentu.
Wysyłanie dokumentu przy użyciu szablonu z adresatem
Wyślij dokument do podpisu przy użyciu określonego szablonu do adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
templateId | True | string |
Wybieranie szablonu |
|
Tryb piaskownicy
|
isSandbox | True | boolean |
Po włączeniu funkcji BoldSign wyśle żądania podpisu w trybie piaskownicy, co umożliwi przetestowanie integracji |
|
Tytuł dokumentu
|
title | True | string |
Wprowadź tytuł dokumentu |
|
Opis dokumentu
|
message | string |
Wprowadź opis dokumentu |
|
|
napis
|
cc | string |
Wprowadź co najmniej jeden adres e-mail rozdzielony przecinkami |
|
|
Marka
|
brandId | string |
Wybieranie marki |
|
|
W imieniu
|
onBehalfOf | string |
Wybierz adres e-mail do wysłania w imieniu innej osoby |
|
|
Dni wygaśnięcia
|
expiryDays | integer |
Podaj liczbę dni, po których dokument wygaśnie |
|
|
Etykiety dokumentów
|
labels | string |
Podaj co najmniej jedną etykietę dokumentu oddzieloną przecinkami |
|
|
Ukryj identyfikator dokumentu
|
hideDocumentId | boolean |
Po włączeniu odcisku identyfikatora będzie ukryty w górnej części dokumentu |
|
|
Zezwalaj na drukowanie i podpisywanie
|
enablePrintAndSign | boolean |
Gdy jest to dozwolone, sygnatariusz będzie mógł wydrukować i podpisać dokument |
|
|
Zezwalaj na ponowne przypisywanie
|
enableReassign | boolean |
Gdy jest to dozwolone, osoba podpisowa będzie mogła ponownie przypisać dokument innym osobom |
|
|
Włącz automatyczne przypomnienie
|
enableAutoReminder | boolean |
Po włączeniu funkcji BoldSign będzie wysyłać automatyczne wiadomości e-mail z przypomnieniami o określonej częstotliwości |
|
|
Sygnatariuszy
|
signers | True | dynamic |
Osoby podpisające dokument. |
Zwraca
Obiekt odpowiedzi szablonu wysyła żądanie dokumentu.
Wyzwalacze
| Zdarzenia elementu webhook |
Spowoduje to wyzwolenie zdarzenia elementu webhook dokumentów. |
Zdarzenia elementu webhook
Spowoduje to wyzwolenie zdarzenia elementu webhook dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wybieranie zdarzeń elementu webhook
|
events | True | string |
Wybierz zdarzenie elementu webhook, do którego powinien zostać wyzwolony przepływ. |
|
Zdarzenia użytkownika zespołu
|
adminMode | True | boolean |
Włącz tę opcję, aby otrzymywać powiadomienia o zdarzeniach wyzwalanych przez członków zespołu. Administratorzy kont będą również otrzymywać powiadomienia o zdarzeniach w całej organizacji. Jeśli to ustawienie jest wyłączone, otrzymasz tylko powiadomienia dotyczące własnych zdarzeń. |
Zwraca
Dane zdarzeń elementów webhook.
- Body
- WebHookEventOject
Definicje
SendDocumentFromTemplateResponse
Obiekt odpowiedzi szablonu wysyła żądanie dokumentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | string |
Identyfikator utworzonego dokumentu. |
DocumentPropertiesResponse
Obiekt odpowiedzi żądania właściwości dokumentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Stan dokumentu
|
status | string |
Stan i inne informacje o dokumencie |
Element WebHookEventOject
Dane zdarzeń elementów webhook.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zdarzenia
|
event.id | string |
Identyfikator zdarzenia |
|
Created
|
event.created | integer |
Zdarzenie utworzyło datę i godzinę |
|
Typ zdarzenia
|
event.eventType | string |
Typ zdarzenia |
|
Identyfikator klienta
|
event.clientId | string |
Identyfikator klienta |
|
Środowisko
|
event.environment | string |
Typ środowiska |
|
Object
|
data.object | string |
Typ obiektu |
|
Identyfikator dokumentu
|
data.documentId | string |
Identyfikator dokumentu |
|
Tytuł dokumentu
|
data.messageTitle | string |
Tytuł dokumentu |
|
Opis dokumentu
|
data.documentDescription | string |
Opis dokumentu |
|
Stan dokumentu
|
data.status | string |
Stan dokumentu |
|
Nazwa nadawcy
|
data.senderDetail.name | string |
Nazwa nadawcy |
|
Adres e-mail nadawcy
|
data.senderDetail.emailAddress | string |
Adres e-mail nadawcy |
|
signerDetails
|
data.signerDetails | array of object |
Szczegóły logowania |
|
Nazwa osoby podpisającego
|
data.signerDetails.signerName | string |
Nazwa osoby podpisającego |
|
Rola sygnatariusza
|
data.signerDetails.signerRole | string |
Rola sygnatariusza |
|
Adres e-mail sygnatariusza
|
data.signerDetails.signerEmail | string |
Adres e-mail sygnatariusza |
|
Kod kraju
|
data.signerDetails.phoneNumber.countryCode | string |
Kod kraju |
|
Numer telefonu
|
data.signerDetails.phoneNumber.number | string |
Numer telefonu |
|
Stan sygnatariusza
|
data.signerDetails.status | string |
Stan sygnatariusza |
|
Włączony kod dostępu
|
data.signerDetails.enableAccessCode | boolean |
Wskazuje, czy kod dostępu jest włączony, czy nie |
|
Uwierzytelnianie nie powiodło się
|
data.signerDetails.isAuthenticationFailed | string |
Wskazuje, czy uwierzytelnianie nie powiodło się, czy nie |
|
Włączono protokół OTP poczty e-mail
|
data.signerDetails.enableEmailOTP | boolean |
Wskazuje, czy protokół OTP poczty e-mail jest włączony, czy nie |
|
Dostarczanie nie powiodło się
|
data.signerDetails.isDeliveryFailed | boolean |
Wskazuje, czy dostarczanie dokumentu nie powiodło się, czy nie |
|
Wyświetlono
|
data.signerDetails.isViewed | boolean |
Wskazuje, czy dokument jest wyświetlany, czy nie |
|
Kolejność podpisywania
|
data.signerDetails.order | integer |
Kolejność podpisywania |
|
Typ signer
|
data.signerDetails.signerType | string |
Typ sygnatariusza |
|
Przypisane
|
data.signerDetails.isReassigned | boolean |
Wskazuje, czy użytkownik podpisuje ponownie przypisanie, czy nie |
|
Ponowne przypisywanie wiadomości
|
data.signerDetails.reassignMessage | string |
Komunikat ponownego przypisania |
|
Odrzuć komunikat
|
data.signerDetails.declineMessage | string |
Komunikat o odrzuceniu |
|
Data ostatniego działania
|
data.signerDetails.lastActivityDate | integer |
Data ostatniego działania |
|
Typ uwierzytelniania
|
data.signerDetails.authenticationType | string |
Typ uwierzytelniania |
|
Typ weryfikacji tożsamości
|
data.signerDetails.idVerification.type | string |
Typ weryfikacji tożsamości |
|
Maksymalna liczba ponownych prób
|
data.signerDetails.idVerification.maximumRetryCount | integer |
Maksymalna liczba ponownych prób |
|
Stan weryfikacji tożsamości
|
data.signerDetails.idVerification.status | string |
Stan weryfikacji tożsamości |
|
Dopasowywanie nazw
|
data.signerDetails.idVerification.nameMatcher | string |
Typ dopasowania nazwy |
|
Wymagane przechwytywanie na żywo
|
data.signerDetails.idVerification.requireLiveCapture | boolean |
Wskazuje, czy przechwytywanie na żywo jest wymagane, czy nie |
|
Wymagane pasujące selfie
|
data.signerDetails.idVerification.requireMatchingSelfie | boolean |
Wskazuje, czy pasujące selfie jest wymagane, czy nie |
|
Dozwolona konfiguracja pola
|
data.signerDetails.allowFieldConfiguration | boolean |
Wskazuje, czy konfiguracja pola jest wymagana, czy nie |
|
Wiadomości e-mail CC
|
data.ccDetails | array of |
Dw adresy e-mail |
|
W imieniu
|
data.onBehalfOf | string |
Adres w imieniu poczty e-mail |
|
Data utworzenia
|
data.createdDate | integer |
Data utworzenia dokumentu |
|
Data wygaśnięcia
|
data.expiryDate | integer |
Data wygaśnięcia dokumentu |
|
Włączone zamówienie podpisywania
|
data.enableSigningOrder | boolean |
Wskazuje, czy zamówienie podpisywania jest włączone, czy nie |
|
Wyłączone wiadomości e-mail
|
data.disableEmails | boolean |
Wskazuje, czy wiadomości e-mail są wyłączone, czy nie |
|
Odwoływanie wiadomości
|
data.revokeMessage | string |
Komunikat odwołania |
|
Komunikat o błędzie
|
data.errorMessage | string |
Komunikat o błędzie |
|
Etykiety
|
data.labels | array of |
Etykiety dokumentów |
|
Połączona inspekcja
|
data.isCombinedAudit | boolean |
Wskazuje, czy dziennik inspekcji jest połączony z dokumentem, czy nie |