Signhost (wersja zapoznawcza)
Signhost usługa podpisywania przepływu pracy firmy Entrust to rozwiązanie do podpisywania cyfrowego i identyfikacji, które umożliwia wszystkim typom firm bezproblemowe i bezpieczne transakcje online.
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 | Zespół sukcesu klienta signhost |
| adres URL | https://intercom.help/signhost/en/ |
| support@signhost.com |
| Metadane łącznika | |
|---|---|
| Publisher | Signhost |
| Witryna internetowa | https://www.signhost.com |
| Zasady ochrony prywatności | https://www.evidos.com/privacy |
| Kategorie | Zawartość i pliki; Produktywność |
SignHost
Signhost usługa podpisywania przepływu pracy firmy Entrust to rozwiązanie do podpisywania cyfrowego i identyfikacji, które umożliwia wszystkim typom firm bezproblemowe i bezpieczne transakcje online.
Publisher
Powierz holandii B.V.
Wymagania wstępne
Do korzystania z tego łącznika potrzebna będzie subskrypcja SignHost. Klucz APIKey można wygenerować w portalu Signhost
Obsługiwane operacje
Pobieranie szczegółów transakcji
Zwraca bieżące szczegóły transakcji. Nie używaj tej akcji do aktywnego sondowania.
Usuwanie transakcji
Usuń transakcję według identyfikatora transakcji. Jeśli transakcja nie jest w stanie końcowym (na przykład w pełni podpisana), transakcja zostanie anulowana i oczyszczona. Anulowana transakcja może zostać poinformowana o wysłaniu powiadomienia e-mail do oczekujących osób podpisujących, że transakcja została anulowana. Stan transakcji zostanie ustawiony na anulowane. Gdy transakcja jest w stanie końcowym, transakcja zostanie wyczyszczona. Stan transakcji pozostanie taki sam, ale jak najszybciej wyczyścimy wszystkie przekazane dokumenty i poufne dane.
Pobierz plik PDF
Zwraca (podpisane) dokumenty.
Pobieranie potwierdzenia
Zwraca potwierdzenie po pomyślnym podpisaniu transakcji.
Tworzenie transakcji
Tworzy nową transakcję.
Dodawanie pliku
Dodaj plik do transakcji.
Rozpocznij transakcję
Uruchamia transakcję z tym samym {transactionId}.
Uzyskiwanie poświadczeń
Możesz wygenerować wartość usertoken na stronie ustawień w portalu SignHost. Pamiętaj, aby użyć prefiksu "APIKey" przed twoim tokenem usertoken.
Znane problemy i ograniczenia
Obecnie nie wszystkie funkcje są obsługiwane. Zapraszamy, aby skontaktować się z nami z wszelkimi żądaniami lub zapytaniami.
Instrukcje dotyczące wdrażania
Postępuj zgodnie z instrukcjami w temacie Tworzenie łącznika niestandardowego na podstawie definicji interfejsu OpenAPI.
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 |
|---|---|---|---|
| Authorization | securestring | Podaj klucz APIKey. | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Dodawanie pliku |
Dodaj plik do transakcji lub zastąp istniejący plik tym samym {fileId}. |
| Pobieranie potwierdzenia |
Zwraca potwierdzenie po pomyślnym podpisaniu transakcji (Status=30) |
| Pobieranie szczegółów transakcji |
Zwraca bieżące szczegóły transakcji |
| Pobierz plik PDF |
Zwraca (podpisane) dokumenty. |
| Rozpocznij transakcję |
Rozpoczyna transakcję z tym samym {transactionId} |
| Tworzenie transakcji |
Tworzy nową transakcję |
| Usuwanie transakcji |
Usuwanie transakcji według identyfikatora transakcji |
Dodawanie pliku
Dodaj plik do transakcji lub zastąp istniejący plik tym samym {fileId}.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator istniejącej — jeszcze nie uruchomionej — transakcji |
|
Identyfikator pliku
|
fileId | True | string |
Unikatowy identyfikator dostarczony przez Użytkownika dla pliku. |
|
Plik binarny
|
body | True | binary |
Przekazywanie plików |
Pobieranie potwierdzenia
Zwraca potwierdzenie po pomyślnym podpisaniu transakcji (Status=30)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator opisu |
Zwraca
- Content
- binary
Pobieranie szczegółów transakcji
Zwraca bieżące szczegóły transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator transakcji |
Zwraca
- Body
- Transaction
Pobierz plik PDF
Zwraca (podpisane) dokumenty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator opisu |
|
Name
|
fileId | True | string |
Unikatowy identyfikator dostarczony przez Użytkownika dla pliku. |
Zwraca
- Content
- binary
Rozpocznij transakcję
Rozpoczyna transakcję z tym samym {transactionId}
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator istniejącej — jeszcze nie uruchomionej — transakcji |
Tworzenie transakcji
Tworzy nową transakcję
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Files
|
Files | object |
Mapa plików dołączonych do tej transakcji. |
|
|
Język
|
Language | string |
Język, tylko de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL i nl-NL są dozwolone. |
|
|
Foka
|
Seal | boolean |
Przypieczętuj dokument przed wysłaniem do osób podpisujących. |
|
|
Id
|
Id | string |
Identyfikator sygnatariusza musi być unikatowy w ramach transakcji. |
|
|
Email
|
True | string |
Adres e-mail sygnatariusza |
|
|
IntroText
|
IntroText | string |
Tekst wprowadzający, który ma być wyświetlany użytkownikowi podczas procesu podpisywania. |
|
|
Typ
|
Type | True | string |
Typ obiektu uwierzytelniania. |
|
Number
|
Number | string |
Numer telefonu: to pole jest obowiązkowe po wybraniu metody uwierzytelniania PhoneNumber |
|
|
Bsn
|
Bsn | number |
To pole jest obowiązkowe, gdy wybrano metodę uwierzytelniania BSN |
|
|
Typ
|
Type | True | string |
Typ obiektu weryfikacji. |
|
SendSignRequest
|
SendSignRequest | boolean |
Wyślij zaproszenie do podpisania do swojego adresu e-mail. |
|
|
SignUrl
|
SignUrl | string |
Unikatowy adres URL dla użytkownika podpisującego, który zapewnia przepływ podpisywania dla użytkownika podpisującego. |
|
|
SignRequestSubject
|
SignRequestSubject | string |
Temat wiadomości e-mail z żądaniem podpisania w postaci zwykłego tekstu. |
|
|
SignRequestMessage
|
SignRequestMessage | string |
Komunikat żądania logowania w postaci zwykłego tekstu. |
|
|
SendSignConfirmation
|
SendSignConfirmation | boolean |
Wyślij potwierdzenie podpisania do podpisającego jego adres e-mail. |
|
|
Język
|
Language | string |
Język, tylko de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL i nl-NL są dozwolone. |
|
|
ScribbleName
|
ScribbleName | string |
Nazwa osoby podpisającego zostanie wstępnie wypełniona w formularzu bazgrołów. |
|
|
DaysToRemind
|
DaysToRemind | integer |
Ilość dni przed przypomnieniem sygnatariuszom. -1, aby wyłączyć przypomnienia. |
|
|
Wygasa
|
Expires | date-time |
Po ustawieniu znaku nie można już podpisać transakcji po tej dacie. |
|
|
Reference
|
Reference | string |
Odwołanie do sygnatariusza. |
|
|
RejectReason
|
RejectReason | string |
Przyczyna odrzucenia podana przez sygnatariusza, gdy transakcja została odrzucona. |
|
|
ReturnUrl
|
ReturnUrl | string |
Adres URL umożliwiający przekierowanie użytkownika do adresu po podpisaniu, odrzuceniu lub anulowaniu. |
|
|
Context
|
Context | object |
Dowolny prawidłowy obiekt json, który zostanie zwrócony. |
|
|
Id
|
Id | string | ||
|
Code
|
Code | integer |
Zapoznaj się z dokumentacją interfejsu API |
|
|
Informacje
|
Info | string |
Może zawierać dodatkowe informacje należące do tego działania |
|
|
Data i czas utworzenia
|
CreatedDateTime | date-time | ||
|
Name
|
Name | True | string |
Nazwa odbiorcy. |
|
Email
|
True | string |
Adres e-mail odbiorcy. |
|
|
Język
|
Language | string |
Język, tylko de-DE, en-US, es-ES, fr-FR, it-IT i nl-NL dozwolone. |
|
|
Temat
|
Subject | string |
Temat wiadomości e-mail odbiorcy w postaci zwykłego tekstu. |
|
|
Message
|
Message | True | string |
Wiadomość e-mail w kierunku odbiorcy w postaci zwykłego tekstu. |
|
Reference
|
Reference | string |
Odwołanie do odbiornika. |
|
|
Context
|
Context | object |
Dowolny prawidłowy obiekt json, który zostanie zwrócony. |
|
|
Reference
|
Reference | string |
Odwołanie do transakcji. |
|
|
PostbackUrl
|
PostbackUrl | string |
Bezwzględny adres URL do ogłaszania zwrotnego aktualizacji stanu. |
|
|
SignRequestMode
|
SignRequestMode | integer |
Ustaw wartość 1 dla wysyłania jednocześnie do wartości 2 dla sekwencyjnych. |
|
|
DaysToExpire
|
DaysToExpire | integer |
Ilość dni przed wygaśnięciem. Maksymalnie 90 dni. |
Zwraca
- Body
- Transaction
Usuwanie transakcji
Usuwanie transakcji według identyfikatora transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Identyfikator transakcji |
|
SendNotifications
|
SendNotifications | boolean |
Wysyłanie powiadomień e-mail do oczekujących osób podpisujących. |
|
|
Przyczyna
|
Reason | string |
Przyczyna anulowania. |
Definicje
Transakcja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
Id | string |
Identyfikator transakcji. |
|
Files
|
Files | array of object | |
|
Links
|
Files.Links | array of object | |
|
Rel
|
Files.Links.Rel | string | |
|
Typ
|
Files.Links.Type | string | |
|
Link
|
Files.Links.Link | string | |
|
Nazwa wyświetlana
|
Files.DisplayName | string | |
|
Język
|
Language | string |
Język, tylko de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL i nl-NL dozwolone. |
|
Foka
|
Seal | boolean |
Przypieczętuj dokument przed wysłaniem do osób podpisujących. |
|
Sygnatariuszy
|
Signers | array of object |
Informacje o podpisie. |
|
Id
|
Signers.Id | string |
Identyfikator sygnatariusza musi być unikatowy w ramach transakcji. |
|
Email
|
Signers.Email | string |
Adres e-mail sygnatariusza |
|
IntroText
|
Signers.IntroText | string |
Tekst wprowadzający, który ma być wyświetlany użytkownikowi podczas procesu podpisywania. |
|
uwierzytelnienia
|
Signers.Authentications | array of Authentication |
Lista uwierzytelnień, za pomocą których użytkownik podpisujący musi się uwierzytelnić. |
|
Weryfikacje
|
Signers.Verifications | array of Verification |
Lista weryfikacji, z którymi musi się sprawdzić użytkownik podpisujący. |
|
SendSignRequest
|
Signers.SendSignRequest | boolean |
Wyślij zaproszenie do podpisania do swojego adresu e-mail. |
|
SignUrl
|
Signers.SignUrl | string |
Unikatowy adres URL dla użytkownika podpisującego, który zapewnia przepływ podpisywania dla użytkownika podpisującego. |
|
SignRequestSubject
|
Signers.SignRequestSubject | string |
Temat wiadomości e-mail z żądaniem podpisania w postaci zwykłego tekstu. |
|
SignRequestMessage
|
Signers.SignRequestMessage | string |
Komunikat żądania logowania w postaci zwykłego tekstu. |
|
SendSignConfirmation
|
Signers.SendSignConfirmation | boolean |
Wyślij potwierdzenie podpisania do podpisającego jego adres e-mail. |
|
Język
|
Signers.Language | string |
Dozwolone są tylko de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL i nl-NL. |
|
ScribbleName
|
Signers.ScribbleName | string |
Nazwa osoby podpisającego zostanie wstępnie wypełniona w formularzu bazgrołów. |
|
DaysToRemind
|
Signers.DaysToRemind | integer |
Ilość dni przed przypomnieniem sygnatariuszom. |
|
Wygasa
|
Signers.Expires | date-time |
Po ustawieniu znaku nie można już podpisać transakcji po tej dacie. |
|
Reference
|
Signers.Reference | string |
Odwołanie do sygnatariusza. |
|
RejectReason
|
Signers.RejectReason | string |
Przyczyna odrzucenia podana przez sygnatariusza, gdy transakcja została odrzucona. |
|
ReturnUrl
|
Signers.ReturnUrl | string |
Adres URL umożliwiający przekierowanie użytkownika do adresu po podpisaniu, odrzuceniu lub anulowaniu. |
|
Context
|
Signers.Context | object |
Dowolny prawidłowy obiekt json, który zostanie zwrócony. |
|
Activities
|
Signers.Activities | array of object |
Lista działań dołączonych do tego sygnatariusza. |
|
Id
|
Signers.Activities.Id | string | |
|
Code
|
Signers.Activities.Code | integer |
|
|
Informacje
|
Signers.Activities.Info | string |
Może zawierać dodatkowe informacje należące do tego działania |
|
Data i czas utworzenia
|
Signers.Activities.CreatedDateTime | date-time | |
|
Odbiorniki
|
Receivers | array of object | |
|
Name
|
Receivers.Name | string |
Nazwa odbiorcy. |
|
Email
|
Receivers.Email | string |
Adres e-mail odbiorcy. |
|
Język
|
Receivers.Language | string |
Język odbiornika, dozwolone są tylko de-DE, en-US, es-ES, fr-FR, it-IT i nl-NL. |
|
Temat
|
Receivers.Subject | string |
Temat wiadomości e-mail odbiorcy w postaci zwykłego tekstu. |
|
Message
|
Receivers.Message | string |
Wiadomość e-mail w kierunku odbiorcy w postaci zwykłego tekstu. |
|
Reference
|
Receivers.Reference | string |
Odwołanie do odbiornika. |
|
Context
|
Receivers.Context | object |
Dowolny prawidłowy obiekt json, który zostanie zwrócony. |
|
Reference
|
Reference | string |
Odwołanie do transakcji. Na przykład "1234" |
|
PostbackUrl
|
PostbackUrl | string |
Bezwzględny adres URL do ogłaszania zwrotnego aktualizacji stanu. |
|
SignRequestMode
|
SignRequestMode | integer |
Ustaw wartość 1 dla wysyłania jednocześnie do wartości 2 dla sekwencyjnych. |
|
DaysToExpire
|
DaysToExpire | integer |
Ilość dni przed wygaśnięciem. Maksymalnie 90 dni. |
|
SendEmailNotifications
|
SendEmailNotifications | boolean |
Wysyłanie powiadomień e-mail do nadawcy. |
|
Status
|
Status | integer |
Bieżący stan transakcji. |
|
CancelationReason
|
CancelationReason | string |
Pierwotna przyczyna anulowania podana podczas wywołania DELETE. |
|
Context
|
Context | object |
Dowolny prawidłowy obiekt json, który zostanie zwrócony. |
Authentication
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
Type | string |
Typ obiektu uwierzytelniania. |
|
Number
|
Number | string |
Numer telefonu: to pole jest obowiązkowe po wybraniu metody uwierzytelniania PhoneNumber |
|
Bsn
|
Bsn | number |
To pole jest obowiązkowe, gdy wybrano metodę uwierzytelniania BSN |
Verification
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
Type | string |
Typ obiektu weryfikacji. |
binarny
Jest to podstawowy typ danych "binary".