Podpisy elektroniczne Connective
Connective eSignatures to znane rozwiązanie podpisów cyfrowych, które oferuje ogromną ilość metod podpisu i zgodności z najbardziej rygorystycznymi (między)krajowymi przepisami. Funkcja eSignatures umożliwia przekształcenie dowolnego procesu opartego na papierze w kompleksowe przepływy cyfrowe z niezrównanym środowiskiem użytkownika. Usprawnij proces podpisywania dokładnie tak, jak chcesz, i wyślij, podpisz i śledź wszystkie typy dokumentów bezpośrednio z ulubionych aplikacji biznesowych. Dołącz do ponad 500 zadowolonych klientów.
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 | Pomoc techniczna dotycząca połączeń |
| adres URL | https://connective.eu/contact-support/ |
| service@connective.eu |
| Metadane łącznika | |
|---|---|
| Publisher | Spójnik |
| Witryna internetowa | https://www.connective.eu |
| Zasady ochrony prywatności | https://connective.eu/privacy-policy/ |
| Kategorie | Operacje IT; Produktywność |
Connective, specjalista ds. podpisów cyfrowych, usług tożsamości i generowania dokumentów inteligentnych, udostępnił łącznik Connective eSignatures Connector for Power Automate do użycia. Łącznik umożliwia firmom przekazywanie dokumentów, które wymagają podpisu cyfrowego bezpośrednio z ulubionych aplikacji platformy Microsoft 365 — od usługi Microsoft Teams do programów Word, SharePoint, Dynamics, OneDrive i wielu innych.
Jak rozpocząć korzystanie z łącznika
Aby rozpocząć korzystanie z łącznika, skontaktuj się z menedżerem relacji w witrynie Connective lub przejdź do naszej strony kontaktowej w naszej witrynie internetowej, aby otrzymać poświadczenia.
Na tej stronie szczegółowo przedstawiono różne dostępne akcje, a także szczegółowe informacje na temat różnych sposobów implementacji tych akcji.
Nie wahaj się zapoznać się z naszą witryną internetową dokumentacji , aby uzyskać więcej informacji lub skontaktować się z zespołem pomocy technicznej za pośrednictwem formularza kontaktu z pomocą techniczną lub skrzynki pocztowej pomocy technicznej: service@connective.eu
Słownik jest dostępny do wyjaśnienia różnych terminów używanych w tej dokumentacji
Czynności
Łącznik Connective eSignatures jest oparty na interfejsie API w wersji 3 eSignatures. Interfejs API eSignatures to interfejs API REST, który umożliwia aplikacjom zewnętrznym integrację z funkcjami wymienionymi w tym dokumencie i korzystanie z nich w celu tworzenia przepływów podpisywania i zarządzania nimi.
Dostępne akcje można zgrupować w różnych grupach
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 |
|---|---|---|---|
| Adres URL środowiska connective eSignatures | ciąg | Adres URL środowiska Connective eSignatures, np. esignatures.connective.eu | Prawda |
| Nazwa użytkownika interfejsu API | securestring | Nazwa użytkownika interfejsu API w celu uzyskania dostępu do interfejsu API | Prawda |
| Hasło interfejsu API | securestring | Hasło interfejsu API w celu uzyskania dostępu do interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Dodawanie dokumentu do pakietu |
To wywołanie spowoduje dodanie dokumentu do istniejącego pakietu. |
| Dodawanie weryfikacji ze źródła zewnętrznego |
To wywołanie umożliwia użytkownikom interfejsu API dodawanie dodatkowych dowodów ze źródła zewnętrznego do lokalizacji w dokumencie. |
| Lista pakietów |
Pobieranie listy pakietów ze swoim bieżącym stanem |
| Pobieranie dokumentu z pakietu |
Podpisane dokumenty w pakiecie można pobrać pojedynczo przez system zewnętrzny przy użyciu tego wywołania. Każdy dokument zostanie pobrany jako plik PDF lub jako strumień plików XML, w zależności od wartości parametru DocumentType. |
| Pobieranie weryfikacji inspekcji korelacji dokumentów |
Identyfikatory korelacji służą do śledzenia pakietów lub dokumentów w kilku przechodzi przez aplikację eSignatures. |
| Pobieranie weryfikacji inspekcji korelacji pakietów |
Identyfikatory korelacji służą do śledzenia pakietów lub dokumentów w kilku przechodzi przez aplikację eSignatures. |
| Pobierz pakiet |
Pakiet zawierający podpisane dokumenty można pobrać przez system zewnętrzny przy użyciu tego wywołania. |
| Pomiń osoby podpisające |
To wywołanie pomija wszystkie osoby podpisujące, które jeszcze nie zostały podpisane i ustawiają ich stan na "Pominięto", co powoduje oznaczenie kompletnego pakietu jako "Zakończono". |
| Sprawdzanie inspekcji pakietów przy użyciu identyfikatora dokumentu |
Plik XML weryfikacji inspekcji pakietu można pobrać, gdy pakiet jest w pełni podpisany. To samo dotyczy dokumentu: działa tylko wtedy, gdy zawierający pakiet jest w pełni podpisany. |
| Sygnatura czasowa wygaśnięcia |
Pakiet może mieć stan Wygasły, gdy pakiet przekazał wartość parametru ExpiryTimestamp w wywołaniu Utwórz pakiet. Taki pakiet nie może już być podpisany. |
| Tworzenie pakietu |
To wywołanie tworzy pusty pakiet, co umożliwia dodawanie do niego dokumentów |
| Tworzenie pakietu błyskawicznego |
To wywołanie tworzy pakiet z jednym dokumentem w nim i natychmiast przygotowuje go do podpisywania |
| Ustawianie informacji o procesie |
Ta metoda usługi internetowej aktualizuje osoby zaangażowane w proces (biorące udział w projekcie) i przypisuje im kroki, które należy wykonać. |
| Ustawianie stanu pakietu |
Za pomocą wywołania Ustaw stan pakietu można zmienić stan pakietu. |
| Usuń pakiet |
Funkcja eSignatures nie usuwa automatycznie pakietów z bazy danych po osiągnięciu stanu końcowego. Są one przechowywane na czas nieokreślony. Aby usunąć pakiety z bazy danych, użytkownicy mogą użyć wywołania Usuń pakiet. |
| Uzyskiwanie lokalizacji podpisywania |
To wywołanie zawiera omówienie wszystkich lokalizacji podpisywania wewnątrz dokumentów w pakiecie. |
| Uzyskiwanie stanu pakietu |
Pobiera bieżący stan pakietu i jego dokumentów. |
| Weryfikacja inspekcji pakietów |
Plik XML weryfikacji inspekcji pakietu można pobrać, gdy pakiet jest w pełni podpisany. To samo dotyczy dokumentu: działa tylko wtedy, gdy zawierający pakiet jest w pełni podpisany. |
| Wysyłanie przypomnień o pakiecie |
Zasady firmy mogą wymagać obsługi dokumentu w danym przednadaniu. Wyzwolenie wywołania "wyślij przypomnienia" spowoduje wyszukanie wszystkich osób, które nie podpisały się i wyśle do nich dodatkowe powiadomienie jako przypomnienie. |
Dodawanie dokumentu do pakietu
To wywołanie spowoduje dodanie dokumentu do istniejącego pakietu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu.
|
PackageId | True | string |
Unikatowy identyfikator pakietu |
|
Dokument
|
Document | string |
Dołączony dokument w formacie zakodowanym w formacie base64. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Język używany w tekstach podpisów. |
|
|
NazwaDokumentu
|
DocumentName | string |
Nazwa dokumentu, który ma być wyświetlany w portalu eSignatures. |
|
|
Numer strony
|
PageNumber | integer |
Numer strony, na której ma zostać dodana lokalizacja podpisywania |
|
|
Szerokość
|
Width | string |
Szerokość |
|
|
Wysokość
|
Height | string |
Wysokość |
|
|
Lewo
|
Left | string |
Położenie z lewej strony |
|
|
Do góry
|
Top | string |
Położenie od góry strony |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unikatowe odwołanie do pola podpisywania, znacznika tekstu lub pola tekstowego. |
|
|
Identyfikator korelacji
|
CorrelationId | string |
Identyfikator wskazujący, które dokumenty w tym pakiecie są skorelowane z dokumentami, które zostały podpisane w przeszłości w innych pakietach. |
|
|
DocumentType
|
DocumentType | string |
Typ dokumentu, który zostanie podpisany. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Odwołanie podane przez aplikację wywołującą. |
|
|
ErrorCode
|
ErrorCode | string |
Kod błędu z informacjami o zmiennej. |
|
|
Message
|
Message | string |
Tekst szczegółów komunikatu o błędzie, nie zlokalizowany |
|
|
Reprezentacja
|
Representation | string |
Dołączony dokument reprezentacji w formacie base64. Musi to być dane PDF. |
|
|
Typ reprezentacji
|
RepresentationType | string |
Typ dokumentu reprezentacji. |
|
|
TypDocelowy
|
TargetType | string |
Typ TargetType określa, czy przed podpisaniem należy wykonać dodatkową konwersję na plik PDF/A. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
DocumentId | string |
Unikatowy identyfikator dokumentu |
|
Sygnatura czasowa tworzenia
|
CreationTimestamp | string |
Data i godzina utworzenia przepływu. Format: RRRR-MM-DDThh:mm:ss+zz:zz |
|
Lokalizacje
|
Locations | array of object |
Reprezentuje możliwą lokalizację podpisu |
|
Id
|
Locations.Id | string |
Unikatowy identyfikator dla tej lokalizacji |
|
Etykieta
|
Locations.Label | string |
Wykryta lub określona etykieta |
|
Numer strony
|
Locations.PageNumber | integer |
Strona, na której została znaleziona lokalizacja. |
Dodawanie weryfikacji ze źródła zewnętrznego
To wywołanie umożliwia użytkownikom interfejsu API dodawanie dodatkowych dowodów ze źródła zewnętrznego do lokalizacji w dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
packageId | True | string |
Unikatowy identyfikator pakietu |
|
Content
|
Content | string |
Rzeczywista zawartość dowodu. |
|
|
Identyfikator lokalizacji
|
LocationId | string |
Lokalizacja podpisu, dla którego wygenerowano zawartość dowodu. |
|
|
Name
|
Name | string |
Nazwa dowodu. |
|
|
Typ
|
Type | string |
Klucz "type" czytelny dla maszyny. Można swobodnie wybrać. |
|
|
Description
|
Description | string |
Krótki czytelny dla człowieka opis dowodu. |
|
|
Adresy IP
|
IpAddress | string |
Adres IP użytkownika końcowego zewnętrznego źródła, dla którego dodano dowód. |
Lista pakietów
Pobieranie listy pakietów ze swoim bieżącym stanem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Token kontynuacji /identyfikator GUID, aby dowiedzieć się, jaka strona ma być zwracana.
|
ContinuationToken | string |
Token kontynuacji /identyfikator GUID, aby dowiedzieć się, jaka strona ma być zwracana. MUSI BYĆ PUSTY LUB token zwrócony z poprzedniego wywołania. |
|
|
Pobiera lub ustawia maksymalną ilość.
|
MaxQuantity | integer |
Pobiera lub ustawia maksymalną ilość. |
|
|
Pobiera lub ustawia pole sortowania.
|
SortField | string |
Pobiera lub ustawia pole sortowania. |
|
|
Pobiera lub ustawia pole sortowania.
|
SortOrder | string |
Pobiera lub ustawia pole sortowania. |
|
|
Pobiera lub ustawia utworzone przed datą.
|
CreatedBeforeDate | string |
Pobiera lub ustawia utworzone przed datą. |
|
|
Pobiera lub ustawia stan.
|
Status | string |
Pobiera lub ustawia stan. |
|
|
Pobiera lub ustawia utworzone po dacie.
|
createdAfterDate | string |
Pobiera lub ustawia utworzone po dacie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ContinuationToken
|
ContinuationToken | string |
ContinuationToken |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Przedmioty
|
Items | array of Package |
Pobieranie dokumentu z pakietu
Podpisane dokumenty w pakiecie można pobrać pojedynczo przez system zewnętrzny przy użyciu tego wywołania. Każdy dokument zostanie pobrany jako plik PDF lub jako strumień plików XML, w zależności od wartości parametru DocumentType.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu podpisywania
|
id | True | string |
Unikatowy identyfikator pakietu podpisywania |
|
Unikatowy identyfikator dokumentu zawartego w pakiecie
|
documentId | True | string |
Unikatowy identyfikator dokumentu zawartego w pakiecie |
Zwraca
- response
- binary
Pobieranie weryfikacji inspekcji korelacji dokumentów
Identyfikatory korelacji służą do śledzenia pakietów lub dokumentów w kilku przechodzi przez aplikację eSignatures.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator korelacji.
|
correlationId | True | string |
Identyfikator korelacji. |
Zwraca
- Body
- Content
Pobieranie weryfikacji inspekcji korelacji pakietów
Identyfikatory korelacji służą do śledzenia pakietów lub dokumentów w kilku przechodzi przez aplikację eSignatures.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator korelacji.
|
correlationId | True | string |
Identyfikator korelacji. |
Zwraca
- Body
- Content
Pobierz pakiet
Pakiet zawierający podpisane dokumenty można pobrać przez system zewnętrzny przy użyciu tego wywołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
id | True | string |
Unikatowy identyfikator pakietu |
Zwraca
- response
- binary
Pomiń osoby podpisające
To wywołanie pomija wszystkie osoby podpisujące, które jeszcze nie zostały podpisane i ustawiają ich stan na "Pominięto", co powoduje oznaczenie kompletnego pakietu jako "Zakończono".
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
PackageId | True | string |
Unikatowy identyfikator pakietu |
Sprawdzanie inspekcji pakietów przy użyciu identyfikatora dokumentu
Plik XML weryfikacji inspekcji pakietu można pobrać, gdy pakiet jest w pełni podpisany. To samo dotyczy dokumentu: działa tylko wtedy, gdy zawierający pakiet jest w pełni podpisany.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
packageId | True | string |
Unikatowy identyfikator pakietu |
|
Unikatowy identyfikator dokumentu
|
documentId | True | string |
Unikatowy identyfikator dokumentu |
Zwraca
- Body
- Content
Sygnatura czasowa wygaśnięcia
Pakiet może mieć stan Wygasły, gdy pakiet przekazał wartość parametru ExpiryTimestamp w wywołaniu Utwórz pakiet. Taki pakiet nie może już być podpisany.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
id | True | string |
Unikatowy identyfikator pakietu |
|
Znacznik czasu wygaśnięcia
|
ExpiryTimestamp | date-time |
Tworzenie pakietu
To wywołanie tworzy pusty pakiet, co umożliwia dodawanie do niego dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Initiator
|
Initiator | string |
Adres e-mail zarejestrowanego użytkownika. |
|
|
PackageName
|
PackageName | string |
Nazwa pakietu widoczna w portalu eSignatures i podczas pobierania jako pliku zip. |
|
|
CallBackUrl
|
CallBackUrl | string |
Adres URL interfejsu API REST, który będzie wywoływany za każdym razem, gdy akcja została ukończona dla tego pakietu. |
|
|
Identyfikator korelacji
|
CorrelationId | string |
Identyfikator wskazujący, które pakiety są skorelowane. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
"Kod", który identyfikuje grupę dokumentów, w której powinien być wyświetlany pakiet. |
|
|
Kod motywu
|
ThemeCode | string |
Motyw, który należy zastosować do pakietu |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Ten parametr określa, czy pakiety można pobrać z interfejsu WYSIWYS przed podpisaniem. |
|
|
Ponowne przypisywanieEnabled
|
ReassignEnabled | boolean |
Ten parametr określa, czy pakiety mogą być ponownie przypisywane z interfejsu WYSIWYS do innego osoby zatwierdzającej/osoby podpisującego. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Ten parametr określa, ile dni adresy URL akcji muszą wygasać, gdy nie są używane. |
|
|
Znacznik czasu wygaśnięcia
|
ExpiryTimestamp | string |
Data i godzina wygaśnięcia tego pakietu i nie może być już podpisana. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Odwołanie podane przez aplikację wywołującą. Ten parametr nie będzie używany przez portal eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
To pole jest zarezerwowane do użytku w przyszłości. Może służyć do integracji rozszerzeń specyficznych dla klienta z usługami innych firm, takimi jak podpisywanie kart debetowych. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Adres URL, do którego użytkownik końcowy jest przekierowywany po podpisaniu wszystkich pól z podpisem "twarzą w twarz" lub gdy wszystkie pola zostały odrzucone. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Adres URL interfejsu API REST, który będzie wywoływany, gdy użytkownik końcowy zażąda powiadomienia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Unikatowy identyfikator pakietu. |
|
Sygnatura czasowa tworzenia
|
CreationTimestamp | string |
Data i godzina utworzenia pakietu zgodnie z serwerem. |
Tworzenie pakietu błyskawicznego
To wywołanie tworzy pakiet z jednym dokumentem w nim i natychmiast przygotowuje go do podpisywania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Dokument
|
Document | byte |
Dołączony dokument w formacie zakodowanym w formacie base64. Wymagane, chyba że jest używany format multipart. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Język używany w tekstach podpisów. Obecnie obsługiwane: en, nl, de, fr, es. |
|
|
NazwaDokumentu
|
DocumentName | string |
Nazwa dokumentu i pakietu, który ma być wyświetlany w portalu eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
Adres e-mail zarejestrowanego użytkownika |
|
|
Typ
|
Type | string |
Signer/Receiver |
|
|
OrderIndex
|
OrderIndex | integer |
Ta liczba określa, w której podmioty kolejności muszą wykonać swoją akcję. |
|
|
Numer strony
|
PageNumber | integer |
Numer strony, na której ma zostać dodana lokalizacja podpisywania |
|
|
Szerokość
|
Width | string |
Szerokość |
|
|
Wysokość
|
Height | string |
Wysokość |
|
|
Lewo
|
Left | string |
Położenie z lewej strony |
|
|
Do góry
|
Top | string |
Położenie od góry strony |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unikatowe odwołanie do pola podpisywania, znacznika tekstu lub pola tekstowego. |
|
|
Typ podpisywania
|
SigningType | string |
Typ podpisywania używany w sesji tego aktora. |
|
|
Typy zobowiązania
|
CommitmentTypes | array of string |
Co najmniej jeden identyfikator operacyjnego typów zobowiązań. Można przekazywać tylko wtedy, gdy są używane zasady podpisu. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Typ weryfikacji do wykonania podczas innej karty inteligentnej eID lub sesji podpisywania itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Określa, które identyfikatory eID lub inne karty inteligentne mogą się podpisywać podczas tej sesji. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Szczegóły zasad podpisywania podpisu. |
|
|
Numer telefonu
|
Phonenumber | string |
Numer telefonu do odbierania wiadomości SMS OTP. |
|
|
RedirectUrl
|
RedirectUrl | string |
Adres URL, do którego użytkownik końcowy jest przekierowywany po podpisaniu. |
|
|
SendNotifications
|
SendNotifications | boolean |
ESignatures mogą wysyłać wiadomości e-mail do wszystkich osób, które mogą się podpisać. |
|
|
UserRoles
|
UserRoles | array of string |
Rola lub funkcja sygnatariusza. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Prawne |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Niestandardowy tekst powiadomienia prawnego w przypadku, gdy żadne z trzech wstępnie zdefiniowanych powiadomień prawnych nie ma zastosowania. |
|
|
Adres e-mail
|
EmailAddress | string |
Adres e-mail |
|
|
Imię (pierwsze)
|
FirstName | string |
Imię (pierwsze) |
|
|
Nazwisko
|
LastName | string |
Nazwisko |
|
|
Dataurodzenia
|
BirthDate | string |
Dataurodzenia |
|
|
Język
|
Language | string |
Język |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
Adres URL interfejsu API REST, który będzie wywoływany za każdym razem, gdy akcja została ukończona dla tego pakietu |
|
|
Identyfikator korelacji
|
CorrelationId | string |
Identyfikator wskazujący, które pakiety lub dokumenty są skorelowane |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
"Kod", który identyfikuje grupę dokumentów, w której powinien być wyświetlany dokument |
|
|
Kod motywu
|
ThemeCode | string |
Motyw, który należy zastosować do pakietu |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Ten parametr określa, czy pakiety można pobrać z interfejsu WYSIWYS przed podpisaniem |
|
|
Ponowne przypisywanieEnabled
|
ReassignEnabled | boolean |
Ten parametr określa, czy pakiety mogą być ponownie przypisywane z interfejsu WYSIWYS do innego osoby zatwierdzającej/osoby podpisującego. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Ten parametr określa, ile dni adresy URL akcji muszą wygasać, gdy nie są używane. |
|
|
Znacznik czasu wygaśnięcia
|
ExpiryTimestamp | string |
Odwołanie podane przez aplikację wywołującą. Ten parametr nie będzie używany przez portal eSignatures |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Odwołanie podane przez aplikację wywołującą, ten parametr nie będzie używany przez portal eSignatures |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Odwołanie podane przez aplikację wywołującą, ten parametr nie będzie używany przez portal eSignatures |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Adres URL, do którego użytkownik końcowy jest przekierowywany po podpisaniu wszystkich pól z podpisem "twarzą w twarz" lub gdy wszystkie pola zostały odrzucone. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Adres URL interfejsu API REST, który będzie wywoływany, gdy użytkownik końcowy zażąda powiadomienia. Jeśli żaden adres URL nie zostanie podany, nie zostanie wykonane wywołanie zwrotne |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Jak radzić sobie z plikami PDF zawierającymi drobne wady |
|
|
Reprezentacja
|
Representation | string |
Dołączony dokument reprezentacji w formacie base64 |
|
|
Typ reprezentacji
|
RepresentationType | string |
Typ dokumentu reprezentacji musi być obecny po wypełnieniu reprezentacji. Obsługiwane są tylko pliki "application/pdf". |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
Szablon skonfigurowany w portalu będzie dostarczać wszystkie niezbędne informacje |
|
|
TypDocelowy
|
TargetType | string |
Typ TargetType określa, czy przed podpisaniem należy wykonać dodatkową konwersję na plik PDF/A |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Unikatowy identyfikator pakietu. |
|
Sygnatura czasowa tworzenia
|
CreationTimestamp | string |
Data i godzina utworzenia pakietu zgodnie z serwerem. |
Ustawianie informacji o procesie
Ta metoda usługi internetowej aktualizuje osoby zaangażowane w proces (biorące udział w projekcie) i przypisuje im kroki, które należy wykonać.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
id | True | string |
Unikatowy identyfikator pakietu |
|
Typ
|
Type | string |
Typ |
|
|
OrderIndex
|
OrderIndex | string |
Ta liczba określa, w której podmioty kolejności muszą wykonać swoją akcję. |
|
|
Identyfikatory lokalizacji
|
LocationIds | array of string |
Identyfikatory lokalizacji, w których musi zostać umieszczony podpis przez tę osobę. |
|
|
Typ podpisywania
|
SigningType | string |
Typ podpisywania używany w sesji tego aktora. |
|
|
Typy zobowiązania
|
CommitmentTypes | array of string |
Co najmniej jeden identyfikator operacyjnego typów zobowiązań. Można przekazywać tylko wtedy, gdy są używane zasady podpisu. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Typ weryfikacji do wykonania podczas innej karty inteligentnej eID lub sesji podpisywania itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Określa, które identyfikatory eID lub inne karty inteligentne mogą się podpisywać podczas tej sesji. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Szczegóły zasad podpisywania podpisu. |
|
|
Numer telefonu
|
Phonenumber | string |
Numer telefonu do odbierania wiadomości SMS OTP. |
|
|
RedirectURL
|
RedirectURL | string |
Adres URL, do którego użytkownik końcowy jest przekierowywany po podpisaniu lub odrzuceniu. Przekierowanie następuje natychmiast po podpisaniu lub odrzuceniu. |
|
|
SendNotifications
|
SendNotifications | boolean |
ESignatures mogą wysyłać wiadomości e-mail do aktorów, których akcja jest wymagana, na przykład podpisywanie |
|
|
UserRoles
|
UserRoles | array of string |
Identyfikatory lokalizacji, w których musi zostać umieszczony podpis przez tę osobę. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
3 wartości będą wskazywać 3 powiadomienia prawne wbudowane w aplikację. Można je zmienić w indeksie konfiguracji. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Niestandardowy tekst powiadomienia prawnego w przypadku, gdy żadne z trzech wstępnie zdefiniowanych powiadomień prawnych nie ma zastosowania |
|
|
Adres e-mail
|
EmailAddress | string |
Adres e-mail |
|
|
Imię (pierwsze)
|
FirstName | string |
Imię |
|
|
Język
|
Language | string |
Język interfejsu użytkownika tego uczestnika projektu. Obecnie obsługiwane: en, nl, de, fr, es. |
|
|
Nazwisko
|
LastName | string |
Nazwisko |
|
|
Dataurodzenia
|
BirthDate | string |
Data urodzenia w formacie: RRRR-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Odwołanie podane przez aplikację wywołującą. Ten parametr nie będzie używany przez portal eSignatures. |
Ustawianie stanu pakietu
Za pomocą wywołania Ustaw stan pakietu można zmienić stan pakietu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu podpisywania
|
Id | True | string |
Unikatowy identyfikator pakietu podpisywania |
|
Status
|
Status | string |
Oczekujące/odwołane |
Zwraca
Opis pakietu wyświetlanego użytkownikowi portalu eSignatures jako nazwy pliku.
- Body
- PackageStatus
Usuń pakiet
Funkcja eSignatures nie usuwa automatycznie pakietów z bazy danych po osiągnięciu stanu końcowego. Są one przechowywane na czas nieokreślony. Aby usunąć pakiety z bazy danych, użytkownicy mogą użyć wywołania Usuń pakiet.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
id | True | string |
Unikatowy identyfikator pakietu |
Uzyskiwanie lokalizacji podpisywania
To wywołanie zawiera omówienie wszystkich lokalizacji podpisywania wewnątrz dokumentów w pakiecie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola podpisywania
|
Id | True | string |
Identyfikator pola podpisywania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
Identyfikator dokumentu
|
Documents.DocumentId | string |
Unikatowy identyfikator dokumentu |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Dokumentacja zewnętrzna do identyfikacji. Pamiętaj, aby użyć unikatowej wartości. |
|
Lokalizacje
|
Documents.Locations | array of object |
Reprezentuje możliwą lokalizację podpisu |
|
Id
|
Documents.Locations.Id | string |
Unikatowy identyfikator dla tej lokalizacji. |
|
Etykieta
|
Documents.Locations.Label | string |
Wartość wprowadzona jako parametr żądania. |
|
Numer strony
|
Documents.Locations.PageNumber | integer |
Numer strony, na której można znaleźć podpis. |
Uzyskiwanie stanu pakietu
Pobiera bieżący stan pakietu i jego dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu podpisywania
|
Id | True | string |
Unikatowy identyfikator pakietu podpisywania |
Zwraca
Opis pakietu wyświetlanego użytkownikowi portalu eSignatures jako nazwy pliku.
- Body
- PackageStatus
Weryfikacja inspekcji pakietów
Plik XML weryfikacji inspekcji pakietu można pobrać, gdy pakiet jest w pełni podpisany. To samo dotyczy dokumentu: działa tylko wtedy, gdy zawierający pakiet jest w pełni podpisany.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
packageId | True | string |
Unikatowy identyfikator pakietu |
Zwraca
- Body
- Content
Wysyłanie przypomnień o pakiecie
Zasady firmy mogą wymagać obsługi dokumentu w danym przednadaniu. Wyzwolenie wywołania "wyślij przypomnienia" spowoduje wyszukanie wszystkich osób, które nie podpisały się i wyśle do nich dodatkowe powiadomienie jako przypomnienie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator pakietu
|
PackageId | True | string |
Unikatowy identyfikator pakietu |
Definicje
Package
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Szczegóły dla każdego z dokumentów w pakiecie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
DocumentId | string |
Unikatowy identyfikator dokumentu |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Zwraca odwołanie zewnętrzne tego dokumentu, ponieważ zostało przekazane za pośrednictwem wywołania Dodaj dokument do pakietu. |
|
NazwaDokumentu
|
DocumentName | string |
Nazwa dokumentu |
|
DocumentType
|
DocumentType | string |
Typ dokumentu w pakiecie. |
PackageStatus
Opis pakietu wyświetlanego użytkownikowi portalu eSignatures jako nazwy pliku.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Opis pakietu wyświetlanego użytkownikowi portalu eSignatures jako nazwy pliku. |
|
Sygnatura czasowa tworzenia
|
CreationTimestamp | string |
Data i godzina utworzenia pakietu zgodnie z serwerem. |
|
Initiator
|
Initiator | string |
Pole inicjatora pakietu, które zostało przekazane w czasie tworzenia. |
|
Znacznik czasu wygaśnięcia
|
ExpiryTimestamp | string |
Formatowany czas UTC, o którym wygasa dokument. Może mieć wartość null. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Zwraca identyfikator odwołania zewnętrznego pakietu, który został przekazany w czasie tworzenia. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Połącz się z pakietem, który umożliwia wybranie z całej sesji podpisywania jednocześnie. |
|
PackageStatus
|
PackageStatus | string |
Stan pakietu jako całości: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Szczegóły dla każdego z dokumentów w pakiecie. |
|
Interesariusze
|
Stakeholders | array of object |
Szczegóły poszczególnych osób, które będą wchodzić w interakcję z pakietem. |
|
Typ
|
Stakeholders.Type | string |
Typ uczestnika projektu: Osoba, PersonGroup lub ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Nazwa grupy osób. Zwracane tylko wtedy, gdy typ został ustawiony na PersonGroup w żądaniu. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Kod grupy kontaktów. Zwracane tylko wtedy, gdy typ został ustawiony na ContactGroup w żądaniu. |
|
Adres e-mail
|
Stakeholders.EmailAddress | string |
Adres e-mail sygnatariusza. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Dokumentacja zewnętrzna identyfikująca tę osobę w systemie zewnętrznym. |
|
Identyfikator uczestnika projektu
|
Stakeholders.StakeholderId | string |
Unikatowy identyfikator. |
|
Actors
|
Stakeholders.Actors | array of object |
Szczegóły wszystkich kroków do wykonania. |
|
Identyfikator aktora
|
Stakeholders.Actors.ActorId | string |
Unikatowy identyfikator dla tej kombinacji działań, uczestników projektu i dokumentu. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
Adres URL, który ta osoba może otworzyć w celu interakcji z pakietem. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Tablica adresów URL, które mogą być otwierane w celu interakcji z pakietem przez różne osoby grupy PersonGroup lub ContactGroup. |
|
Adres e-mail
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Adres e-mail osoby. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
Adres URL, który ta osoba może otworzyć w celu interakcji z pakietem. |
|
AktorStatus
|
Stakeholders.Actors.ActorStatus | string |
Wersja robocza (pakiet ma stan Wersja robocza) |
|
Typ
|
Stakeholders.Actors.Type | string |
Signer/Receiver |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Nazwa użytkownika końcowego, który wykonał akcję. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Sygnatura czasowa chwili zakończenia tej akcji. |
|
Przyczyna
|
Stakeholders.Actors.Reason | string |
Zwraca tekst wprowadzony przez osobę, która zmieniła stan pakietu na stan końcowy (np. odrzucenie). |
|
Lokalizacje
|
Stakeholders.Actors.Locations | array of object |
Reprezentuje możliwą lokalizację podpisu. |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
Unikatowy identyfikator dla tej lokalizacji |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Zwraca typ podpisywania użyty do podpisania dokumentu. |
Content
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przesłane
|
uploads | array of object | |
|
przekazywać
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
koniec
|
uploads.upload.end | date-time | |
|
Podpisów
|
uploads.upload.signatures | array of object | |
|
Dowody
|
uploads.upload.signatures.proofs | array of object | |
|
nazwa
|
uploads.upload.signatures.proofs.proof.name | string | |
|
typ
|
uploads.upload.signatures.proofs.proof.type | string | |
|
indeks
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
Indeksy
|
uploads.indexes | array of object | |
|
identyfikator
|
uploads.indexes.index.identifier | boolean | |
|
zawartość
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
packageId (identyfikator pakietu)
|
uploads.packageId | string |
binarny
Jest to podstawowy typ danych "binary".