Piaskownica podpisywania Penneo (wersja zapoznawcza)
Penneo przekształca złożone procesy w bezproblemowe, skoncentrowane na człowieku środowisko. Dzięki integracji podpisów cyfrowych z zautomatyzowanymi przepływami pracy nasza platforma ułatwia weryfikowanie, kto zatwierdził jakie dane i kiedy, zmniejszając obciążenia administracyjne przy jednoczesnym zapewnieniu pełnej zgodności i bezpieczeństwa. Ten łącznik umożliwia wysyłanie dokumentów do podpisywania.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony 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: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony 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 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 biznesowy | |
|---|---|
| Name | Obsługa penneo |
| adres URL | https://www.support.penneo.com |
| Metadane łącznika | |
|---|---|
| Publisher | Integracja z penneo |
| przesłać źródło | Swagger |
| Witryna internetowa | https://penneo.com |
| Zasady ochrony prywatności | https://penneo.com/privacy-policy |
| Kategorie | Produktywność |
Piaskownica podpisywania penneo
Penneo przekształca złożone procesy w bezproblemowe, skoncentrowane na człowieku środowisko. Dzięki integracji podpisów cyfrowych z zautomatyzowanymi przepływami pracy nasza platforma ułatwia weryfikowanie, kto zatwierdził jakie dane i kiedy, zmniejszając obciążenia administracyjne przy jednoczesnym zapewnieniu pełnej zgodności i bezpieczeństwa.
Wymagania wstępne
Aby użyć tego łącznika, musisz mieć aktywne konto piaskownicy Penneo.
Obsługiwane akcje
Tworzenie nowego pliku sprawy
Tworzy nowy plik sprawy w penneo z określonymi dokumentami (PDF lub ZIP) i podpisujących. Plik sprawy zostanie utworzony w penneo, a identyfikator UUID i ładunekHash zostanie zwrócony, który może służyć do sprawdzania stanu tworzenia za pośrednictwem punktu końcowego stanu kolejki. Pliki przypadków utworzone za pomocą tego łącznika są oznaczone źródłem microsoft.
Sprawdzanie stanu zadania
Pobiera bieżący stan pliku casefile, podając identyfikator UUID zadania i ładunekHash. Ten punkt końcowy służy do sondowania stanu ukończenia zadania po przesłaniu żądania utworzenia pliku sprawy. Punkt końcowy jest ograniczony do 20 żądań na minutę na kombinację uuid-payloadHash.
Pobieranie szczegółów pliku sprawy
Pobiera szczegóły określonego pliku przypadku z Penneo na podstawie identyfikatora pliku sprawy. Obejmuje to osoby podpisające, dokumenty i bieżący stan.
Pobieranie dokumentu
Pobiera zawartość dokumentu z penneo. Użyj parametru format , aby wybrać format odpowiedzi: json (wartość domyślna) wysyła Accept: application/json i zwraca dokument jako ciąg zakodowany w formacie base64.
default (Domyślny typ pliku) nie wysyła nagłówka Accept, więc Penneo zwraca plik z własnym typem zawartości, plikiem PDF lub plikiem ZIP. Nieprzetworzony plik można przekazać bezpośrednio do akcji, takich jak "Utwórz plik". Domyślnie zwracana jest podpisana wersja dokumentu; Zamiast tego użyj parametru signed , aby pobrać niepodpisaną wersję. Jeśli plik sprawy zawiera więcej dokumentów, upewnij się, że należy włączyć pętlę dla każdego dokumentu.
Uzyskiwanie poświadczeń
Łącznik został skonfigurowany do używania protokołu OAuth z udzielaniem kodu autoryzacji. Użytkownicy będą musieli zalogować się przy użyciu zwykłych poświadczeń podczas korzystania z łącznika.
Wprowadzenie
Tworzenie pliku sprawy
Przygotowywanie dokumentów:
- Konwertowanie dokumentów PDF lub ZIP na kodowanie base64
- Upewnij się, że dokumenty są prawidłowymi plikami PDF lub ZIP. Plik ZIP jest dodawany jako pojedynczy dokument i podpisany jako kontener ASiC-E; Podpisywanie pliku ZIP wymaga metod podpisywania QES
Konfigurowanie osób podpisujących:
- Podaj nazwę i adres e-mail osoby podpisającego (wymagane)
- Opcjonalnie podaj rolę, język, kolejność podpisywania itp.
- Konfigurowanie powiadomień e-mail i niestandardowych szablonów wiadomości e-mail w razie potrzeby
- Aby dostarczyć za pośrednictwem e-Boks zamiast wiadomości e-mail, ustaw wartość
channeli podaj dokładnie jednącprz (10 cyfr) lubcvr(8 cyfr, opcjonalnie:suffix).eboksWiadomość e-mail nie jest wymagana w przypadku e-Boks. Klient musi mieć włączone e-boks (konfiguracja → kanałów komunikacyjnych firmy →) - Ustaw
reminderIntervalopcję (co najmniej 1 dzień), aby zastąpić interwał przypomnienia firmy, pozostawić go pustym, aby użyć wartości domyślnej firmy lub wysłaćnullw celu wyłączenia przypomnień dla sygnatariusza
Utwórz plik sprawy:
- Użyj akcji "Utwórz nowy plik sprawy"
- Wypełnij szczegóły pliku sprawy:
- Title
- Dokumenty (pliki PDF lub ZIP zakodowane w formacie base64)
- Osoby podpisujących (z nazwami i opcjonalnymi szczegółami)
- Ustawienia opcjonalne (wygaśnięcie, język, widoczność itp.)
Sprawdź stan tworzenia pliku CaseFile:
- Po utworzeniu pliku sprawy otrzymasz identyfikator UUID i ładunekHash
- Użyj akcji "Sprawdź stan zadania", aby sondować pod kątem ukończenia zadania
- Przestrzegaj limitu szybkości 20 żądań na minutę na kombinację skrótu uuid-hash
Uwaga: możesz sprawdzić, co robi każde pole, sprawdzając https://penneo.readme.io/reference/createcasefilewartość .
Pobieranie pliku sprawy i jego dokumentów
Pobierz szczegóły pliku sprawy:
- Użyj akcji "Pobierz szczegóły pliku sprawy" z identyfikatorem pliku sprawy
- Odpowiedź zawiera stan pliku sprawy, osoby podpisające i listę dokumentów (z ich identyfikatorami dokumentów)
Pobierz dokument:
- Użyj akcji "Pobierz dokument" z identyfikatorem dokumentu uzyskanym ze szczegółów pliku sprawy
- Odpowiedź
jsonzawiera zawartość dokumentu jako ciąg zakodowany w formacie base64 - Z
defaultodpowiedzią jest sam plik PDF lub ZIP, z typem zawartości Penneo wysyła
Znane problemy i ograniczenia
Ograniczanie szybkości: Punkt końcowy Sprawdź stan zadania jest ograniczony do 20 żądań na minutę na kombinację skrótu uuid-hash. Zaimplementuj odpowiednią logikę ponawiania przy użyciu wycofywania wykładniczego.
Przetwarzanie asynchroniczne: tworzenie pliku sprawy jest asynchroniczne. Należy użyć punktu końcowego stanu zadania, aby sprawdzić ukończenie, zamiast oczekiwać natychmiastowych wyników.
Kodowanie Base64: Dokumenty muszą być zakodowane w formacie Base64. Upewnij się, że prawidłowe kodowanie pozwala uniknąć błędów żądań (możesz użyć funkcji ciągów base64 w programie Power Platform do kodowania binarnych plików PDF lub ZIP).
Środowisko piaskownicy: ten łącznik jest skonfigurowany dla środowiska piaskownicy Penneo (
sandbox.penneo.com).Rozmiar dokumentu: przetwarzanie dużych dokumentów może potrwać dłużej. Treść żądania jest ograniczona do 25 MB, co powoduje pozostawienie około 18 MB dla plików zakodowanych w formacie base64.
Instrukcje dotyczące wdrażania
Uruchom następujące polecenia i postępuj zgodnie z monitami:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie dokumentu |
Pobiera zawartość dokumentu z penneo. Wybierz format JSON, aby wysłać kod Akceptuj: application/json i pobierz ciąg zakodowany w formacie base64. Wybierz pozycję Domyślny typ pliku, aby nie wysłać nagłówka Akceptuj, więc Penneo zwraca plik z własnym typem zawartości. Domyślnie zwracana jest podpisana wersja dokumentu. |
| Pobieranie szczegółów pliku sprawy |
Pobiera szczegóły określonego pliku sprawy z penneo, w tym jego osoby podpisujących, dokumenty i bieżący stan. Stan pliku sprawy: 0=nowy, 1=oczekujący, 2=odrzucone, 3=usunięte, 4=podpisany, 5=ukończony, 6=niepowodzenie, 7=wygasł, 8 =anonimowy. Użyj stanu 5 (ukończonego) jako wyzwalacza do pobrania podpisanych dokumentów. |
| Sprawdzanie stanu zadania |
Pobiera bieżący stan zadania asynchronicznego, podając identyfikator UUID zadania i ładunekHash. Ten punkt końcowy służy do sondowania stanu ukończenia zadania po przesłaniu żądania utworzenia pliku sprawy. Akcja jest ograniczona do 20 żądań na minutę na kombinację uuid-payloadHash. |
| Tworzenie nowego pliku sprawy |
Tworzy nowy plik sprawy w penneo z określonymi dokumentami (PDF lub ZIP) i podpisujących. Plik sprawy zostanie utworzony asynchronicznie, a identyfikator UUID zadania i ładunekHash zostanie zwrócony, który może służyć do sprawdzania stanu tworzenia za pomocą akcji Sprawdź stan zadania. Można skonfigurować osoby podpisującego, dokumenty, zamówienie podpisywania, powiadomienia e-mail, kontrolę dostępu i różne inne ustawienia plików przypadków. |
Pobieranie dokumentu
Pobiera zawartość dokumentu z penneo. Wybierz format JSON, aby wysłać kod Akceptuj: application/json i pobierz ciąg zakodowany w formacie base64. Wybierz pozycję Domyślny typ pliku, aby nie wysłać nagłówka Akceptuj, więc Penneo zwraca plik z własnym typem zawartości. Domyślnie zwracana jest podpisana wersja dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu do pobrania. Pobierz identyfikatory documentId z akcją "Pobierz szczegóły pliku sprawy". |
|
Podpisane
|
signed | boolean |
Pobierz podpisany lub niepodpisany dokument. Domyślnie podpisany dokument jest zwracany, jeśli dokument został podpisany. |
|
|
Forma
|
format | string |
Format odpowiedzi. Polecenie "json" wysyła polecenie Accept: application/json i zwraca dokument jako ciąg zakodowany w formacie base64. Wartość domyślna nie wysyła nagłówka Accept. Następnie Penneo zwraca plik z własnym typem zawartości, aplikacją/plikiem PDF lub aplikacją/plikiem zip. Nieprzetworzony plik można przekazać bezpośrednio do akcji, takich jak "Utwórz plik". |
Zwraca
- Body
- DocumentContent
Pobieranie szczegółów pliku sprawy
Pobiera szczegóły określonego pliku sprawy z penneo, w tym jego osoby podpisujących, dokumenty i bieżący stan. Stan pliku sprawy: 0=nowy, 1=oczekujący, 2=odrzucone, 3=usunięte, 4=podpisany, 5=ukończony, 6=niepowodzenie, 7=wygasł, 8 =anonimowy. Użyj stanu 5 (ukończonego) jako wyzwalacza do pobrania podpisanych dokumentów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pliku sprawy
|
caseFileId | True | integer |
Identyfikator pliku sprawy do pobrania. Pobierz identyfikator pliku sprawy z akcją "Sprawdź stan zadania". |
Zwraca
Szczegóły pliku sprawy pobranego z bezpiecznego archiwum Penneo.
- Body
- CaseFileDetails
Sprawdzanie stanu zadania
Pobiera bieżący stan zadania asynchronicznego, podając identyfikator UUID zadania i ładunekHash. Ten punkt końcowy służy do sondowania stanu ukończenia zadania po przesłaniu żądania utworzenia pliku sprawy. Akcja jest ograniczona do 20 żądań na minutę na kombinację uuid-payloadHash.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
UUID (Uniwersalny Unikalny Identyfikator)
|
uuid | True | uuid |
Identyfikator UUID zadania do sprawdzenia. Jest to zwracane podczas tworzenia zadania. |
|
payloadHash
|
payloadHash | True | string |
Skrót SHA-256 ładunku. Jest to zwracane po utworzeniu zadania i służy do weryfikowania autentyczności żądania. |
Zwraca
- Body
- QueueJob
Tworzenie nowego pliku sprawy
Tworzy nowy plik sprawy w penneo z określonymi dokumentami (PDF lub ZIP) i podpisujących. Plik sprawy zostanie utworzony asynchronicznie, a identyfikator UUID zadania i ładunekHash zostanie zwrócony, który może służyć do sprawdzania stanu tworzenia za pomocą akcji Sprawdź stan zadania. Można skonfigurować osoby podpisującego, dokumenty, zamówienie podpisywania, powiadomienia e-mail, kontrolę dostępu i różne inne ustawienia plików przypadków.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
title
|
title | True | string |
Tytuł pliku sprawy. |
|
sendAt
|
sendAt | integer |
Sygnatura czasowa, gdy należy wysłać plik sprawy. Null = natychmiast |
|
|
name
|
name | True | string |
Nazwa osoby podpisającego |
|
rola
|
role | string |
Rola dla sygnatariusza. Wszelkie znaki są dozwolone, w tym znaki narodowe, takie jak æøå, interpunkcja i spacje. Nie może rozpoczynać się ani kończyć spacją. |
|
|
e-mail
|
Adres e-mail sygnatariusza. Penneo będzie obsługiwać całą komunikację. Nie jest używany, gdy kanał jest eboks. |
|||
|
kanał
|
channel | string |
Kanał dostarczania. "email" (wartość domyślna) dostarcza za pośrednictwem poczty e-mail. "eboks" dostarcza za pośrednictwem e-Boks i wymaga dokładnie jednego z cpr lub cvr. Usługa e-Boks musi być włączona dla klienta. |
|
|
Cpr
|
cpr | string |
Numer samoobsługowego resetowania hasła dla dostarczania e-Boks, dokładnie 10 cyfr. Tylko prawidłowe, gdy kanał jest eboks. Nie należy łączyć z cvr. |
|
|
cvr
|
cvr | string |
Numer CVR dla dostarczania e-Boks, 8 cyfr z opcjonalnym alfanumerycznym ":sufiksem". Tylko prawidłowe, gdy kanał jest eboks. Nie należy łączyć z cpr. |
|
|
failUrl
|
failUrl | uri |
Adres URL przekierowania po niepowodzeniu |
|
|
język
|
language | string |
Język logowania |
|
|
emailText
|
emailText | string |
Niestandardowy tekst wiadomości e-mail żądania podpisu. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
signOrder
|
signOrder | integer |
Zamówienie podpisywania. Wartość 0 oznacza brak wymuszonej kolejności. |
|
|
successUrl
|
successUrl | uri |
Adres URL przekierowania po powodzeniu |
|
|
emailSubject (temat wiadomości e-mail)
|
emailSubject | string |
Temat wiadomości e-mail z żądaniem podpisu. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
reminderInterval
|
reminderInterval | integer |
Dni przed wysłaniem przypomnienia. Minimum 1. Pozostaw wartość pustą, aby użyć wartości domyślnej firmy lub wyślij wartość null, aby wyłączyć przypomnienia dla tego sygnatariusza. |
|
|
reminderEmailText
|
reminderEmailText | string |
Niestandardowy tekst wiadomości e-mail z przypomnieniem. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
completedEmailText
|
completedEmailText | string |
Niestandardowy tekst ukończonej wiadomości e-mail. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
reminderEmailSubject
|
reminderEmailSubject | string |
Temat wiadomości e-mail z przypomnieniem. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
completedEmailSubject
|
completedEmailSubject | string |
Temat ukończonej wiadomości e-mail. Wartość domyślna szablonu firmy, jeśli nie zostanie podana. |
|
|
enableInsecureSigning
|
enableInsecureSigning | boolean |
Jeśli to prawda, podpisz może używać podpisów dotykowych (rysowanie, tekst, przekazywanie obrazu) |
|
|
insecureSigningMethods
|
insecureSigningMethods | array of string |
Dozwolone niezabezpieczone metody podpisywania. Wartość domyślna to ustawienie firmowe, jeśli jest puste. |
|
|
secureSigningMethods
|
secureSigningMethods | array of string |
Dozwolone bezpieczne metody podpisywania elektronicznego. Zastępuje plik sprawy i ustawienia klienta po ustawieniu. |
|
|
vatin
|
vatin | string |
Numer identyfikacyjny VAT firmy podpisającego |
|
|
ssnType
|
ssnType | string |
Typ SSN/mobile. Przykład "dk:cpr", "se:pin", "no:nin", "be:nrn", "fi:pic" lub "sms". Wartość domyślna to "starsza wersja" |
|
|
activeAt
|
activeAt | integer |
Sygnatura czasowa aktywacji |
|
|
wygaśnięć
|
expireAt | integer |
Znacznik czasu wygaśnięcia |
|
|
accessControl (kontrola dostępu)
|
accessControl | boolean |
Jeśli jest włączona, numer SSN/VATIN/telefon zostanie zweryfikowany przed uzyskaniem dostępu |
|
|
Emailformat
|
emailFormat | string |
Definiuje format wiadomości e-mail |
|
|
onBehalfOf
|
onBehalfOf | string |
Firma/organizacja, której podpisuje się w imieniu tego sygnatariusza |
|
|
storeAsContact
|
storeAsContact | boolean |
Jeśli wartość true, osoba podpisowa będzie przechowywana jako kontakt w penneo |
|
|
socialSecurityNumberPlain
|
socialSecurityNumberPlain | string |
Numer SSN lub numer telefonu użytkownika podpisającego (zalecany format E.164) |
|
|
wygaśnięć
|
expireAt | integer |
Sygnatura czasowa wygaśnięcia pliku sprawy. Jeśli nie zostanie podana, stosowane są wartości domyślne |
|
|
język
|
language | string |
Język plików sprawy zostanie zastosowany dla każdego sygnatariusza, który nie ma zestawu języków |
|
|
PLIK PDF lub PLIK ZIP
|
True | string |
Plik PDF lub ZIP zakodowany w formacie Base64. Format jest wykrywany z zawartości. Plik ZIP jest dodawany jako pojedynczy dokument i podpisany jako kontener ASiC-E; Podpisywanie pliku ZIP wymaga metod podpisywania QES. |
|
|
możliwość podpisywania
|
signable | boolean |
Wartość True tworzy dokument z możliwością podpisania. Fałsz, dokument jest dodawany jako załącznik i nie można go podpisać. |
|
|
roles
|
roles | array of string |
Role osób podpisającego mogą podpisać ten dokument. Wartość domyślna dla wszystkich osób podpisujących, jeśli jest pusta. |
|
|
title
|
title | True | string |
Tytuł dokumentu |
|
documentOrder
|
documentOrder | integer |
Kolejność podpisywania dokumentu. Wartości domyślne podanej kolejności. |
|
|
metaDane
|
metaData | string |
Metadane dokumentu, które można przeszukiwać w penneo |
|
|
sensitiveData
|
sensitiveData | boolean |
Jeśli to prawda, osoby podpisujące muszą zweryfikować swoją tożsamość przed uzyskaniem dostępu do dokumentów. Wyłącza załączniki wiadomości e-mail dla podpisanych dokumentów. |
|
|
signOnMeeting
|
signOnMeeting | boolean |
Określa, czy dokumenty powinny być podpisane podczas spotkania. |
|
|
visibilityMode
|
visibilityMode | integer |
0 = Osoby podpisające widzą wszystkie dokumenty. 1 = Osoby podpisające widzą tylko dokumenty, które muszą podpisać. |
|
|
disableEmailAttachments
|
disableEmailAttachments | boolean |
Wyłącza załączniki wiadomości e-mail dla podpisanych dokumentów w wiadomościach e-mail dotyczących finalizacji. Przesłonięć, jeśli wartość sensitiveData ma wartość true. |
|
|
disableNotificationsOwner
|
disableNotificationsOwner | boolean |
Jeśli prawdziwy właściciel pliku sprawy nie otrzyma powiadomień dla pliku sprawy. |
|
|
folderId
|
folderId | integer |
Identyfikator folderu, w którym chcesz umieścić plik casefile |
|
|
metaDane
|
metaData | string |
Metadane pliku sprawy, które można przeszukiwać w penneo |
|
|
odwołanie
|
reference | string |
Odwołanie do pliku sprawy zostanie wyświetlone w aplikacji internetowej Penneo |
|
|
name
|
name | True | string |
Nazwa adresata |
|
e-mail
|
True |
Adres e-mail odbiorcy |
Zwraca
- Body
- JobResponse
Definicje
ZadanieResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
jobs
|
jobs | array of Job |
Tablica utworzonych zadań (zazwyczaj zawiera jedno zadanie) |
|
stan
|
status | string |
Stan żądania utworzenia zadania |
|
komunikat
|
message | string |
Czytelny dla człowieka komunikat o tworzeniu zadania |
Job
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
UUID (Uniwersalny Unikalny Identyfikator)
|
uuid | uuid |
Unikatowy identyfikator zadania, którego można użyć do sprawdzania stanu |
|
UUID (Uniwersalny Unikalny Identyfikator)
|
payload.uuid | uuid |
Identyfikator UUID utworzonego pliku sprawy |
|
bundleUuid
|
payload.bundleUuid | uuid |
Identyfikator UUID pakietu zawierającego plik sprawy |
|
etlVersionUuid
|
payload.etlVersionUuid | uuid |
UUID wersji ETL używanej do przetwarzania |
|
organizationUuid
|
payload.organizationUuid | uuid |
Identyfikator UUID organizacji, która jest właścicielem tego pliku przypadku |
|
customData
|
payload.customData | object |
Dodatkowe metadane i kontekst zadania |
|
createdAt
|
createdAt | date-time |
Znacznik czasu ISO 8601 podczas tworzenia zadania |
|
payloadHash
|
payloadHash | string |
Skrót SHA-256 ładunku używany do weryfikacji podczas sprawdzania stanu zadania |
QueueJob
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ zadania kolejki (np. "casefile_creation") |
|
UUID (Uniwersalny Unikalny Identyfikator)
|
uuid | uuid |
Unikatowy identyfikator zadania |
|
result
|
result | object |
Wynik wykonania zadania kolejki zwrócony jako kod JSON po zakończeniu zadania. Zawiera wynik i wszelkie istotne dane. |
|
jobStatus
|
jobStatus | string |
Bieżący stan zadania. Możliwe wartości "oczekujące" (oczekiwanie na przetworzenie), "przetwarzanie" (obecnie wykonywane), "ukończone" (zakończone pomyślnie), "niepowodzenie" (wykonanie nie powiodło się), "aborted_duplicated" (przerwane z powodu duplikacji) |
|
ładunek
|
payload | object |
Oryginalny ładunek przesłany z zadaniem, przechowywany jako JSON. Zawiera dane i metadane pliku sprawy. |
|
Ponownych prób
|
retries | integer |
Liczba ponownych prób wykonania zadania po niepowodzeniu |
|
createdAt
|
createdAt | date-time |
Data i godzina utworzenia zadania kolejki |
|
updatedAt
|
updatedAt | date-time |
Data i godzina ostatniej aktualizacji zadania kolejki |
|
maxRetries
|
maxRetries | integer |
Maksymalna liczba ponownych prób dozwolonych dla tego zadania, zanim zostanie oznaczona jako niepowodzenie |
|
payloadHash
|
payloadHash | string |
Skrót SHA-256 ładunku, używany do celów weryfikacji i zabezpieczeń |
|
errorMessage
|
errorMessage | string |
Komunikat o błędzie opisujący, dlaczego zadanie nie powiodło się, jeśli ma to zastosowanie. Występuje tylko wtedy, gdy parametr jobStatus ma wartość "failed". |
CcRecipient
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
name
|
name | string |
Nazwa adresata |
|
e-mail
|
Adres e-mail odbiorcy |
CaseFileDetails
Szczegóły pliku sprawy pobranego z bezpiecznego archiwum Penneo.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
userId
|
userId | integer |
Identyfikator użytkownika, który jest właścicielem pliku sprawy. |
|
customerId (identyfikator klienta)
|
customerId | integer |
Identyfikator klienta, do którego należy plik sprawy. |
|
Sygnatariuszy
|
signers | array of SignerDetails |
Lista osób podpisujących w pliku sprawy. |
|
identyfikator
|
id | integer |
Identyfikator pliku sprawy. |
|
title
|
title | string |
Tytuł pliku sprawy. |
|
stan
|
status | integer |
Stan pliku sprawy. |
|
Dokumenty
|
documents | array of DocumentDetails |
Lista dokumentów w pliku sprawy. |
|
wygaśnięć
|
expireAt | integer |
Sygnatura czasowa systemu UNIX, gdy plik sprawy wygaśnie. |
|
ccRecipients
|
ccRecipients | array of CcRecipient |
Lista adresatów CC, którzy otrzymują kopię podpisanych dokumentów. |
|
utworzone
|
created | integer |
Sygnatura czasowa systemu UNIX podczas tworzenia pliku sprawy. |
|
aktywowano
|
activated | integer |
Sygnatura czasowa systemu UNIX, gdy plik sprawy został aktywowany. |
|
aktualizowano
|
updated | integer |
Sygnatura czasowa systemu UNIX, gdy plik sprawy został ostatnio zaktualizowany. |
|
zakończono
|
completed | integer |
Sygnatura czasowa systemu UNIX po zakończeniu pliku sprawy. |
SignerDetails
Signer w pliku sprawy.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
name
|
name | string |
Nazwa osoby podpisającego. |
|
identyfikator
|
id | integer |
Identyfikator użytkownika podpisającego. |
|
signingRequest
|
signingRequest | SigningRequestDetails |
Żądanie podpisania skojarzone z podpisem. |
SigningRequestDetails
Żądanie podpisania skojarzone z podpisem.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator żądania podpisania. |
|
e-mail
|
string |
Adres e-mail sygnatariusza. |
|
|
stan
|
status | integer |
Stan żądania podpisania. |
DocumentDetails
Dokument w pliku sprawy.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator dokumentu. Użyj tego polecenia, aby pobrać dokument z akcją "Pobierz dokument". |
|
stan
|
status | integer |
Stan dokumentu. |
|
możliwość podpisywania
|
signable | boolean |
Wartość True, jeśli dokument jest możliwy do podpisania. |
DocumentContent
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zawartość dokumentu
|
content | byte |
Zakodowana zawartość dokumentu w formacie Base64. |