Lex Power Sign (wersja zapoznawcza)
Lex Persona jest europejskim dostawcą usług zaufania oferującym szereg rozwiązań do obsługi podpisów elektronicznych. W przypadku lex Enterprise masz dostęp do wszystkich poziomów podpisów eIDAS wraz z dużą liczbą metod uwierzytelniania podpisów. Twoje książki podpisów są osadzone w cyfrowych przepływach pracy. Automatyzowanie połączeń między firmą Lex Enterprise i wszystkimi narzędziami w celu wyeliminowania powtarzających się zadań, zwiększenia wydajności i przyspieszenia działania firmy.
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 lex Persona |
| adres URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Metadane łącznika | |
|---|---|
| Publisher | Lex Persona |
| Witryna internetowa | https://www.lex-persona.com |
| Zasady ochrony prywatności | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategorie | AI; Witryna internetowa |
Lex Persona jest europejskim dostawcą usług zaufania oferującym szereg rozwiązań do obsługi podpisów elektronicznych. Za pomocą tego łącznika można łatwo dodać możliwość podpisu elektronicznego do aplikacji firmy Microsoft (PowerApp, aplikacji internetowej opartej na platformie .NET, dynamics...) i środowiska (Outlook, Sharepoint, Teams...). Łącznik jest wspierany przez naszego menedżera przepływów pracy lex Enterprise. Można tworzyć przepływy pracy podpisu elektronowego składające się z różnych typów kroków, które mogą być wykonywane w sekwencji i/lub równolegle. Łącznik obsługuje wszystkie poziomy podpisów eIDAS i oferuje szeroką gamę metod uwierzytelniania podpisów (OTP, SSO, France Connect, Identité Numérique La Poste, tokeny sprzętowe...)
Wymagania wstępne
Aby kontynuować, musisz mieć następujące elementy:
- Subskrypcja Lex Enterprise. Testowanie przy użyciu planu wersji próbnej
Wymagania dotyczące środowiska są następujące:
- Plan usługi Microsoft Power Apps lub Power Automate z funkcją łącznika niestandardowego
- Narzędzia interfejsu wiersza polecenia platformy Power Platform
Jak uzyskać poświadczenia
Skontaktuj się z naszymi przedstawicielami handlowymi, commercial@lex-persona.com aby uzyskać subskrypcję Lex Enteprise lub konto w naszych systemach próbnych.
Połącz się z witryną Lex Enterprise Portal przy użyciu konta i wygeneruj klucz interfejsu API.
Wprowadzenie do łącznika
Najpierw utwórz połączenie dla łącznika. Ustaw metodę uwierzytelniania na klucz interfejsu API, podaj klucz interfejsu API ("Bearer act_XXXXXXX") i określ, że klucz interfejsu API musi zostać umieszczony w nagłówku Autrorization wywołań interfejsu API.
Kroki tworzenia prostego przepływu pracy podpisu są następujące:
- bezpośrednio po ściągniku pobierz połączony identyfikator użytkownika Lex Enterprise (ten identyfikator jest wymagany do utworzenia przepływu pracy) za pomocą akcji Pobierz mnie
- strony zgody wyszukiwania ze stronami zgody wyszukiwania action_. Możesz użyć parametru tekstowego , aby wyszukać strony zgody według nazwy (strony zgody definiują poziom podpisu i są wstępnie skonfigurowane w środowisku Lex Enterprise)
- utwórz przepływ pracy podpisu za pomocą akcji Utwórz przepływ pracy . W tym kroku należy podać informacje osoby podpisujących.
- wyszukiwanie profilów podpisów za pomocą akcji Wyszukaj profile podpisów. Możesz użyć parametru tekstowego , aby wyszukać profile podpisów według nazwy (profile podpisów kontrolują niektóre aspekty zachowania stron zgody. Wymuś, aby podpisujący przewijał się do dołu dokumentu przed podpisaniem na przykład)
- Pobieranie dokumentu ze środowiska (Sharepoint, Outlook, OneDrive...)
- dodaj dokument do przepływu pracy za pomocą akcji Utwórz część , ustawiając parametr createDocument na true
- uruchom przepływ pracy z akcją Aktualizuj przepływ pracy , ustawiając stan przepływu pracy na rozpoczęty
Uwaga: Łącznik jest domyślnie sparowany z naszym serwerem próbnym. Jeśli chcesz sparować łącznik z własną dzierżawą, musisz zmienić adres URL hosta w definicji zabezpieczeń łącznika lub w pliku apiDefinitions.json:
- "host": "yourtenant.lexpersona.com",
Znajomość problemów i ograniczeń
Akcja Utwórz dokument akceptuje listę części dokumentu int jej ładunku. Jeśli jednak podasz wiele części, uwzględniony zostanie tylko pierwszy z nich (jest to spowodowane usterką w naszym interfejsie API. Zostanie on naprawiony w następnej wersji łącznika).
W związku z tym, jeśli chcesz dodać wiele dokumentów do przepływu pracy, należy wykonać wywołanie metody Create Part z parametrem createDocument ustawionym na wartość true dla każdego dokumentu.
Typowe błędy i środki zaradcze
W przypadku niepowodzenia wywołania interfejsu API odpowiedź wywołania interfejsu API zawiera kompleksowy komunikat o błędzie wyświetlany w historii uruchamiania łącznika. Komunikat zawiera również identyfikator dziennika, dzięki czemu jeśli potrzebujesz więcej informacji na temat błędu, możesz nawiązać połączenie z portalem Lex Enteprise i skonsultować się z plikiem dziennika serwera. Alternativley, można skonfigurować żądanie Postman, aby przeszukać nasze dzienniki serwerów (plase zapoznaj się z dokumentacją: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Bardziej typowe kody błędów HTTP zwracane przez nasz interfejs API są następujące:
- Błąd 400 — nieprawidłowe żądanie. W twoim żądaniu jest coś złego. Zapoznaj się z dziennikiem, aby znaleźć informacje o przyczynie błędu
- Błąd 401 — Brak autoryzacji. Yo nie ma praw dostępu do wykonania tej operacji. Sprawdzanie praw dostępu użytkownika Lex Persona
- Błąd 403 — Zabronione. Klucz interfejsu API jest invlaid lub wyłączony
- Błąd 404 — Nie znaleziono. W adresie URL żądania występuje błąd
Możesz również sprawdzić naszą dokumentację, aby uzyskać więcej informacji na temat możliwych kodów błędów wywołania interfejsu API (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
Często zadawane pytania
Jakie są formaty dokumentów obsługiwane przez łącznik
Dokumenty, które można wysłać do podpisu, mogą mieć formaty pdf, docx, pptx i xlsx. W razie potrzeby łącznik przekonwertuje dokumenty na plik PDF, a podpisy będą miały format PAdES.
Istnieje również możliwość podpisania dokumentów XML. W takim przypadku nie zostanie zastosowana żadna konwersja, a podpisy będą miały format XAdES.
Można również przekazać pliki zip. Łącznik rozpakowuje archiwum i doda każdy dokument do przepływu pracy.
Możesz również dodawać załączniki do przepływów pracy podpisów. Załącznik nie jest podpisany i może mieć dowolny format.
Czy dokument może zawierać wiele osób podpisujących
Tak. Liczba osób podpisujących dokument jest nieograniczona.
Czy można podpisywać wiele dokumentów jednocześnie
Tak. Możesz dodać wiele dokumentów do przepływu pracy, a wszystkie dokumenty zostaną podpisane jednocześnie. Należy jednak pamiętać, że w tym przypadku zestaw dokumentów będzie legalnie powiązany i że system przedstawi unikatowy plik dowodowy.
Można również utworzyć element workgple workglows coantaining tego samego sygnatariusza. W momencie podpisania lista dokumentów zostanie wyświetlona użytkownikowi podpisowi, a sygnatariusz będzie miał możliwość wybrania dokumentów, które podpisuje. W takim przypadku dokumenty będą legalnie niezależne, a plik dowodowy zostanie utworzony dla każdego dokumentu.
Czy można podpisać dokument w trybie offline
Nie. Aby uzyskać dostęp do stron zgody, wymagane jest połączenie intenet.
Czy można wysyłać automatyczne remidery podpisów do osób podpisujących
Tak. Możesz skonfigurować okres przypomnienia i maksymalną liczbę przypomnień do wysłania.
Czy można zmodyfikować już uruchomiony przepływ pracy podpisu
Tak. Przed dowolnym podpisem można zmodyfikować dowolne elementy w przepływie pracy. Po pierwszym podpisie nie można modyfikować dokumentów, ale nadal można modyfikować kroki przepływu pracy.
Jaki jest czas trwania ważności haseł jednorazowych
Czas trwania ważności hasła jednorazowego wynosi dwie minuty (liczba jest wyświetlana na stronach zgody).
Czy można zweryfikować ważność podpisu elektronicznego
Możesz użyć okienka Podpisy programu Adobe Acrobat, aby sprawdzić poprawność podpisów zawartych w dokumencie pdf. Alternatywnie możesz użyć zaufanej usługi internetowej weryfikacji podpisu (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation na przykład)
Co to są warunki przechowywania dokumentów Lex Persona
Domyślnie dokumenty są przechowywane w plikach dowodowych na naszych serwerach. Tou może wyszukiwać i pobierać dokumenty w dowolnym momencie. Jeśli jest to wymagane, możemy jednak priodicznie usunąć dokumenty z naszych serwerów.
Czy lex Persona przechowuje tokeny sygnatur czasowych
Nie. Nie przechowujemy tokenów sygnatur czasowych. W razie potrzeby możesz ekstracxt te tokeny z podpisanych dokumentów.
Czy istnieje okres wycofania podpisanego dokumentu
Tak. Wypłata zależy od warunków prawnych, które mają zastosowanie do dokumentu.
Czy można anulować przepływ pracy podpisu
Tak. Użytkownik authoriezd może w dowolnym momencie anulować uruchomiony przepływ pracy podpisu. Nie zostanie utworzony plik eksmitencji i jeśli dokument został już podpisany przez jednego lub wielu sygnatariuszy, sgnatures zostaną unieważnione.
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 |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie dokumentu |
Aktualizowanie dokumentu |
| Aktualizowanie kontaktu |
Modyfikowanie istniejących informacji kontaktowych |
| Aktualizowanie profilu podpisu |
Aktualizowanie profilu podpisu |
| Aktualizowanie przepływu pracy |
Aktualizowanie przepływu pracy |
| Aktualizowanie układu metadanych |
Aktualizowanie układu metadanych |
| Pobieranie adresu URL strony constent |
Tworzenie i pobieranie adresu URL strony zgody dla adresata |
| Pobieranie dokumentu |
Pobieranie dokumentu |
| Pobieranie dokumentów przepływu pracy |
Pobieranie dokumentów przepływu pracy |
| Pobieranie kontaktu |
Pobieranie informacji kontaktowych z identyfikatora kontaktu |
| Pobieranie mapowania metadanych |
Pobieranie mapowania metadanych określonej dzierżawy |
| Pobieranie mnie |
Pobieranie identyfikatora połączonego użytkownika |
| Pobieranie pliku dowodów |
Pobieranie pliku dowodów przepływu pracy |
| Pobieranie profilu podpisu |
Pobieranie profilu podpisu |
| Pobieranie przepływu pracy |
Pobieranie przepływu pracy z identyfikatora przepływu pracy |
| Pobieranie strony zgody |
Pobieranie informacji o stronie zgody z identyfikatora strony zgody |
| Pobieranie układu metadanych |
Pobieranie układu przepływu pracy |
| Tworzenie części |
Tworzenie części dokumentu |
| Tworzenie dokumentu |
Tworzenie dokumentu na podstawie wcześniej utworzonych części |
| Tworzenie profilu podpisu |
Tworzenie profilu podpisu |
| Tworzenie przepływu pracy |
Tworzenie przepływu pracy |
| Tworzenie układu metadanych |
Tworzenie układu metadanych |
| Usuwanie dokumentu |
Usuwanie dokumentu |
| Usuwanie kontaktu |
Usuwanie kontaktu z listy contects bieżącego użytkownika |
| Usuwanie przepływu pracy |
Usuwanie przepływu pracy |
| Utwórz kontakt |
Dodawanie kontaktu do listy kontaktów bieżącego użytkownika |
| Wyszukaj kontakty |
Wyszukaj kontakty |
| Wyszukaj profile podpisów |
Wyszukaj profile podpisów |
| Wyszukaj przepływy pracy |
Wyszukaj przepływy pracy |
| Wyszukaj układy metadanych |
Układy przepływu pracy wyszukiwania |
| Wyszukiwanie dokumentów |
Wyszukiwanie dokumentów |
| Wyszukiwanie stron zgody |
Wyszukiwanie stron zgody |
Aktualizowanie dokumentu
Aktualizowanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
signatureProfileId
|
signatureProfileId | string |
Profil podpisu do aply do tego dokumentu |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Zwraca
- Body
- document
Aktualizowanie kontaktu
Modyfikowanie istniejących informacji kontaktowych
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contactId | True | string |
Identyfikator kontaktu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Adres e-mail kontaktu
|
string |
Adres e-mail kontaktu |
||
|
Numer telefonu kontaktu
|
phoneNumber | string |
Numer telefonu kontaktu |
|
|
Imię kontaktu
|
firstName | string |
Imię kontaktu |
|
|
Nazwisko kontaktu
|
lastName | string |
Nazwisko kontaktu |
|
|
Kraj kontaktu
|
country | string |
Kraj kontaktu |
Zwraca
- Body
- contact
Aktualizowanie profilu podpisu
Aktualizowanie profilu podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator profilu podpisu
|
spId | True | string |
Identyfikator profilu podpisu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Jest wartością domyślną
|
isDefault | string |
Sprawia, że ten profil podpisu jest domyślnym profilem |
|
|
Jest wyłączona
|
isDisabled | string |
Wyłącz ten profil podpisu |
|
|
Name
|
name | string |
Nazwa profilu podpisu |
|
|
Typ podpisu
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,ebis |
|
|
Wymuś przewinięcie do dołu dokumentu
|
forceScrollDocument | boolean |
Wymuś przewinięcie znaku w dolnej części dokumentu |
|
|
Widoczny tryb podpisu
|
pdfVisibleSignatureMode | string |
Widoczny tryb podpisu (dozwolony, wyłączony, noImage) |
|
|
Tekst podpisu
|
pdfSignatureImageText | string |
Tekst wyświetlany w podkładkach podpisów |
|
|
Kolor tekstu podpisu
|
pdfSignatureImageTextColor | string |
Kolor tekstu wyświetlanego w okienkach singatures |
|
|
Rozmiar tekstu podpisu
|
pdfSignatureImageTextSize | number |
Rozmiar tekstu wyświetlanego w okienkach singatures |
Zwraca
- Body
- signatureProfile
Aktualizowanie przepływu pracy
Aktualizowanie przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy do zaktualizowania |
|
Typ zawartości
|
Content-Type | string |
Typ zawartości |
|
|
Identyfikator użytkownika
|
userId | string |
Identyfikator właściciela przepływu pracy |
|
|
Name
|
name | string |
Nazwa przepływu pracy |
|
|
Description
|
description | string |
Opis przepływu pracy |
|
|
id
|
id | string |
identyfikator kroku |
|
|
stepType
|
stepType | string |
podpis lub zatwierdzenie |
|
|
consentPageId
|
consentPageId | True | string |
Identyfikator strony zgody (poziom podpisu) skojarzonej z tym adresatem |
|
e-mail
|
True | string |
adres e-mail adresata |
|
|
userId
|
userId | string |
odwoływania się do użytkownika LE zamiast tworzenia adresata na bieżąco |
|
|
numer telefonu
|
phoneNumber | string |
numer telefonu komórkowego reicpienta |
|
|
imię
|
firstName | string |
imię adresata |
|
|
nazwisko
|
lastName | string |
nazwisko adresata |
|
|
country
|
country | string |
kod kraju odbiorcy |
|
|
preferredLocale
|
preferredLocale | string |
kod ustawień regionalnych adresata |
|
|
organizationId
|
organizationId | string |
Identyfikator organizacji LE odbiorcy |
|
|
requiredRecipients
|
requiredRecipients | number |
minimalna liczba osób podpisujących, którzy muszą podpisać, aby wykonać następny krok |
|
|
validityPeriod
|
validityPeriod | number |
czas trwania ważności kroku |
|
|
inviteperiod
|
inviteperiod | number |
częstotliwość przypomnień dotyczących podpisów |
|
|
maxInvites
|
maxInvites | number |
maksymalna liczba przypomnień dotyczących podpisów |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
steruje dostarczaniem podpisanego dokumentu do osób podpisujących |
|
|
allowComments
|
allowComments | boolean |
zezwala/zabrania komentarzy w tym kroku |
|
|
hideAttachments
|
hideAttachments | boolean |
steruje wyświetlaniem załączników do osób podpisujących |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
steruje wyświetlaniem innych osób podpisujących do osoby podpisujących |
|
|
Zdarzenia z powiadomieniem
|
notifiedEvents | array of string |
Powiadomienia o zdarzeniach przepływu pracy |
|
|
userId
|
userId | string |
Identyfikator użytkownika obserwatora |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Zdarzenia przepływu pracy, które będą powiadamiane o tym obserwatorze |
|
|
e-mail
|
string |
|
||
|
Stan przepływu pracy
|
workflowStatus | string |
Bieżący stan przepływu pracy |
|
|
data1
|
data1 | string |
pierwsze metadane |
|
|
data2
|
data2 | string |
drugie metadane |
|
|
data3
|
data3 | string |
trzecie metadane |
|
|
data4
|
data4 | string |
czwarte metadane |
|
|
data5
|
data5 | string |
piąte metadane |
|
|
data6
|
data6 | string |
szóste metadane |
|
|
data7
|
data7 | string |
siódme metadane |
|
|
data8
|
data8 | string |
metadane heighth |
Zwraca
- Body
- workflow
Aktualizowanie układu metadanych
Aktualizowanie układu metadanych
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dzierżawcy
|
layoutId | True | string |
Identyfikator układu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Name
|
name | True | string |
Nazwa układu |
|
Jest wyłączona
|
isDisabled | boolean |
Jeśli zostanie ustawiona wartość true, układ zostanie wyłączony |
|
|
szczelina
|
slot | string |
Element metadanych (dane1 do data8) |
|
|
domyślny
|
default | string |
Wartość domyślna metadanych w tym układzie |
|
|
optional
|
optional | boolean |
Jeśli wartość true, podanie wartości nie jest obowiązkowe |
|
|
readonly
|
readonly | boolean |
Wether wartość może być przesłonięć |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Jeśli ustawiono wartość true, wartość będzie nadal występować w przepływach pracy |
Zwraca
Układ metadanych
- Body
- layout
Pobieranie adresu URL strony constent
Tworzenie i pobieranie adresu URL strony zgody dla adresata
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy |
|
Adres e-mail adresata
|
recipientEmail | string |
Adres e-mail zainteresowanego adresata |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres URL strony zgody dla danego adresata
|
inviteUrl | string |
Adres URL strony zgody dla danego adresata |
Pobieranie dokumentu
Pobieranie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
- Body
- document
Pobieranie dokumentów przepływu pracy
Pobieranie dokumentów przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy |
Zwraca
- response
- binary
Pobieranie kontaktu
Pobieranie informacji kontaktowych z identyfikatora kontaktu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contactId | True | string |
Identyfikator kontaktu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
Zwraca
- Body
- contact
Pobieranie mapowania metadanych
Pobieranie mapowania metadanych określonej dzierżawy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dzierżawcy
|
tenantId | True | string |
Identyfikator dzierżawy |
Zwraca
- Body
- dataMapping
Pobieranie mnie
Pobieranie pliku dowodów
Pobieranie pliku dowodów przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy |
|
Akceptuj
|
Accept | True | string |
Akceptuj |
Zwraca
- response
- binary
Pobieranie profilu podpisu
Pobieranie profilu podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator profilu podpisu
|
spId | True | string |
Identyfikator profilu podpisu |
Zwraca
- Body
- signatureProfile
Pobieranie przepływu pracy
Pobieranie przepływu pracy z identyfikatora przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy |
Zwraca
- Body
- workflow
Pobieranie strony zgody
Pobieranie informacji o stronie zgody z identyfikatora strony zgody
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator strony zgody
|
cpId | True | string |
Identyfikator strony zgody |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
Zwraca
- Body
- consentPage
Pobieranie układu metadanych
Pobieranie układu przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator układu
|
layoutId | True | string |
Identyfikator układu |
Zwraca
Układ metadanych
- Body
- layout
Tworzenie części
Tworzenie części dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator danego przepływu pracy |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Dyspozycja cotent
|
Content-Disposition | True | string |
Content-Dispotion |
|
Tworzenie dokumentu
|
createDocuments | string |
Utwórz dokument z tej części |
|
|
Ignoruj załączniki
|
ignoreAttachments | string |
Załączniki zostaną zignorowane |
|
|
Identyfikator profilu podpisu
|
signatureProfileId | string |
Część uważana za załącznik w przypadku pominięcia |
|
|
Rozpiąć
|
unzip | string |
Rozpakuj pliki |
|
|
Plik PDF do formatu PDFA
|
pdf2pdfa | string |
Konwertowanie pliku PDF na plik PDF/A |
|
|
Dokument
|
document | True | binary |
Przekazane dane pliku |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokumentów
|
documents | array of document |
Utworzone dokumenty |
|
ignorowaneWyłączenia
|
ignoredAttachments | integer |
ignorowaneWyłączenia |
|
Części
|
parts | array of part |
Części |
Tworzenie dokumentu
Tworzenie dokumentu na podstawie wcześniej utworzonych części
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator danego przepływu pracy |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
typ treści
|
contentType | string |
typ treści |
|
|
filename
|
filename | string |
filename |
|
|
skrót
|
hash | string |
skrót |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Profil podpisu dla tego dokumentu |
Zwraca
- Body
- document
Tworzenie profilu podpisu
Tworzenie profilu podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dzierżawcy
|
tenantId | True | string |
Identyfikator dzierżawy |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Jest wartością domyślną
|
isDefault | True | string |
Sprawia, że ten profil podpisu jest domyślnym profilem |
|
Jest wyłączona
|
isDisabled | string |
Wyłącz ten profil podpisu |
|
|
Name
|
name | True | string |
Nazwa profilu podpisu |
|
Typ dokumentu
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, other |
|
Typ podpisu
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,ebis |
|
Wymuś przewinięcie do dołu dokumentu
|
forceScrollDocument | True | boolean |
Wymuś przewinięcie znaku w dolnej części dokumentu |
|
Widoczny tryb podpisu
|
pdfVisibleSignatureMode | string |
Widoczny tryb podpisu (dozwolony, wyłączony, noImage) |
|
|
Tekst podpisu
|
pdfSignatureImageText | string |
Tekst wyświetlany w podkładkach podpisów |
|
|
Kolor tekstu podpisu
|
pdfSignatureImageTextColor | string |
Kolor tekstu wyświetlanego w okienkach singatures |
|
|
Rozmiar tekstu podpisu
|
pdfSignatureImageTextSize | number |
Rozmiar tekstu wyświetlanego w okienkach singatures |
Zwraca
- Body
- signatureProfile
Tworzenie przepływu pracy
Tworzenie przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator użytkownika właściciela przepływu pracy |
|
Typ zawartości
|
Content-Type | string |
Typ zawartości |
|
|
Name
|
name | True | string |
Nazwa przepływu pracy |
|
Description
|
description | string |
Opis przepływu pracy |
|
|
id
|
id | string |
identyfikator kroku |
|
|
stepType
|
stepType | string |
podpis lub zatwierdzenie |
|
|
consentPageId
|
consentPageId | True | string |
Identyfikator strony zgody (poziom podpisu) skojarzonej z tym adresatem |
|
e-mail
|
True | string |
adres e-mail adresata |
|
|
userId
|
userId | string |
odwoływania się do użytkownika LE zamiast tworzenia adresata na bieżąco |
|
|
numer telefonu
|
phoneNumber | string |
numer telefonu komórkowego reicpienta |
|
|
imię
|
firstName | string |
imię adresata |
|
|
nazwisko
|
lastName | string |
nazwisko adresata |
|
|
country
|
country | string |
kod kraju odbiorcy |
|
|
preferredLocale
|
preferredLocale | string |
kod ustawień regionalnych adresata |
|
|
organizationId
|
organizationId | string |
Identyfikator organizacji LE odbiorcy |
|
|
requiredRecipients
|
requiredRecipients | number |
minimalna liczba osób podpisujących, którzy muszą podpisać, aby wykonać następny krok |
|
|
validityPeriod
|
validityPeriod | number |
czas trwania ważności kroku |
|
|
inviteperiod
|
inviteperiod | number |
częstotliwość przypomnień dotyczących podpisów |
|
|
maxInvites
|
maxInvites | number |
maksymalna liczba przypomnień dotyczących podpisów |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
steruje dostarczaniem podpisanego dokumentu do osób podpisujących |
|
|
allowComments
|
allowComments | boolean |
zezwala/zabrania komentarzy w tym kroku |
|
|
hideAttachments
|
hideAttachments | boolean |
steruje wyświetlaniem załączników do osób podpisujących |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
steruje wyświetlaniem innych osób podpisujących do osoby podpisujących |
|
|
Zdarzenia z powiadomieniem
|
notifiedEvents | array of string |
Powiadomienia o zdarzeniach przepływu pracy |
|
|
userId
|
userId | string |
Identyfikator użytkownika obserwatora |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Zdarzenia przepływu pracy, które będą powiadamiane o tym obserwatorze |
|
|
e-mail
|
string |
Wiadomość e-mail obserwatora |
||
|
Identyfikator szablonu
|
templateId | string |
Identyfikator szablonu, z którego pochodzi przepływ pracy |
|
|
Identyfikator układu
|
layoutId | string |
Układ metadanych używany przez element roboczy |
|
|
data1
|
data1 | string |
Pierwsze metadane |
|
|
data2
|
data2 | string |
Drugie metadane |
|
|
data3
|
data3 | string |
Trzecie metadane |
|
|
data4
|
data4 | string |
Czwarte metadane |
|
|
data5
|
data5 | string |
Piąte metadane |
|
|
data6
|
data6 | string |
Szóste metadane |
|
|
data7
|
data7 | string |
Siódme metadane |
|
|
data8
|
data8 | string |
Metadane heighth |
Zwraca
- Body
- workflow
Tworzenie układu metadanych
Tworzenie układu metadanych
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dzierżawcy
|
tenantId | True | string |
Identyfikator układu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Name
|
name | True | string |
Nazwa układu |
|
Jest wyłączona
|
isDisabled | boolean |
Jeśli zostanie ustawiona wartość true, układ zostanie wyłączony |
|
|
szczelina
|
slot | string |
Element metadanych (dane1 do data8) |
|
|
domyślny
|
default | string |
Wartość domyślna metadanych w tym układzie |
|
|
optional
|
optional | boolean |
Jeśli wartość true, podanie wartości nie jest obowiązkowe |
|
|
readonly
|
readonly | boolean |
Wether wartość może być przesłonięć |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Jeśli ustawiono wartość true, wartość będzie nadal występować w przepływach pracy |
Zwraca
Układ metadanych
- Body
- layout
Usuwanie dokumentu
Usuwanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
- Body
- document
Usuwanie kontaktu
Usuwanie kontaktu z listy contects bieżącego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contactId | True | string |
Identyfikator kontaktu |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
Zwraca
- Body
- contact
Usuwanie przepływu pracy
Usuwanie przepływu pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przepływu pracy
|
workflowId | True | string |
Identyfikator przepływu pracy do usunięcia |
Zwraca
- Body
- workflow
Utwórz kontakt
Dodawanie kontaktu do listy kontaktów bieżącego użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Użytkownik, do którego należy kontakt |
|
Typ zawartości
|
Content-Type | True | string |
Typ zawartości |
|
Kontaktowy adres e-mail
|
True | string |
Kontaktowy adres e-mail |
|
|
Numer telefonu contatct
|
phoneNumber | string |
numer telefonu |
|
|
Imię i nazwisko kontaktu
|
firstName | True | string |
imię |
|
Nazwisko kontaktu
|
lastName | True | string |
nazwisko |
|
Kraj kontaktu
|
country | string |
country |
Zwraca
- Body
- contact
Wyszukaj kontakty
Wyszukaj kontakty
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
text | string |
Wyszukiwanie według tekstu |
|
|
Wyszukaj wiadomość e-mail
|
items.email | string |
Wyszukiwanie według poczty e-mail |
|
|
Wyszukaj numer telefonu
|
items.phoneNumber | string |
Wyszukaj według numeru telefonu |
|
|
Wyszukaj imię
|
items.fisrtName | string |
Wyszukaj według imienia |
|
|
Wyszukaj nazwisko
|
items.lastName | string |
Wyszukaj według nazwiska |
|
|
Wyszukaj kraj
|
items.country | string |
Wyszukiwanie według kraju |
|
|
Elementy na stronę
|
itemsPerPage | number |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | number |
Indeks zwróconej strony |
Zwraca
- Body
- contacts
Wyszukaj profile podpisów
Wyszukaj profile podpisów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
text | string |
Tekst wyszukiwania |
|
|
Domyślne wyszukiwanie
|
items.isDefault | string |
Wyszukiwanie domyślnych profilów podpisów |
|
|
Wyszukiwanie jest wyłączone
|
items.isDisabled | string |
Wyszukiwanie wyłączonych profilów podpisów |
|
|
Nazwa wyszukiwania
|
items.name | string |
Wyszukiwanie według nazwy profilu podpisu |
|
|
Wyszukaj dokument. wpisz
|
items.documentType | string |
Wyszukiwanie według typu dokumentu |
|
|
Typ podpisu wyszukiwania
|
items.signatureType | string |
Wyszukiwanie według typu podpisu |
|
|
Data utworzenia wyszukiwania
|
items.created | string |
Wyszukiwanie według daty utworzenia |
|
|
Data aktualizacji wyszukiwania
|
items.updated | string |
Wyszukiwanie według daty ostatniej aktualizacji |
|
|
Sortuj według
|
sortBy | string |
Pole używane do sortowania wyników wyszukiwania |
|
|
Kolejność sortowania
|
sortOrder | string |
Kierunek sortowania |
|
|
Elementy na stronę
|
itemsPerPage | string |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | string |
Indeks zwróconej strony |
Zwraca
- Body
- signatureProfiles
Wyszukaj przepływy pracy
Wyszukaj przepływy pracy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Akceptuj
|
Accept | string |
Akceptuj |
|
|
Tekst wyszukiwania
|
text | string |
Tekst wyszukiwania |
|
|
Układ metadanych wyszukiwania
|
items.layoutId | string |
Wyszukiwanie według układu metadanych |
|
|
Szablon wyszukiwania
|
items.templateId | string |
Wyszukiwanie według szablonu przepływu pracy |
|
|
Grupa wyszukiwania
|
items.groupId | string |
Wyszukiwanie według grupy użytkowników |
|
|
Wyszukaj użytkownika
|
items.userId | string |
Wyszukiwanie według właściciela |
|
|
Wyszukaj wiadomość e-mail
|
items.email | string |
Wyszukiwanie według adresu e-mail właściciela |
|
|
Wyszukaj imię
|
items.firstname | string |
Wyszukaj według imienia właściciela |
|
|
Wyszukaj nazwisko
|
items.lastname | string |
Wyszukaj według nazwiska właściciela |
|
|
Stan wyszukiwania
|
items.workflowStatus | string |
Wyszukiwanie według stanu przepływu pracy |
|
|
Wyszukaj metadane 1
|
items.data1 | string |
Wyszukiwanie według wartości metadanych 1 |
|
|
Wyszukaj metadane 2
|
items.data2 | string |
Wyszukiwanie według wartości metadanych 2 |
|
|
Wyszukaj metadane 3
|
items.data3 | string |
Wyszukiwanie według wartości metadanych 3 |
|
|
Wyszukiwanie metadanych 4
|
items.data4 | string |
Wyszukiwanie według wartości metadanych 4 |
|
|
Wyszukaj metadane 5
|
items.data5 | string |
Wyszukiwanie według wartości metadanych 5 |
|
|
Wyszukaj metadane 6
|
items.data6 | string |
Wyszukiwanie według wartości metadanych 6 |
|
|
Wyszukiwanie metadanych 7
|
items.data7 | string |
Wyszukiwanie według wartości metadanych 7 |
|
|
Wyszukiwanie metadanych 8
|
items.data8 | string |
Wyszukiwanie według wartości metadanych 8 |
|
|
Data utworzenia wyszukiwania
|
items.created | string |
Wyszukiwanie według daty utworzenia |
|
|
Data aktualizacji wyszukiwania
|
items.updated | string |
Wyszukiwanie według daty ostatniej aktualizacji |
|
|
Data rozpoczęcia wyszukiwania
|
items.started | string |
Wyszukiwanie według daty rozpoczęcia |
|
|
Sortuj według
|
sortBy | string |
Pole używane do sortowania wyników wyszukiwania |
|
|
Kolejność sortowania
|
sortOrder | string |
Kierunek sortowania |
|
|
Elementy na stronę
|
itemsPerPage | string |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | string |
Indeks zwróconej strony |
Zwraca
- Body
- workflows
Wyszukaj układy metadanych
Układy przepływu pracy wyszukiwania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
text | string |
Tekst wyszukiwania |
|
|
Wyszukiwanie jest wyłączone
|
items.isDisabled | string |
Wyszukiwanie układów wyłączonych |
|
|
Nazwa wyszukiwania
|
items.name | string |
Wyszukiwanie według nazwy układu |
|
|
Wyszukaj metadane
|
items.dataConfigurations.slot | string |
Wyszukiwanie według obecności metadanych |
|
|
Data utworzenia wyszukiwania
|
items.created | string |
Wyszukiwanie według daty utworzenia |
|
|
Data aktualizacji wyszukiwania
|
items.updated | string |
Wyszukiwanie według daty ostatniej aktualizacji |
|
|
Sortuj według
|
sortBy | string |
Pole używane do sortowania wyników wyszukiwania |
|
|
Kolejność sortowania
|
sortOrder | string |
Kierunek sortowania |
|
|
Elementy na stronę
|
itemsPerPage | string |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | string |
Indeks zwróconej strony |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | layouts |
Wyszukiwanie dokumentów
Wyszukiwanie dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
text | string |
Tekst wyszukiwania |
|
|
Układ metadanych wyszukiwania
|
items.layoutId | string |
Wyszukiwanie według układu metadanych |
|
|
Grupa wyszukiwania
|
items.groupId | string |
Wyszukiwanie według grupy użytkowników |
|
|
Wyszukaj użytkownika
|
items.userId | string |
Wyszukiwanie według właściciela |
|
|
Identyfikator przepływu pracy wyszukiwania
|
items.workflowId | string |
Wyszukiwanie według identyfikatora przepływu pracy |
|
|
Nazwa przepływu pracy wyszukiwania
|
items.workflowName | string |
Wyszukiwanie według nazwy przepływu pracy |
|
|
Wyszukaj metadane 1
|
items.data1 | string |
Wyszukiwanie według wartości metadanych 1 |
|
|
Wyszukaj metadane 2
|
items.data2 | string |
Wyszukiwanie według wartości metadanych 2 |
|
|
Wyszukaj metadane 3
|
items.data3 | string |
Wyszukiwanie według wartości metadanych 3 |
|
|
Wyszukiwanie metadanych 4
|
items.data4 | string |
Wyszukiwanie według wartości metadanych 4 |
|
|
Wyszukaj metadane 5
|
items.data5 | string |
Wyszukiwanie według wartości metadanych 5 |
|
|
Wyszukaj metadane 6
|
items.data6 | string |
Wyszukiwanie według wartości metadanych 6 |
|
|
Wyszukiwanie metadanych 7
|
items.data7 | string |
Wyszukiwanie według wartości metadanych 7 |
|
|
Wyszukiwanie metadanych 8
|
items.data8 | string |
Wyszukiwanie według wartości metadanych 8 |
|
|
Wyszukaj profil podpisu
|
items.signatureProfileId | string |
Wyszukiwanie według profilu podpisu |
|
|
Data utworzenia wyszukiwania
|
items.created | string |
Wyszukiwanie według daty utworzenia |
|
|
Data aktualizacji wyszukiwania
|
items.updated | string |
Wyszukiwanie według daty ostatniej aktualizacji |
|
|
Sortuj według
|
sortBy | string |
Pole używane do sortowania wyników wyszukiwania |
|
|
Kolejność sortowania
|
sortOrder | string |
Kierunek sortowania |
|
|
Elementy na stronę
|
itemsPerPage | string |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | string |
Indeks zwróconej strony |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | documents |
Wyszukiwanie stron zgody
Wyszukiwanie stron zgody
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
text | string |
Tekst wyszukiwania |
|
|
Domyślne wyszukiwanie
|
items.isDefault | string |
Wyszukaj domyślną stronę zgody |
|
|
Wyszukiwanie jest wyłączone
|
items.isDisabled | string |
Wyszukiwanie wyłączonych stron zgody |
|
|
Nazwa wyszukiwania
|
items.name | string |
Wyszukiwanie według nazwy strony zgody |
|
|
Typ kroku wyszukiwania
|
items.stepType | string |
Wyszukaj według typu kroku |
|
|
Identyfikator klienta wyszukiwania
|
items.clientId | string |
Wyszukiwanie według identyfikatora klienta |
|
|
Data utworzenia wyszukiwania
|
items.created | string |
Wyszukiwanie według daty utworzenia |
|
|
Data aktualizacji wyszukiwania
|
items.updated | string |
Wyszukiwanie według daty ostatniej aktualizacji |
|
|
Sortuj według
|
sortBy | string |
Pole, na którym ma być posortowane wyniki wyszukiwania |
|
|
Kolejność sortowania
|
sortOrder | string |
Kierunek sortowania |
|
|
Elementy na stronę
|
itemsPerPage | string |
Liczba elementów na stronę w odpowiedzi |
|
|
Indeks strony
|
pageIndex | string |
Indeks zwróconej strony |
Zwraca
- Body
- consentPages
Definicje
consentPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Umożliwia korzystanie z organizacji |
|
authenticateUser
|
authenticateUser | boolean |
Wymusza uwierzytelnianie osób podpisanych |
|
clientId
|
clientId | string |
Identyfikator klienta |
|
utworzone
|
created | number |
Data utworzenia |
|
emUrl
|
emUrl | string |
Adres URL menedżera dowodów |
|
hideDownloads
|
hideDownloads | boolean |
Linki pobierania dokumentów nie są odtwarzane na stronach zgody |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Ukrywa kody QR na stronach constent |
|
id
|
id | string |
Identyfikator strony zgody |
|
isCountryRequired
|
isCountryRequired | boolean |
Sprawia, że kraj obowiązkowy w informacjach dotyczących osób podpisujących |
|
isDisabled (Wyłączone)
|
isDisabled | boolean |
Strona zgody jest wyłączona |
|
logoResourceId
|
logoResourceId | string |
Identyfikator zasobu logo strony zgody |
|
nazwa
|
name | string |
Nazwa strony zgody |
|
primaryColor
|
primaryColor | string |
Kolor podstawowy strony zgody |
|
secondaryColor
|
secondaryColor | string |
Kolor pomocniczy strony zgody |
|
sharedPassphrase
|
sharedPassphrase | string |
Udostępnione hasło |
|
tryb podpisywania
|
signing mode | string |
Tryb podpisywania (lokalny lub serwer) |
|
stepType
|
stepType | string |
typ kroku (podpis lub zatwierdzenie) |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawcy |
|
tsaUrl
|
tsaUrl | string |
Adres URL urzędu sygnatury czasowej |
|
aktualizowano
|
updated | number |
Data ostatniej modyfikacji |
|
verifyEmail
|
verifyEmail | boolean |
W przypadku ustawienia na wt osoby podpisające otrzymają wiadomości e-mail |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
W przypadku ustawienia wartości true osoby podpisające otrzymają wiadomości SMS |
consentPages
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
Łączna liczba elementów
|
totalItems | integer |
Łączna liczba elementów |
kontakt
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
country
|
country | string |
Kraj kontaktu |
|
utworzone
|
created | integer |
Data utworzenia kontaktu |
|
e-mail
|
string |
Kontaktowy adres e-mail |
|
|
imię
|
firstName | string |
Kontakt firstName |
|
id
|
id | string |
Identyfikator kontaktu |
|
nazwisko
|
lastName | string |
Nazwisko kontaktu |
|
nazwa
|
name | string |
Imię i nazwisko (imię i nazwisko)) |
|
numer telefonu
|
phoneNumber | string |
Numer telefonu kontaktowego |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawcy |
|
aktualizowano
|
updated | integer |
Skontaktuj się z datą ostatniej modyfikacji |
|
userId
|
userId | string |
Identyfikator właściciela kontaktu |
contacts
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
Łączna liczba elementów
|
totalItems | integer |
Łączna liczba elementów |
dataMapping
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
opis
|
data1.description | string |
Opis metadanych |
|
nazwa
|
data1.name | string |
Nazwa metadanych |
|
wzorzec
|
data1.pattern | string |
Wzorzec metadanych |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Wartość metadanych |
|
typ
|
data1.type | string |
typ |
|
opis
|
data2.description | string |
Opis metadanych |
|
nazwa
|
data2.name | string |
Nazwa metadanych |
|
wzorzec
|
data2.pattern | string |
Wzorzec metadanych |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Wartość metadanych |
|
typ
|
data2.type | string |
typ |
|
opis
|
data3.description | string |
Opis metadanych |
|
nazwa
|
data3.name | string |
Nazwa metadanych |
|
wzorzec
|
data3.pattern | string |
Wzorzec metadanych |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Wartość metadanych |
|
typ
|
data3.type | string |
typ |
|
opis
|
data4.description | string |
Opis metadanych |
|
nazwa
|
data4.name | string |
Nazwa metadanych |
|
wzorzec
|
data4.pattern | string |
Wzorzec metadanych |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Wartość metadanych |
|
typ
|
data4.type | string |
typ |
|
opis
|
data5.description | string |
Opis metadanych |
|
nazwa
|
data5.name | string |
Nazwa metadanych |
|
wzorzec
|
data5.pattern | string |
Wzorzec metadanych |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Wartość metadanych |
|
typ
|
data5.type | string |
typ |
|
opis
|
data6.description | string |
Opis metadanych |
|
nazwa
|
data6.name | string |
Nazwa metadanych |
|
wzorzec
|
data6.pattern | string |
Wzorzec metadanych |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Wartość metadanych |
|
typ
|
data6.type | string |
typ |
|
opis
|
data7.description | string |
Opis metadanych |
|
nazwa
|
data7.name | string |
Nazwa metadanych |
|
wzorzec
|
data7.pattern | string |
Wzorzec metadanych |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Metadatavalue |
|
typ
|
data7.type | string |
typ |
|
opis
|
data8.description | string |
Opis metadanych |
|
nazwa
|
data8.name | string |
Nazwa metadanych |
|
wzorzec
|
data8.pattern | string |
Wzorzec metadanych |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Wartość metadanych |
|
typ
|
data8.type | string |
typ |
dokument
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | integer |
Data utworzenia |
|
groupId
|
groupId | string |
Identyfikator grupy właściciela dokumentu |
|
id
|
id | string |
Identyfikator dokumentu |
|
Części
|
parts | array of part |
Części |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
Identyfikator profilu podpisu dokumentu |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawy |
|
aktualizowano
|
updated | integer |
Data ostatniej modyfikacji |
|
userId
|
userId | string |
Identyfikator użytkownika właściciela dokumentu |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista grup, które mogą wyświetlać dokument |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Lista użytkowników zezwala na wyświetlanie dokumentu |
|
workflowId
|
workflowId | string |
Identyfikator przepływu pracy, do którego należy dokument |
|
Nazwa_przepływu pracy
|
workflowName | string |
Nazwa przepływu pracy, do którego należy dokument |
Dokumentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
Łączna liczba elementów
|
totalItems | integer |
Łączna liczba elementów |
układ
Układ metadanych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | number |
Data utworzenia |
|
id
|
id | string |
Identyfikator układu |
|
isDisabled (Wyłączone)
|
isDisabled | boolean |
Jeśli ustawiono wartość true, układ został rozłączony |
|
nazwa
|
name | string |
Nazwa układu |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawy |
|
aktualizowano
|
updated | number |
Data ostatniej modyfikacji |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
szczelina
|
dataConfigurations.slot | string |
Element metadanych (dane1 do data8) |
|
domyślny
|
dataConfigurations.default | string |
Wartość domyślna metadanych w tym układzie |
|
optional
|
dataConfigurations.optional | boolean |
Jeśli wartość true, podanie wartości dla tych metadanych nie jest obowiązkowe |
|
readonly
|
dataConfigurations.readonly | boolean |
Wether wartość może być przesłonięć |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Jeśli ustawiono wartość true, wartość będzie nadal występować w przepływach pracy |
Układów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of object | |
|
utworzone
|
items.created | number |
Data utworzenia |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Liczba elementów na stronę |
|
pageIndex
|
pageIndex | number |
Indeks zwróconej strony |
|
Łączna liczba elementów
|
totalItems | number |
Łączna liczba elementów, których dotyczy żądanie |
part
Część dokumentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ treści
|
contentType | string |
typ treści |
|
filename
|
filename | string |
filename |
|
skrót
|
hash | string |
skrót |
|
size
|
size | integer |
size |
pdfSigField
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | number |
Data utworzenia |
|
documentType
|
documentType | string |
Typ dokumentów |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Wymuś przewinięcie znaku w dolnej części dokumentu |
|
id
|
id | string |
identyfikator profilu podpisu |
|
isDefault
|
isDefault | boolean |
Sprawia, że ten profil podpisu jest domyślnym profilem |
|
isDisabled (Wyłączone)
|
isDisabled | boolean |
Wyłącz ten profil podpisu |
|
nazwa
|
name | string |
Nazwa profilu podpisu |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Tekst wyświetlany w podkładkach podpisów |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Kolor tekstu wyświetlanego w okienkach singatures |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Rozmiar tekstu wyświetlanego w okienkach singatures |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Widoczny tryb podpisu (dozwolony, wyłączony, noImage) |
|
Typ podpisu
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, ebis |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawcy |
|
aktualizowano
|
updated | number |
Data ostatniej modyfikacji |
signatureProfiles
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Liczba elementów na stronę |
|
pageIndex
|
pageIndex | number |
Indeks zwróconej strony |
|
Łączna liczba elementów
|
totalItems | number |
Łączna liczba elementów, których dotyczy żądanie |
użytkownik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zatwierdźWszystkie
|
approveAllowed | boolean |
Jeśli ustawiono wartość true, użytkownik może zatwierdzić dokumenty |
|
country
|
country | string |
Kraj użytkownika |
|
utworzone
|
created | integer |
Data utworzenia |
|
e-mail
|
string |
Adres e-mail użytkownika |
|
|
imię
|
firstName | string |
Imię użytkownika |
|
groupId
|
groupId | string |
Identyfikator grupy użytkownika |
|
id
|
id | string |
Identyfikator użytkownika |
|
isDisabled (Wyłączone)
|
isDisabled | boolean |
Jeśli wartość true, użytkownik jest wyłączony |
|
lastLogin
|
lastLogin | integer |
Data ostatniego logowania użytkownika |
|
nazwisko
|
lastName | string |
Nazwisko użytkownika |
|
nazwa
|
name | string |
Imię (imię i nazwisko) użytkownika |
|
organizationTitles
|
organizationTitles | array of |
Funty użytkownika w jego organizacjach |
|
numer telefonu
|
phoneNumber | string |
Numer telefonu użytkownika |
|
signAllowed
|
signAllowed | boolean |
W przypadku ustawienia wartości true użytkownik może podpisać dokumenty |
|
Temat
|
subject | string |
Wewnętrzny kod podwytkownika użytkownika |
|
tenantId
|
tenantId | string |
Identyfikator dzierżawy |
|
aktualizowano
|
updated | integer |
Data ostatniej modyfikacji |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista grup, w których użytkownik może pełnić rolę obserwatora |
przepływ pracy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | integer |
utworzone |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metadane 1 |
|
data2
|
data2 | string |
Metadane 2 |
|
data3
|
data3 | string |
Metadane 3 |
|
data4
|
data4 | string |
Metadane 4 |
|
data5
|
data5 | string |
Metadane 5 |
|
data6
|
data6 | string |
Metadane 6 |
|
data7
|
data7 | string |
Metadane 7 |
|
data8
|
data8 | string |
Metadane 8 |
|
opis
|
description | string |
Opis przepływu pracy |
|
e-mail
|
string |
Adres e-mail właściciela przepływu pracy |
|
|
imię
|
firstName | string |
Imię właściciela przepływu pracy |
|
groupId
|
groupId | string |
Identyfikator grupy właściciela przepływu pracy |
|
id
|
id | string |
Identyfikator przepływu pracy |
|
nazwisko
|
lastName | string |
Nazwisko właściciela przepływu pracy |
|
layoutId
|
layoutId | string |
Identyfikator układu metadanych przepływu pracy |
|
dzienniki
|
logs | array of |
Rejestruje elementy wokflow |
|
nazwa
|
name | string |
Nazwa (imię i nazwisko) właściciela przepływu pracy |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis zdarzeń powiadamianych przez przepływ pracy |
|
postęp
|
progress | integer |
Postęp przepływu pracy w procentach |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Zezwala/zabrania interakcyjnych komentarzy dozwolonych w kroku |
|
hideAttachments
|
steps.hideAttachments | boolean |
Steruje wyświetlaniem załączników do osób podpisujących |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Steruje wyświetlaniem innych osób podpisujących do osoby podpisujących |
|
id
|
steps.id | string |
Identyfikator kroku |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
rozpoczęto
|
steps.isStarted | boolean |
rozpoczęto |
|
dzienniki
|
steps.logs | array of |
dzienniki |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
e-mail
|
steps.recipients.email | string |
|
|
imię
|
steps.recipients.firstName | string |
imię |
|
nazwisko
|
steps.recipients.lastName | string |
nazwisko |
|
numer telefonu
|
steps.recipients.phoneNumber | string |
numer telefonu |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
aktualizowano
|
updated | integer |
aktualizowano |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista grup, w których użytkownicy mogą pełnić rolę obserwatorów |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
e-mail
|
watchers.email | string |
|
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
Łączna liczba elementów
|
totalItems | integer |
Łączna liczba elementów |
binarny
Jest to podstawowy typ danych "binary".