Certinal eSign (wersja zapoznawcza)
Aplikacja Certinal eSign umożliwia przedsiębiorstwom bezpieczne wysyłanie dokumentów, podpisywanie i zarządzanie nimi przy użyciu zgodnych globalnie dokumentów eSignature. Przeznaczony dla branż regulowanych certinal zapewnia śledzenie przepływu pracy w czasie rzeczywistym, ślady inspekcji sprawdzające manipulacje i bezproblemową automatyzację. Użyj certyfikatu Certinal eSign w swoich przepływach pracy, aby cyfry zatwierdzeń, przyspieszyć procesy i zapewnić legalnie prawidłowe podpisy w 70+ krajach.
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 | Pomoc i obsługa techniczna |
| adres URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| Metadane łącznika | |
|---|---|
| Publisher | Certinal Inc. |
| Witryna internetowa | https://www.certinal.com/ |
| Zasady ochrony prywatności | https://www.certinal.com/privacy-policy |
| Kategorie | Produktywność; Zarządzanie biznesem |
Certinal eSign
Przegląd
Certinal eSign zapewnia bezpieczne, zgodne przepływy pracy eSignature i eConsent dla globalnych przedsiębiorstw — wysyłanie, podpisywanie, śledzenie i zarządzanie dokumentami bezpośrednio z usługi Power Automate.
Wymagania wstępne
Aby użyć wyzwalacza łącznika, musisz mieć konto administratora certinal. Aby używać wyzwalacza łącznika w tej integracji, należy włączyć łącznik Power Connector w ustawieniach administratora certinal.
Jak uzyskać poświadczenia
Certinal używa klucza interfejsu API do uwierzytelniania usług. Musisz wygenerować klucz interfejsu API na podstawie konta administratora certinal.
Obsługiwane operacje
Łącznik obsługuje następujące operacje:
Pobieranie szczegółów transakcji
Pobieranie szczegółów transakcji według identyfikatora transakcji
Pobieranie dokumentów dla transakcji
Pobieranie dokumentów dla podanego identyfikatora transakcji
Tworzenie transakcji
Tworzenie transakcji
Tworzenie transakcji przy użyciu szablonu
Tworzenie transakcji przy użyciu danego identyfikatora szablonu
Wyświetlanie listy użytkowników
Wyświetlanie listy użytkowników
Pobieranie szczegółów użytkownika
Pobieranie szczegółów użytkownika dla danego identyfikatora użytkownika
Tworzenie użytkowników
Tworzenie użytkowników
Obsługiwane wyzwalacze
Łącznik obsługuje następujące wyzwalacze:
Po zmianie stanu transakcji
Rejestrowanie wywołania zwrotnego dla określonego zdarzenia transakcji
Dokumenty interfejsu API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Pomoc i obsługa techniczna
https://esign.certinal.com/esign/certinal-docs/help-support
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 |
|---|---|---|---|
| Klucz interfejsu API | securestring | Klucz interfejsu API dla tego interfejsu API | Prawda |
| Podstawowy punkt końcowy interfejsu API | ciąg | Podstawowy adres URL punktu końcowego interfejsu API (np. api.certinal.com) | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie dokumentów dla transakcji |
Pobieranie dokumentów dla podanego identyfikatora transakcji |
| Pobieranie szczegółów transakcji |
Pobieranie szczegółów transakcji według identyfikatora transakcji |
| Pobieranie szczegółów użytkownika |
Pobieranie szczegółów użytkownika dla danego identyfikatora użytkownika |
| Tworzenie transakcji |
Tworzenie transakcji |
| Tworzenie transakcji przy użyciu szablonu |
Tworzenie transakcji przy użyciu danego identyfikatora szablonu |
| Tworzenie użytkowników |
Tworzenie użytkowników |
| Usuń subskrypcję |
Usuń subskrypcję |
| Wyświetlanie listy użytkowników |
Wyświetlanie listy użytkowników |
Pobieranie dokumentów dla transakcji
Pobieranie dokumentów dla podanego identyfikatora transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Unikatowy identyfikator transakcji |
|
Typ dokumentu
|
documentType | True | string |
Typ dokumentu do pobrania |
Zwraca
- response
- file
Pobieranie szczegółów transakcji
Pobieranie szczegółów transakcji według identyfikatora transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transactionId | True | string |
Unikatowy identyfikator transakcji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Nazwa transakcji
|
data.name | string |
Nazwa transakcji |
|
Stan transakcji
|
data.status | string |
Stan transakcji |
|
Identyfikator transakcji
|
data.transactionId | string |
Identyfikator transakcji |
|
Message
|
data.mail.message | string |
Wiadomość e-mail dla wszystkich uczestników. |
|
Data ostatniej aktualizacji
|
data.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.createdDate | string |
Data utworzenia |
|
Identyfikator użytkownika
|
data.createdBy.id | string |
Utworzone przez identyfikator użytkownika |
|
Nazwa użytkownika
|
data.createdBy.username | string |
Utworzone przez nazwę użytkownika |
|
Adres e-mail
|
data.createdBy.emailAddress | string |
Utworzone przez adres e-mail |
|
Data wysłania
|
data.sentDate | string |
Data wysłania |
|
Identyfikator użytkownika
|
data.lastActionPerformedBy.userId | string |
Identyfikator użytkownika |
|
Nazwa użytkownika
|
data.lastActionPerformedBy.userName | string |
Nazwa użytkownika |
|
Adres e-mail
|
data.lastActionPerformedBy.emailAddress | string |
Adres e-mail |
|
Identyfikator kandydata
|
data.lastActionPerformedBy.candidateId | string |
Identyfikator kandydata |
|
Identyfikator uczestnika
|
data.lastActionPerformedBy.participantId | string |
Identyfikator uczestnika |
|
Wygasa w znaczniku czasu
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transakcja wygasa w znaczniku czasu |
|
Dni wygaśnięcia
|
data.expiryAndReminders.expiryDays | integer |
Dni wygaśnięcia |
|
Przypomnienie z dni przypomnienia
|
data.expiryAndReminders.remindFromReminderDays | integer |
Przypomnienie z dni przypomnienia |
|
Przypomnienie z czasu przypomnienia
|
data.expiryAndReminders.remindFromReminderTime | string |
Przypomnienie z czasu przypomnienia |
|
Częstotliwość przypomnienia
|
data.expiryAndReminders.reminderFrequency | integer |
Częstotliwość przypomnienia |
|
Uczestnicy
|
data.participants | array of object |
Uczestnicy |
|
Identyfikator uczestnika
|
data.participants.id | string |
Identyfikator uczestnika |
|
Stan uczestnika
|
data.participants.status | string |
Stan uczestnika |
|
Data ostatniej aktualizacji
|
data.participants.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.participants.createdDate | string |
Data utworzenia |
|
Sekwencja uczestnika
|
data.participants.sequence | integer |
Kolejność |
|
Role
|
data.participants.role | string |
Role |
|
Metoda podpisywania
|
data.participants.signingMethodDTO | array of string |
Szczegóły metody podpisywania |
|
Przesłane przez użytkownika
|
data.participants.submittedBys | array of object |
Przesłane przez użytkownika szczegóły |
|
Identyfikator użytkownika
|
data.participants.submittedBys.userId | string |
Przesłane przez identyfikator użytkownika |
|
Nazwa użytkownika
|
data.participants.submittedBys.userName | string |
Przesłane przez nazwę użytkownika |
|
Adres e-mail
|
data.participants.submittedBys.emailAddress | string |
Przesłane przez adres e-mail użytkownika |
|
Identyfikator kandydata
|
data.participants.submittedBys.candidateId | string |
Identyfikator kandydata |
|
Kandydatów
|
data.participants.candidates | array of object |
Kandydatów |
|
Identyfikator kandydata
|
data.participants.candidates.id | string |
Identyfikator kandydata |
|
Name
|
data.participants.candidates.name | string |
Nazwisko kandydata |
|
Adres e-mail
|
data.participants.candidates.emailAddress | string |
Adres e-mail kandydata |
|
Język
|
data.participants.candidates.language | string |
Język |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Akcja
|
data.participants.candidates.action | string |
Akcja |
|
Data akcji
|
data.participants.candidates.actionDate | string |
Data akcji |
|
Data utworzenia
|
data.participants.candidates.createdDate | string |
Data utworzenia |
|
Wartość trybu uwierzytelniania
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Wartość trybu uwierzytelniania |
|
szczegóły metody podpisywania
|
data.participants.candidates.signingMethodDTO | array of string |
szczegóły metody podpisywania |
|
Załączniki
|
data.participants.candidates.attachments | array of |
Załączniki |
|
Kanały dostarczania
|
data.participants.candidates.deliveryChannels | array of string |
Kanały dostarczania |
|
Pola formularza
|
data.participants.fields | array of object |
Pola formularza |
|
Id
|
data.participants.fields.id | string |
Id |
|
Data ostatniej aktualizacji
|
data.participants.fields.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.participants.fields.createdDate | string |
Data utworzenia |
|
Identyfikator pola
|
data.participants.fields.fieldId | string |
Identyfikator pola |
|
Brak strony
|
data.participants.fields.pageNo | integer |
Brak strony |
|
Identyfikator dokumentu
|
data.participants.fields.documentId | string |
Identyfikator dokumentu |
|
Szerokość pola
|
data.participants.fields.width | float |
Szerokość pola |
|
Wysokość pola
|
data.participants.fields.height | float |
Wysokość pola |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Wartość
|
data.participants.fields.value | string |
Wartość |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
Styl nazwy
|
data.participants.fields.nameStyle | string |
Styl nazwy |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Etykieta wyświetlana
|
data.participants.fields.displayLabel | string |
Etykieta wyświetlana |
|
Typ łącza
|
data.participants.fields.linkType | string |
Typ łącza |
|
Identyfikator radiowy
|
data.participants.fields.radioId | integer |
Identyfikator radiowy |
|
Identyfikator grupy radiowej
|
data.participants.fields.radioGroupId | string |
Identyfikator grupy radiowej |
|
Identyfikator pola wyboru
|
data.participants.fields.checkboxId | integer |
Identyfikator pola wyboru |
|
Nazwa pola
|
data.participants.fields.fieldName | string |
Nazwa pola |
|
Położenie X
|
data.participants.fields.xposition | float |
X położenie pola |
|
Położenie Y
|
data.participants.fields.yposition | float |
Położenie Y pola |
|
Czy jest to wymagane?
|
data.participants.fields.required | boolean |
Czy jest to wymagane pole? |
|
Czy jest tylko do odczytu?
|
data.participants.fields.readOnly | boolean |
Czy jest to pole tylko do odczytu? |
|
Obszar tekstu
|
data.participants.fields.textarea | boolean |
Obszar tekstu |
|
Pionowy
|
data.participants.fields.vertical | boolean |
Pionowy |
|
Górna dół
|
data.participants.fields.topBottom | boolean |
Górna dół |
|
Wartość domyślna
|
data.participants.fields.defaultValue | string |
Wartość domyślna |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Kolejność
|
data.participants.signatureBlock.format.sequence | integer |
Kolejność |
|
Czy jest to wymagane?
|
data.participants.signatureBlock.format.required | boolean |
Czy jest to wymagane? |
|
Default
|
data.participants.signatureBlock.default | boolean |
Default |
|
Włącz pełnomocnika
|
data.participants.enableDelegate | boolean |
Włącz pełnomocnika |
|
Proces automatyczny
|
data.participants.autoProcess | boolean |
Proces automatyczny |
|
Użytkownicy usługi CC
|
data.ccUsers | array of object |
Użytkownicy usługi CC |
|
Name
|
data.ccUsers.name | string |
Name |
|
Adres e-mail
|
data.ccUsers.emailAddress | string |
Adres e-mail |
|
Język
|
data.ccUsers.language | string |
Język |
|
Documents
|
data.documents | array of object |
Documents |
|
Identyfikator dokumentu
|
data.documents.id | string |
Identyfikator dokumentu |
|
Kolejność
|
data.documents.sequence | integer |
Kolejność |
|
Nazwa pliku
|
data.documents.fileName | string |
Nazwa pliku |
|
Liczba stron
|
data.documents.pageCount | integer |
Liczba stron |
|
Czy można usunąć?
|
data.documents.deletable | boolean |
Czy można usunąć? |
|
Jest prywatny
|
data.documents.private | boolean |
Jest prywatny |
|
Pola niestandardowe
|
data.customFields | array of object |
Pola niestandardowe |
|
Identyfikator pola niestandardowego
|
data.customFields.customFieldId | string |
Identyfikator pola niestandardowego |
|
Wartość pola
|
data.customFields.value | string |
Wartość pola |
|
Nazwa pola
|
data.customFields.fieldName | string |
Nazwa pola |
|
Typ pola
|
data.customFields.fieldType | string |
Typ pola |
|
Subskrypcje powiadomień
|
data.notificationSubscriptions | array of |
Subskrypcje powiadomień |
|
tags
|
data.tags | array of |
tags |
|
Dodatkowe dokumenty
|
data.additionalDocuments | array of object |
Dodatkowe dokumenty |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nazwa pliku
|
data.additionalDocuments.fileName | string |
Nazwa pliku |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
Identyfikator kandydata
|
data.additionalDocuments.candidateId | string |
Identyfikator kandydata |
|
Oddzielne umowy
|
data.separateAgreements | boolean |
Oddzielne umowy |
Pobieranie szczegółów użytkownika
Pobieranie szczegółów użytkownika dla danego identyfikatora użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Unikatowy identyfikator użytkownika |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Imię
|
data.firstName | string |
Imię |
|
Nazwisko
|
data.lastName | string |
Nazwisko |
|
Firma
|
data.company | string |
Firma |
|
Strefa czasowa
|
data.timezone | string |
Strefa czasowa |
|
Język
|
data.language | string |
Język |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Stanowisko
|
data.jobTitle | string |
Stanowisko |
|
Numer telefonu
|
data.phoneNumber | string |
Numer telefonu |
|
Kod kraju
|
data.phoneCountryCode | string |
Kod kraju |
|
Role
|
data.roles | array of string |
Role |
|
Czy ostateczna poczta jest wyłączona?
|
data.finalMailDisabled | boolean |
Czy ostateczna poczta jest wyłączona? |
|
Czy poczta przypomnienia jest wyłączona?
|
data.reminderMailDisabled | boolean |
Czy poczta przypomnienia jest wyłączona? |
|
Czy poczta nadawcy jest wyłączona?
|
data.senderMailDisabled | boolean |
Czy poczta nadawcy jest wyłączona? |
|
Czy użytkownik integracji jest użytkownikiem?
|
data.integrationUser | boolean |
Czy użytkownik integracji jest użytkownikiem? |
|
Zwrot grzecznościowy
|
data.salutation | string |
Zwrot grzecznościowy |
|
Jest aktywny
|
data.active | boolean |
Jest aktywny |
|
Id
|
data.id | string |
Id |
|
Adres e-mail
|
data.emailAddress | string |
Adres e-mail |
Tworzenie transakcji
Tworzenie transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa transakcji
|
name | True | string |
Nazwa transakcji |
|
Message
|
message | string |
Wiadomość e-mail dla wszystkich uczestników. |
|
|
Adres URL wywołania zwrotnego
|
url | string |
Adres URL wywołania zwrotnego |
|
|
Zdarzenia transakcji
|
transactionEvents | array of string |
Zdarzenia transakcji |
|
|
Zdarzenia uczestnika
|
participantEvents | array of string |
Zdarzenia uczestnika |
|
|
Stan transakcji
|
status | string |
Stan transakcji |
|
|
Identyfikator zewnętrzny
|
externalId | string |
Identyfikator zewnętrzny |
|
|
Wygasa w znaczniku czasu
|
expiresAtTimestamp | string |
Transakcja wygasa w znaczniku czasu |
|
|
Przypomnienie ze znacznika czasu
|
remindFromTimestamp | string |
Przypomnienie ze znacznika czasu |
|
|
Częstotliwość przypomnienia
|
reminderFrequency | integer |
Częstotliwość przypomnienia |
|
|
Pola domyślne
|
default | boolean |
Domyślne pola bloku podpisów |
|
|
Sekwencja uczestnika
|
sequence | integer |
Kolejność |
|
|
Role
|
role | string |
Role |
|
|
Name
|
name | string |
Nazwisko kandydata |
|
|
Adres e-mail
|
emailAddress | string |
Adres e-mail kandydata |
|
|
Język
|
language | string |
Język |
|
|
Tryb uwierzytelniania
|
authenticationMode | string |
Tryb uwierzytelniania |
|
|
Wartość trybu uwierzytelniania
|
authenticationModeValue | string |
Wartość trybu uwierzytelniania |
|
|
Kanały dostarczania
|
deliveryChannels | array of string |
Kanały dostarczania |
|
|
Identyfikator pola
|
fieldId | string |
Identyfikator pola |
|
|
Strony
|
pages | array of string |
Strony |
|
|
Identyfikator dokumentu
|
documentId | string |
Identyfikator dokumentu |
|
|
Szerokość pola
|
width | float |
Szerokość pola |
|
|
Wysokość pola
|
height | float |
Wysokość pola |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Liczba wierszy obszaru tekstu
|
textareaLineCount | string |
Liczba wierszy obszaru tekstu |
|
|
Nazwa pola
|
fieldName | string |
Nazwa pola |
|
|
Położenie X
|
xposition | float |
X położenie pola |
|
|
Położenie Y
|
yposition | float |
Położenie Y pola |
|
|
Czy jest to wymagane?
|
required | boolean |
Czy jest to wymagane pole? |
|
|
Czy jest tylko do odczytu?
|
readOnly | boolean |
Czy jest to pole tylko do odczytu? |
|
|
Obszar tekstu
|
textarea | boolean |
Obszar tekstu |
|
|
Górna dół
|
topBottom | boolean |
Górna dół |
|
|
Pionowy
|
vertical | boolean |
Pionowy |
|
|
Identyfikator grupy radiowej
|
radioGroupId | string |
Identyfikator grupy radiowej |
|
|
Wartość domyślna
|
defaultValue | string |
Wartość domyślna |
|
|
Wartość
|
value | string |
Wartość |
|
|
Etykieta wyświetlana
|
displayLabel | string |
Etykieta wyświetlana |
|
|
Name
|
name | string |
Name |
|
|
Adres e-mail
|
emailAddress | string |
Adres e-mail |
|
|
Język
|
language | string |
Język |
|
|
Identyfikator dokumentu
|
id | string |
Identyfikator dokumentu |
|
|
Kolejność
|
sequence | integer |
Kolejność |
|
|
Czy można usunąć?
|
deletable | boolean |
Czy można usunąć? |
|
|
Jest prywatny
|
private | boolean |
Jest prywatny |
|
|
Wartość pola
|
value | string |
Wartość pola |
|
|
Nazwa pola
|
fieldName | string |
Nazwa pola |
|
|
Code
|
code | string |
Code |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Identyfikator transakcji
|
data.transactionId | string |
Identyfikator transakcji |
Tworzenie transakcji przy użyciu szablonu
Tworzenie transakcji przy użyciu danego identyfikatora szablonu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa transakcji
|
name | string |
Nazwa transakcji |
|
|
Stan transakcji
|
status | string |
Stan transakcji |
|
|
Identyfikator zewnętrzny
|
externalId | string |
Identyfikator zewnętrzny |
|
|
Identyfikator szablonu
|
templateId | string |
Identyfikator szablonu |
|
|
Identyfikatory szablonu pomocniczego
|
secondaryTemplateIds | array of string |
Identyfikatory szablonu pomocniczego |
|
|
Message
|
message | string |
Wiadomość e-mail dla wszystkich uczestników. |
|
|
Adres URL wywołania zwrotnego
|
url | string |
Adres URL wywołania zwrotnego |
|
|
Zdarzenia transakcji
|
transactionEvents | array of string |
Zdarzenia transakcji |
|
|
Zdarzenia uczestnika
|
participantEvents | array of string |
Zdarzenia uczestnika |
|
|
Sekwencja uczestnika
|
sequence | integer |
Kolejność |
|
|
Role
|
role | string |
Role |
|
|
Czy proces automatyczny?
|
autoProcess | boolean |
Czy proces automatyczny? |
|
|
Nazwa pola
|
fieldName | string |
Nazwa pola |
|
|
Wartość pola
|
value | string |
Wartość pola |
|
|
Name
|
name | string |
Nazwisko kandydata |
|
|
Adres e-mail
|
emailAddress | string |
Adres e-mail kandydata |
|
|
Message
|
message | string |
Message |
|
|
Język
|
language | string |
Język |
|
|
Kanały dostarczania
|
deliveryChannels | array of string |
Kanały dostarczania |
|
|
Niestandardowa treść wiadomości SMS
|
customSMSBody | string |
Niestandardowa treść wiadomości SMS |
|
|
Name
|
name | string |
Name |
|
|
Message
|
message | string |
Message |
|
|
Czy jest to wymagane?
|
required | boolean |
Czy jest to wymagane? |
|
|
Name
|
name | string |
Name |
|
|
Adres e-mail
|
emailAddress | string |
Adres e-mail |
|
|
Język
|
language | string |
Język |
|
|
Wartość pola
|
value | string |
Wartość pola |
|
|
Nazwa pola
|
fieldName | string |
Nazwa pola |
|
|
Code
|
code | string |
Code |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Identyfikator transakcji
|
data.transactionId | string |
Identyfikator transakcji |
Tworzenie użytkowników
Tworzenie użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail
|
emailAddress | string |
Adres e-mail |
|
|
Imię
|
firstName | string |
Imię |
|
|
Nazwisko
|
lastName | string |
Nazwisko |
|
|
Firma
|
company | string |
Firma |
|
|
Strefa czasowa
|
timezone | string |
Strefa czasowa |
|
|
Język
|
language | string |
Język |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Zwrot grzecznościowy
|
salutation | string |
Zwrot grzecznościowy |
|
|
Stanowisko
|
jobTitle | string |
Stanowisko |
|
|
Numer telefonu
|
phoneNumber | string |
Numer telefonu |
|
|
Kod kraju
|
phoneCountryCode | string |
Kod kraju |
|
|
Role
|
roles | array of string |
Role |
|
|
Czy ostateczna poczta jest wyłączona?
|
finalMailDisabled | boolean |
Czy ostateczna poczta jest wyłączona? |
|
|
Czy poczta przypomnienia jest wyłączona?
|
reminderMailDisabled | boolean |
Czy poczta przypomnienia jest wyłączona? |
|
|
Czy poczta nadawcy jest wyłączona?
|
senderMailDisabled | boolean |
Czy poczta nadawcy jest wyłączona? |
|
|
Czy użytkownik integracji jest użytkownikiem?
|
integrationUser | boolean |
Czy użytkownik integracji jest użytkownikiem? |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Identyfikator użytkownika
|
data.user_id | string |
Identyfikator użytkownika |
Usuń subskrypcję
Usuń subskrypcję
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator elementu webhook
|
webhookId | True | string |
Unikatowy identyfikator subskrypcji elementu webhook do usunięcia |
Wyświetlanie listy użytkowników
Wyświetlanie listy użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer strony
|
pageNo | True | integer | |
|
Liczba rekordów na stronie
|
perPageRecords | True | integer |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Łączna liczba rekordów
|
data.totalRecords | integer |
łączna liczba rekordów |
|
Łączna liczba stron
|
data.totalPages | integer |
Łączna liczba stron |
|
Na rekordy stron
|
data.perPageRecords | integer |
Na rekordy stron |
|
Numer strony
|
data.pageNo | integer |
Numer strony |
|
Rekordy
|
data.records | array of object |
Rekordy użytkowników |
|
Imię
|
data.records.firstName | string |
Imię |
|
Nazwisko
|
data.records.lastName | string |
Nazwisko |
|
Firma
|
data.records.company | string |
Firma |
|
Strefa czasowa
|
data.records.timezone | string |
Strefa czasowa |
|
Język
|
data.records.language | string |
Język |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Stanowisko
|
data.records.jobTitle | string |
Stanowisko |
|
Numer telefonu
|
data.records.phoneNumber | string |
Numer telefonu |
|
Kod kraju
|
data.records.phoneCountryCode | string |
Kod kraju |
|
Role
|
data.records.roles | array of string |
Role |
|
Czy ostateczna poczta jest wyłączona?
|
data.records.finalMailDisabled | boolean |
Czy ostateczna poczta jest wyłączona? |
|
Czy poczta przypomnienia jest wyłączona?
|
data.records.reminderMailDisabled | boolean |
Czy poczta przypomnienia jest wyłączona? |
|
Czy poczta nadawcy jest wyłączona?
|
data.records.senderMailDisabled | boolean |
Czy poczta nadawcy jest wyłączona? |
|
Czy użytkownik integracji jest użytkownikiem?
|
data.records.integrationUser | boolean |
Czy użytkownik integracji jest użytkownikiem? |
|
Zwrot grzecznościowy
|
data.records.salutation | string |
Zwrot grzecznościowy |
|
Jest aktywny
|
data.records.active | boolean |
Jest aktywny |
|
Id
|
data.records.id | string |
Id |
|
Adres e-mail
|
data.records.emailAddress | string |
Adres e-mail |
Wyzwalaczy
| Po zmianie stanu transakcji |
Rejestrowanie wywołania zwrotnego dla określonego zdarzenia transakcji |
Po zmianie stanu transakcji
Rejestrowanie wywołania zwrotnego dla określonego zdarzenia transakcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ zdarzenia
|
eventType | True | array |
Typ zdarzenia transakcji do zarejestrowania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
timestamp | integer |
Sygnatura czasowa |
|
Kod stanu
|
statusCode | integer |
Kod stanu |
|
Message
|
message | string |
Message |
|
Nazwa transakcji
|
data.name | string |
Nazwa transakcji |
|
Stan transakcji
|
data.status | string |
Stan transakcji |
|
Identyfikator transakcji
|
data.transactionId | string |
Identyfikator transakcji |
|
Message
|
data.mail.message | string |
Wiadomość e-mail dla wszystkich uczestników. |
|
Data ostatniej aktualizacji
|
data.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.createdDate | string |
Data utworzenia |
|
Identyfikator użytkownika
|
data.createdBy.id | string |
Utworzone przez identyfikator użytkownika |
|
Nazwa użytkownika
|
data.createdBy.username | string |
Utworzone przez nazwę użytkownika |
|
Adres e-mail
|
data.createdBy.emailAddress | string |
Utworzone przez adres e-mail |
|
Data wysłania
|
data.sentDate | string |
Data wysłania |
|
Identyfikator użytkownika
|
data.lastActionPerformedBy.userId | string |
Identyfikator użytkownika |
|
Nazwa użytkownika
|
data.lastActionPerformedBy.userName | string |
Nazwa użytkownika |
|
Adres e-mail
|
data.lastActionPerformedBy.emailAddress | string |
Adres e-mail |
|
Identyfikator kandydata
|
data.lastActionPerformedBy.candidateId | string |
Identyfikator kandydata |
|
Identyfikator uczestnika
|
data.lastActionPerformedBy.participantId | string |
Identyfikator uczestnika |
|
Wygasa w znaczniku czasu
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transakcja wygasa w znaczniku czasu |
|
Dni wygaśnięcia
|
data.expiryAndReminders.expiryDays | integer |
Dni wygaśnięcia |
|
Przypomnienie z dni przypomnienia
|
data.expiryAndReminders.remindFromReminderDays | integer |
Przypomnienie z dni przypomnienia |
|
Przypomnienie z czasu przypomnienia
|
data.expiryAndReminders.remindFromReminderTime | string |
Przypomnienie z czasu przypomnienia |
|
Częstotliwość przypomnienia
|
data.expiryAndReminders.reminderFrequency | integer |
Częstotliwość przypomnienia |
|
Uczestnicy
|
data.participants | array of object |
Uczestnicy |
|
Identyfikator uczestnika
|
data.participants.id | string |
Identyfikator uczestnika |
|
Stan uczestnika
|
data.participants.status | string |
Stan uczestnika |
|
Data ostatniej aktualizacji
|
data.participants.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.participants.createdDate | string |
Data utworzenia |
|
Sekwencja uczestnika
|
data.participants.sequence | integer |
Kolejność |
|
Role
|
data.participants.role | string |
Role |
|
Metoda podpisywania
|
data.participants.signingMethodDTO | array of string |
Szczegóły metody podpisywania |
|
Przesłane przez użytkownika
|
data.participants.submittedBys | array of object |
Przesłane przez użytkownika szczegóły |
|
Identyfikator użytkownika
|
data.participants.submittedBys.userId | string |
Przesłane przez identyfikator użytkownika |
|
Nazwa użytkownika
|
data.participants.submittedBys.userName | string |
Przesłane przez nazwę użytkownika |
|
Adres e-mail
|
data.participants.submittedBys.emailAddress | string |
Przesłane przez adres e-mail użytkownika |
|
Identyfikator kandydata
|
data.participants.submittedBys.candidateId | string |
Identyfikator kandydata |
|
Kandydatów
|
data.participants.candidates | array of object |
Kandydatów |
|
Identyfikator kandydata
|
data.participants.candidates.id | string |
Identyfikator kandydata |
|
Name
|
data.participants.candidates.name | string |
Nazwisko kandydata |
|
Adres e-mail
|
data.participants.candidates.emailAddress | string |
Adres e-mail kandydata |
|
Język
|
data.participants.candidates.language | string |
Język |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Akcja
|
data.participants.candidates.action | string |
Akcja |
|
Data akcji
|
data.participants.candidates.actionDate | string |
Data akcji |
|
Data utworzenia
|
data.participants.candidates.createdDate | string |
Data utworzenia |
|
Wartość trybu uwierzytelniania
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Wartość trybu uwierzytelniania |
|
szczegóły metody podpisywania
|
data.participants.candidates.signingMethodDTO | array of string |
szczegóły metody podpisywania |
|
Załączniki
|
data.participants.candidates.attachments | array of |
Załączniki |
|
Kanały dostarczania
|
data.participants.candidates.deliveryChannels | array of string |
Kanały dostarczania |
|
Pola formularza
|
data.participants.fields | array of object |
Pola formularza |
|
Id
|
data.participants.fields.id | string |
Id |
|
Data ostatniej aktualizacji
|
data.participants.fields.lastUpdatedDate | string |
Data ostatniej aktualizacji |
|
Data utworzenia
|
data.participants.fields.createdDate | string |
Data utworzenia |
|
Identyfikator pola
|
data.participants.fields.fieldId | string |
Identyfikator pola |
|
Brak strony
|
data.participants.fields.pageNo | integer |
Brak strony |
|
Identyfikator dokumentu
|
data.participants.fields.documentId | string |
Identyfikator dokumentu |
|
Szerokość pola
|
data.participants.fields.width | float |
Szerokość pola |
|
Wysokość pola
|
data.participants.fields.height | float |
Wysokość pola |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Wartość
|
data.participants.fields.value | string |
Wartość |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
Styl nazwy
|
data.participants.fields.nameStyle | string |
Styl nazwy |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Etykieta wyświetlana
|
data.participants.fields.displayLabel | string |
Etykieta wyświetlana |
|
Typ łącza
|
data.participants.fields.linkType | string |
Typ łącza |
|
Identyfikator radiowy
|
data.participants.fields.radioId | integer |
Identyfikator radiowy |
|
Identyfikator grupy radiowej
|
data.participants.fields.radioGroupId | string |
Identyfikator grupy radiowej |
|
Identyfikator pola wyboru
|
data.participants.fields.checkboxId | integer |
Identyfikator pola wyboru |
|
Nazwa pola
|
data.participants.fields.fieldName | string |
Nazwa pola |
|
Położenie X
|
data.participants.fields.xposition | float |
X położenie pola |
|
Położenie Y
|
data.participants.fields.yposition | float |
Położenie Y pola |
|
Czy jest to wymagane?
|
data.participants.fields.required | boolean |
Czy jest to wymagane pole? |
|
Czy jest tylko do odczytu?
|
data.participants.fields.readOnly | boolean |
Czy jest to pole tylko do odczytu? |
|
Obszar tekstu
|
data.participants.fields.textarea | boolean |
Obszar tekstu |
|
Pionowy
|
data.participants.fields.vertical | boolean |
Pionowy |
|
Górna dół
|
data.participants.fields.topBottom | boolean |
Górna dół |
|
Wartość domyślna
|
data.participants.fields.defaultValue | string |
Wartość domyślna |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Kolejność
|
data.participants.signatureBlock.format.sequence | integer |
Kolejność |
|
Czy jest to wymagane?
|
data.participants.signatureBlock.format.required | boolean |
Czy jest to wymagane? |
|
Default
|
data.participants.signatureBlock.default | boolean |
Default |
|
Włącz pełnomocnika
|
data.participants.enableDelegate | boolean |
Włącz pełnomocnika |
|
Proces automatyczny
|
data.participants.autoProcess | boolean |
Proces automatyczny |
|
Użytkownicy usługi CC
|
data.ccUsers | array of object |
Użytkownicy usługi CC |
|
Name
|
data.ccUsers.name | string |
Name |
|
Adres e-mail
|
data.ccUsers.emailAddress | string |
Adres e-mail |
|
Język
|
data.ccUsers.language | string |
Język |
|
Documents
|
data.documents | array of object |
Documents |
|
Identyfikator dokumentu
|
data.documents.id | string |
Identyfikator dokumentu |
|
Kolejność
|
data.documents.sequence | integer |
Kolejność |
|
Nazwa pliku
|
data.documents.fileName | string |
Nazwa pliku |
|
Liczba stron
|
data.documents.pageCount | integer |
Liczba stron |
|
Czy można usunąć?
|
data.documents.deletable | boolean |
Czy można usunąć? |
|
Jest prywatny
|
data.documents.private | boolean |
Jest prywatny |
|
Pola niestandardowe
|
data.customFields | array of object |
Pola niestandardowe |
|
Identyfikator pola niestandardowego
|
data.customFields.customFieldId | string |
Identyfikator pola niestandardowego |
|
Wartość pola
|
data.customFields.value | string |
Wartość pola |
|
Nazwa pola
|
data.customFields.fieldName | string |
Nazwa pola |
|
Typ pola
|
data.customFields.fieldType | string |
Typ pola |
|
Subskrypcje powiadomień
|
data.notificationSubscriptions | array of |
Subskrypcje powiadomień |
|
tags
|
data.tags | array of |
tags |
|
Dodatkowe dokumenty
|
data.additionalDocuments | array of object |
Dodatkowe dokumenty |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nazwa pliku
|
data.additionalDocuments.fileName | string |
Nazwa pliku |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
Identyfikator kandydata
|
data.additionalDocuments.candidateId | string |
Identyfikator kandydata |
|
Oddzielne umowy
|
data.separateAgreements | boolean |
Oddzielne umowy |
Definicje
plik
Jest to podstawowy typ danych "file".