DOKUMENT OK (niezależny wydawca) (wersja zapoznawcza)
Dokument OK zapewnia łatwą w użyciu i dostosowywalną platformę dystrybucji podpisów elektronicznych i dokumentów cyfrowych, która bezproblemowo integruje się z istniejącymi systemami
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 | Seyfor Slovensko a.s. |
| adres URL | https://www.seyfor.com |
| tomas.szarka@seyfor.com |
| Metadane łącznika | |
|---|---|
| Publisher | Seyfor Slovensko, a.s. |
| Witryna internetowa | https://okdokument.com/ |
| Zasady ochrony prywatności | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Kategorie | Produktywność |
DOKUMENT OK — podpis elektroniczny
Dokument OK zapewnia łatwą w użyciu i dostosowywalną platformę do obsługi podpisów elektronicznych i dystrybucji zawartości cyfrowej, która bezproblemowo integruje się z istniejącymi systemami.
Publisher
Seyfor Slovensko, a.s.
Wymagania wstępne
Musisz mieć konto na https://app.okdokument.com stronie i prawidłowy klucz interfejsu API wygenerowany przez usługę dokumentów OK .
Obsługiwane operacje
1. Przekazywanie dokumentów
Akcja używana do przekazywania pliku PDF do usługi podpisu dokumentu. Ta akcja wykonuje ciąg base64 i przekazuje go do platformy interfejsu API dokumentu OK .
Dokument przechodzi kilka stanów w okresie jego istnienia. Interfejs API dokumentów OK używa następujących stanów dokumentu:
- tags — stan, który wyszukuje tagi tekstowe i wstawia pola sygnatur. Po pomyślnym wstawieniu pól acrofields automatycznie zmienia stan na tosign
- tostamp — stan, który wstawia sygnaturę cyfrową do dokumentu
- tosign — dokument gotowy do podpisania
- signed — podpisany dokument (w ramach danego identyfikatora signatureRequestID)
- errorsendinfo — błąd podczas wywoływania usługi informacji
- anulowano — anulowany dokument — użytkownik naciśnął przycisk "Anuluj" w dokumencie
Acrofields podpisów
Acrofield to typ aktywnego pola obsługiwanego w formacie PDF. Acrofield podpisu to specjalny typ aktywnego pola, który umożliwia wstawienie podpisu do dokumentu w stałej lokalizacji. Acrofields można wstawić do plików PDF za pomocą wyspecjalizowanych narzędzi PDF, takich jak Adobe PRO, lub z narzędziami szablonu, takimi jak JasperReport.
Etykiety
Tag reprezentuje unikatową wartość tekstową skanowaną przez serwer interfejsu API. Jeśli go znajdzie, wstawia podpis acrofield w swoim miejscu. Wyszukiwanie tagów jest dostarczane przez stan dokumentu "tagi", który należy ustawić po wywołaniu usługi JSON/document. Interfejs API OKdokument obsługuje następujące tagi dla podpisu opcjonalnego:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
Interfejs API OKdokument obsługuje następujące tagi dla obowiązkowego podpisu: _SC1__SC2__SC3_ _SC4__SC5_
Jeśli są używane obowiązkowe tagi, wszystkie widoczne obowiązkowe pola podpisu muszą być podpisane przed przesłaniem dokumentu.
Jeśli nie jest możliwe przygotowanie dokumentów z podpisem acrofields lub tagów podczas rejestrowania signatureRequest, istnieje możliwość włączenia funkcji "podpisywanie w dowolnym miejscu", co umożliwi użytkownikowi podpisywanie dokumentu w dowolnej lokalizacji, proste, gdzie użytkownik klika/naciska
Konwertowanie dokumentu na plik PDF
Interfejs API OKdokument obsługuje konwersję .doc, .docx, .xls, .xlsx na format pliku PDF. Plik źródłowy może zawierać również tagi, interfejs API OKdokument najpierw wykona konwersję pliku, a następnie automatycznie wstawia pola podpisu.
Aby przekonwertować plik na plik PDF, musisz wypełnić nazwę dokumentu. Ten parametr jest obowiązkowy, jeśli chcesz przeprowadzić konwersję pliku na format PDF. W przypadku konwersji postfiks pliku musi być:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Przechowywanie i usuwanie dokumentów
Interfejs API dokumentów OK nie pełni roli trwałego archiwum podpisanego dokumentu. Stosowane są następujące reguły:
- Podpisany dokument jest automatycznie usuwany 10 dni po podpisaniu
- Dokument niepodpisany jest automatycznie usuwany po upływie 30 dni od przekazania
2. Żądanie podpisu
Ta akcja służy do generowania identyfikatora żądania podpisu. W ramach tej akcji musisz użyć identyfikatora dokumentu. Identyfikator dokumentu jest wynikiem akcji przekazywania dokumentu.
W tej akcji można przekształcić proces podpisu w proces podpisu wieloestegożowego. Dodanie dodatkowego parametru "Pola podpisu" umożliwia zarządzanie tym, co powinno być dostępne w każdym żądaniu podpisu. Możesz użyć pól acrofield z nazwami wewnętrznymi
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
Tej akcji można używać wiele razy w procesie. Akcja żądania podpisu jest generowana w usłudze dokumentów OK jako "Żądanie podpisu", a ten identyfikator jest unikatowy dla każdej akcji "Podpis".
Aby wysłać żądanie podpisu dokumentu, użyj adresu URL atrybutu odpowiedzi i użyj go w wiadomości e-mail, powiadomieniach wypychanych lub aplikacji MS Teams, aby poprosić kogoś o podpisanie określonego dokumentu.
Po podpisaniu dokumentu możesz użyć opcji "Żądanie podpisu", aby zmienić stan dokumentu na "tosign" i utworzyć nowy identyfikator signatureRequestId i przygotować dokument do następnego podpisu. Proces powtarza kroki od 3 do 5.
Przykład żądania podpisu z jednym obowiązkowym polem acrofield
_SC1_
Przykład żądania podpisu z jednym obowiązkowym polem acrofield i opcjonalnym acrofield w jednym żądaniu podpisu_SC1_;_SO2_
Dodatkowe reguły w żądaniu podpisu
Dodatkowe reguły mogą służyć do:
- Wyłączanie lub włączanie funkcji Sign Anywhere
- Wstępnie zdefiniowana wartość dla nazwy osoby podpisającego
- włączanie danych wejściowych dla nazwy osoby podpisającej
- włączanie wysyłania żądania podpisu z dokumentu OK
- Włącz przypomnienie e-mail
- Konfiguracja protokołu OTP (jednorazowe hasło) za pośrednictwem poczty e-mail lub wiadomości SMS
- podpisywanie dokumentu przy użyciu protokołu OTP
- wyłączanie podpisywania za pomocą myszy
| Nazwa reguły | Parameter | Description |
|---|---|---|
| signAnywhereEnabled | prawda/fałsz | parametr wyłączania funkcji podpisywania w dowolnym miejscu |
| guiRequestSignerName | prawda/fałsz | parametr włączania danych wejściowych dla nazwy osoby podpisającej |
| guiSignerName | Nazwa osoby podpisającego | wstępnie zdefiniowana wartość nazwy osoby podpisanej, maksymalnie 40 znaków. Jeśli identyfikator guiRequestSignerName jest włączony, nazwę osoby podpisającego można zmienić za pomocą osoby podpisającego. |
| signAnywhereEnabled | prawda/fałsz | parametr wyłączania funkcji podpisywania w dowolnym miejscu |
| emailTo | Adres e-mail sygnatariusza | Adres URL żądania podpisania wiadomości e-mail dla osób podpisujących |
| należy dostarczyć. | ||
| adres e-mailZ | Adres e-mail nadawcy | Adres e-mail nadawców. Obowiązkowe, jeśli jest używana reguła emailTo |
| nameFrom | Nazwa nadawcy | Nazwa nadawców, która będzie używana w szablonach wiadomości e-mail |
| Powiadomienie e-mail | Reguła umożliwiająca przypomnienie e-mail. Przypomnienie e-mail wysyła wiadomość e-mail codziennie rano o godzinie 7:00 w przypadku żądań podpisu, które nie są podpisane. Wiadomość e-mail jest wysyłana do wiadomości e-mailTo i emailFrom — zgodnie z konfiguracją signatureRequest. | |
| emailFinal (adres e-mail) | Adres e-mail sygnatariusza | Wiadomość e-mail w celu dostarczenia podpisanego dokumentu. Jeśli parametr emailFinal jest bez parametru, podpisany dokument zostanie wysłany do adresu emailTo. |
| openOtpPhone | Telefon signer | Osoby podpisujące numer telefonu, do którego zostanie dostarczone jednorazowe hasło umożliwiające uzyskanie dostępu do dokumentu. Aby korzystać z protokołu OTP programu SMS, należy kupić pakiet żądania podpisu z wiadomością SMS. |
| openOtpEmail | Adres e-mail sygnatariusza | Osoby podpisujące wysyłają wiadomość e-mail, do której zostanie dostarczone jednorazowe hasło umożliwiające uzyskanie dostępu do dokumentu. |
| signOtpPhone | Telefon signer | Osoby podpisującego numer telefonu, do którego zostanie dostarczone jednorazowe hasło do podpisywania dokumentu. Podpis OTP wymaga sygnatury acrofield. |
| signOtpEmail | Adres e-mail sygnatariusza | Osoby podpisującego wiadomość e-mail, do której zostanie dostarczone jednorazowe hasło do podpisywania dokumentu. Podpis OTP wymaga sygnatury acrofield. |
| język | sk, cs, en, ro, uk, pl, pt, hu | Język wiadomości e-mail i szablon wiadomości SMS, jeśli reguła nie jest ustawiona, używany jest język słowacki jako język domyślny. |
| mouseSignature | false | Reguła wyłączania podpisywania za pomocą myszy. |
Składnia do pisania reguł żądań podpisu
RuleName-Value
Składnia do pisania wielu reguł żądania podpisu
RuleName1-Value_RuleName2-Value_RuleName3-Value
Przykład żądania podpisu z włączonym podpisem w dowolnym miejscu
signAnywhereEnabled-true
Przykład żądania podpisu z wyłączonym podpisem w dowolnym miejscu i włączoną nazwą osoby podpisowej ze wstępnie wypełnionymi wartościami
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
Przykład żądania podpisu z wyłączonym podpisem w dowolnym miejscu, włączona nazwa osoby podpisowej z wstępnie wypełniona wartością, zdefiniowana wiadomość e-mail OTP do otwarcia żądania podpisu, wiadomość e-mail, w której jest wysyłane żądanie podpisu, język szablonu wiadomości e-mail, wiadomość e-mail nadawcy żądania podpisu
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false
Czas wygaśnięcia
Wartość domyślna wygaśnięcia żądania podpisu to 24 godziny. Ten zakres czasu można rozszerzyć do 10 dni przy użyciu tego parametru expirationTime. Czas wygaśnięcia identyfikatora żądania podpisu. Czas w milisekundach od 1 stycznia 1970 00:00:00 UTC
Interfejs API OKdokument umożliwia udostępnianie adresu URL signatureRequest za pośrednictwem poczty e-mail. Aby wysłać wiadomość e-mail, musisz użyć reguł:
- emailTo — adres e-mail sygnatariusza
- emailFrom — adres e-mail nadawcy
- nameFrom — nazwa nadawcy
Wiadomość e-mail zostanie dostarczona z okdokument@okdokument.skadresu , ale gdy podpisze przycisk odpowiedz/odpowiedz wszystkim, odpowiedź zostanie wysłana bezpośrednio do nadawcy (emailFrom). Zalecamy również użycie następujących reguł w celu dodatkowej konfiguracji w procesie podpisywania:
- emailFinal — wiadomość e-mail na potrzeby wysyłania podpisanego dokumentu. Domyślnie jest używana funkcja emailTo, ale można ją zmienić. W przypadku podpisywania wielosłrotnego użyj tej reguły w ostatniej rundzie podpisywania i wypełnij wszystkie adresy e-mail piosenkarki. Przykład: emailFinalemail@address.com|email2@address.com
- emailNotification — wiadomość e-mail z przypomnieniem, że dokument oczekuje na podpis.
- language — język szablonu wiadomości e-mail
- nazwa pliku — nazwa dokumentu, która będzie używana w szablonie wiadomości e-mail. Jeśli nazwa pliku nie jest wypełniona, identyfikator dokumentu technicznego będzie używany jako nazwa dokumentu
3. Poczekaj na podpis
Akcja wyzwalacza "Oczekiwanie na podpis" może być używana w procesie. Akcja "Zaczekaj na podpis" czeka, aż podpis dokumentu zostanie potwierdzony w usłudze dokumentowej OK , klikając przycisk Prześlij. Po przesłaniu podpisu ta akcja wyzwalacza zostanie ukończona. Możesz użyć tej akcji, jeśli musisz poczekać na potwierdzenie podpisu dokumentu w procesie.
4. Pobieranie podpisanego dokumentu
Ta akcja umożliwia pobranie podpisanego dokumentu i przetworzenie dokumentu w dodatkowych krokach w systemie lub zapisanie go w programie SharePoint lub innym systemie przechowywania dokumentów.
5. Usuwanie dokumentu
Po podpisaniu dokumentu możesz usunąć dokument z usługi dokumentowej OK przy użyciu akcji usuwania ręcznie. Wszystkie przekazane dokumenty są usuwane automatycznie po upływie 60 dni, a podpisane dokumenty zostaną usunięte po 10 dniach.
Uzyskiwanie poświadczeń
Klucz interfejsu API wymagany do używania usługi dokumentowej OK można uzyskać, subskrybując adres https://okdokument.com/en/about/api/.
Znane problemy i ograniczenia
Obecnie istnieją ograniczenia dotyczące używania pól i tagów. Jedynym możliwym użyciem tagów lub pól acrofields jest wstępnie zdefiniowany format ciągu w procesie: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ lub _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Niestandardowe nazwy wewnętrzne acrofield są obecnie używane:
| Pole wyboru | Acrofield |
|---|---|
| Pole wyboru opcjonalnego | Kobalt |
| Obowiązkowe pole wyboru | CR |
| Pole tekstowe | Acrofield |
|---|---|
| Pole tekstowe opcjonalne | DO |
| Pole tekstowe obowiązkowe | TC |
| Grupa przycisków radiowych | Acrofield |
|---|---|
| Opcjonalna grupa przycisków radiowych | RO |
| Obowiązkowa grupa przycisków radiowych | RC |
| Pole kombi | Acrofield |
|---|---|
| Opcjonalne pole kombi | CBO |
| Obowiązkowe pole kombi | CBC |
Instrukcje dotyczące wdrażania
Skorzystaj z instrukcji znajdujących się tutaj , aby wdrożyć ten łącznik jako łącznik niestandardowy w usługach Microsoft Power Automate, Power Apps lub Azure LogicApps.
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 App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API dokumentu OK | securestring | Klucz interfejsu API aplikacji/subskrypcji wystawiony przez firmę Anasoft | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie podpisanego dokumentu |
Pobieranie podpisanego dokumentu |
| Przekazywanie dokumentów |
Przekazywanie dokumentów |
| Usuwanie dokumentu |
Usuwanie dokumentu |
| Żądanie podpisu |
Żądanie podpisu |
Pobieranie podpisanego dokumentu
Pobieranie podpisanego dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
Document ID | True | string |
Akcja przekazywania dokumentu z identyfikatora dokumentu |
Zwraca
Zawartość dokumentu
- Zawartość dokumentu
- binary
Przekazywanie dokumentów
Przekazywanie dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Operacja dokumentu
|
state | string |
Operacja dokumentu |
|
|
File
|
file | True | binary |
Zawartość pliku |
|
Filename
|
filename | string |
Nazwa pliku z rozszerzeniem |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
result | string |
Identyfikator dokumentu |
Usuwanie dokumentu
Usuwanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
Document ID | True | string |
Identyfikator dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
kod |
|
komunikat
|
message | string |
komunikat |
|
kod statusu
|
statusCode | integer |
kod statusu |
Żądanie podpisu
Żądanie podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Akcja przekazywania dokumentu z identyfikatora dokumentu |
|
Pola podpisu
|
SIGNATURE | string |
Pola podpisu w dokumencie |
|
|
Czas wygaśnięcia
|
expirationTime | string |
Czas wygaśnięcia w milisekundach |
|
|
Name
|
name | string |
Nazwa pola acrofield |
|
|
Wartość
|
value | string |
Wartość pola Acrofield |
|
|
Tylko do odczytu
|
readOnly | boolean |
Pole Acrofield jest tylko do odczytu |
|
|
Dodatkowe reguły
|
rules | string |
Reguły definiowania procesu żądania podpisu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator żądania podpisu
|
result | string |
Identyfikator żądania podpisu |
|
Adres URL żądania podpisu
|
url | string |
URL |
Wyzwalacze
| Oczekiwanie na podpis dokumentu |
Oczekiwanie na podpis dokumentu |
Oczekiwanie na podpis dokumentu
Oczekiwanie na podpis dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator żądania podpisu
|
signatureRequestId | True | string |
Identyfikator żądania podpisu z akcji żądania podpisu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
kod |
|
kod statusu
|
statusCode | integer |
kod statusu |
Definicje
binarny
Jest to podstawowy typ danych "binary".