Certyneo (wersja zapoznawcza)
Wysyłaj dokumenty do podpisu elektronicznego zgodnego ze standardem eIDAS, twórz koperty na podstawie szablonów i wyzwalaj przepływy zdarzeń podpisu, takich jak wysłane, podpisane, zakończone i odrzucone.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Name | Obsługa certyneo |
| adres URL | https://certyneo.com/fr/contact |
| support@certyneo.com |
| Metadane łącznika | |
|---|---|
| Publisher | Certyneo |
| Witryna internetowa | https://certyneo.com |
| Zasady ochrony prywatności | https://certyneo.com/fr/legal/privacy |
| Kategorie | Operacje IT; Produktywność |
Certyneo
Certyneo to usługa podpisu elektronicznego zgodna ze standardem eIDAS. Ten łącznik umożliwia przepływowi wysyłanie dokumentów do podpisu, reagowanie w czasie rzeczywistym, gdy podpisuje działanie, a także przesyłanie podpisanego pliku PDF i jego pliku dowodowego wszędzie tam, gdzie pozostała część firmy przechowuje swoje zapisy.
Typowy przepływ to trzy kroki: dokument ląduje gdzieś (biblioteka dokumentów, skrzynka pocztowa, przesyłanie formularza), przepływ tworzy i wysyła kopertę, a drugi przepływ wyzwalany przez envelope.completed pobranie podpisanego pliku PDF i zapisze go.
Publisher
Certyneo
Prerequisites
Potrzebujesz konta Certyneo w planie obejmującym dostęp do interfejsu API. Plany bezpłatne i osobiste mogą tworzyć klucze interfejsu API i subskrybować zdarzenia, ale tylko zawsze odbierają zdarzenia dla kopert piaskownicy — zobacz Znane problemy i ograniczenia poniżej.
Jak uzyskać poświadczenia
Łącznik uwierzytelnia się przy użyciu klucza interfejsu API Certyneo.
- Zaloguj się do aplikacji Certyneo i otwórz pozycję Ustawienia → klucze interfejsu API.
- Utwórz klucz. Klucze na żywo zaczynają się od
sk_live_, klucze piaskownicy za pomocą poleceniask_test_. - Gdy łącznik wyświetli monit o klucz interfejsu API, wklej wyraz
Bearer, spację, a następnie klucz — na przykładBearer sk_live_abc123. Certyneo oczekuje słowaBearerprzed kluczem, a klucz wklejony samodzielnie jest odrzucany z 401.
Klucz zawiera zakresy. Klucz bez envelopes:write możliwości utworzenia lub wysłania i klucza bez webhooks:write możliwości zwrotu wyzwalacza. Przyznaj zakresy, których przepływ faktycznie potrzebuje.
Testowanie bez konieczności pisania wiadomości e-mail
Klucz piaskownicy (sk_test_) wykonuje cały potok bez wysyłania pojedynczej wiadomości e-mail z zaproszeniem. Nic nie dociera do prawdziwej skrzynki odbiorczej, co oznacza również, że nikt nie może uzyskać dostępu do strony podpisywania z wiadomości e-mail — dlatego zamiast tego utwórz kopertę i Wyślij kopertę zwróć token dostępu dla każdego adresata. Otwórz https://certyneo.com/sign/<access token> , aby samodzielnie podpisać kopertę testowa.
Traktuj ten token jako poświadczenie: każda osoba trzymająca go może podpisać jako odbiorcę. Nie rejestruj go i nie upuść go do arkusza kalkulacyjnego.
Obsługiwane operacje
Trigger
Gdy wystąpi zdarzenie koperty — uruchamia się na wybranych zdarzeniach, wspieranych przez prawdziwy element webhook, a nie sondowanie. Dostępne zdarzenia:
envelope.created, envelope.sent, , envelope.completed, envelope.voidedenvelope.resubmittedenvelope.declinedenvelope.returned_to_senderrecipient.signedenvelope.expired, recipient.viewed, . recipient.approved
Każdy ładunek niesie ze sobą identyfikator koperty zarówno w przypadku zdarzeń koperty, jak i adresata. Jest to wartość, która ma być wprowadzana do poniższych akcji.
Dostawy są podpisane przy użyciu HMAC-SHA256 w nagłówku X-Certyneo-Signature — skrót szesnastkowy nieprzetworzonej treści JSON, kluczem tajnym subskrypcji. Sprawdź go, zanim przepływ działa na ładunku.
Actions
| Akcja | Do czego służy |
|---|---|
| Szablony list | Zapisane szablony kopert. Obsługuje selektor szablonu. |
| Tworzenie koperty | Tworzy kopertę DRAFT na podstawie szablonu lub z przekazanych dokumentów. |
| Wyślij kopertę | Wysyła kopertę DRAFT do swoich adresatów. |
| Pobierz kopertę | Bieżący stan i szczegóły adresata. |
| Listy kopert | Lista z podziałem na strony, filtrowana według stanu. |
| Przekazywanie dokumentu | Przekazuje plik PDF lub obraz i zwraca identyfikator dokumentu. |
| Pobieranie podpisanego dokumentu | Podpisany plik PDF, strona certyfikatu dołączona. |
| Pobieranie dziennika inspekcji | Plik dowodowy: kto podpisał, kiedy, z którego adresu IP, z jakim czynnikiem. |
| Usuń wersję roboczą koperty | Usuwa kopertę, która nigdy nie została wysłana. |
Znane problemy i ograniczenia
Nie można odwołać wysłanej koperty z przepływu.Usuwanie koperty wersji roboczej akceptuje tylko koperty nadal w wersji ROBOCZEJ — przepływ, który zakończył się niepowodzeniem w połowie, nieprawidłowy dokument. Po wyjęcie koperty zwraca wartość 409 i obecnie nie ma operacji anulowania w interfejsie API.
recipient.signed przed utworzeniem podpisanego pliku PDF, w tym dla ostatniego podpisu. Montaż i uszczelnianie końcowego dokumentu odbywa się po tym zdarzeniu, więc przepływ wyzwalający recipient.signed i natychmiast wywołuje polecenie Pobierz podpisany dokument jest 409 za każdym razem. To nie jest wyścig, który można wygrać z opóźnieniem — wyzwalacz na envelope.completed , który jest uruchamiany, gdy plik PDF jest na dysku.
Plany bezpłatne i osobiste otrzymują tylko zdarzenia piaskownicy. Zarówno może utworzyć subskrypcję, jak i wyzwalacz będzie wyświetlany jako w dobrej kondycji, ale aktywne koperty nigdy nie docierają do niej. Jeśli wyzwalacz wydaje się nie robić nic na rzeczywistym ruchu, sprawdź plan przed czymkolwiek innym.
Użyj szablonu lub dokumentów, nigdy nie używaj obu tych elementów. Szablon udostępnia własne dokumenty i własne pola podpisu. Podczas kompilowania z przekazanych dokumentów należy również podać pola — kopertę, której podpis nie ma gdzie podpisać, jest odrzucany w czasie wysyłania z 409 signer_without_field, a nie w czasie tworzenia.
Preferuj tekst kotwicy nad współrzędnymi. Umieszczenie pola przez cytowanie frazy z dokumentu ("Klient Signature du") przetrwa zmianę układu i nie wymaga pomiaru. Wartości X i Y pozostają jako rezerwowe, więc pole, którego kotwica nie znajduje się, utrzymuje pozycję literału zamiast znikać.
Przekazywanie jest ograniczone do 50 MB na dokument.
Przeczyszczony dokument zwraca wartość 410, a nie 409. 409 oznacza "jeszcze nie jest gotowy, wróć po envelope.completed". 410 oznacza, że podpisany dokument został celowo usunięty w ramach zasad przechowywania i nigdy nie wraca. Pętla ponawiania prób powinna zrezygnować z 410.
Typowe błędy i środki zaradcze
| Odpowiedź | Przyczyna | Rozwiązanie |
|---|---|---|
| 401 | Brak klucza lub wklejony z Bearer przodu |
Wprowadź ponownie połączenie jako Bearer sk_live_... |
| 403 | Klucz nie ma zakresu dla tej operacji | Ponownie wydaj klucz przy użyciu zakresów, których potrzebuje przepływ |
| 409 podczas pobierania | Koperta nie została jeszcze ukończona |
envelope.completed Wyzwalacz zamiast sondowania |
| 409 przy wysyłaniu |
signer_without_field — użytkownik podpisów nie ma pola podpisu |
Dodawanie pól lub kompilowanie na podstawie szablonu |
| 409 po usunięciu | Koperta została już wysłana | Nie można usunąć ani odwołać wysłanych kopert |
| 410 podczas pobierania | Dokument został przeczyszowany w ramach zasad przechowywania | Zatrzymaj ponawianie próby; plik zniknął |
Błędy niosą zarówno czytelny dla człowieka error komunikat, jak i stabilny code. Gałąź on code — można zmienić kolejność komunikatu.
Support
- Dokumentacja: https://certyneo.com/developers
- Dokumentacja elementu webhook: https://certyneo.com/developers/webhooks
- Wsparcie: https://certyneo.com/support
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Required |
|---|---|---|---|
| Klucz API | securestring | Klucz interfejsu API dla tego interfejsu API | True |
Akcje
| Listy kopert |
Pobierz listę kopert z podziałem na strony. |
| Pobieranie dziennika inspekcji |
Pobierz plik dowodowy dla ukończonej koperty — kto podpisał, kiedy, z którego adresu IP, z którym czynniki uwierzytelniania. Zarchiwizuj go obok podpisanego pliku PDF: jest to, co włącza spór eIDAS. |
| Pobieranie podpisanego dokumentu |
Pobierz podpisany plik PDF, dołączono stronę certyfikatu. Tylko po zakończeniu koperty — przed zwróceniem wartości 409, dlatego w polu "Koperta ukończona", zamiast sondowania. |
| Pobierz kopertę |
Uzyskaj bieżący stan i szczegóły koperty. |
| Przekazywanie dokumentu |
Przekaż plik PDF lub obraz (maksymalnie 50 MB). Zwraca identyfikator dokumentu — przekaż go do pozycji "Utwórz kopertę" w obszarze "Dokumenty". |
| Szablony list |
Zwraca zapisane szablony kopert. Służy do zasilania selektora szablonów w obszarze "Utwórz kopertę". |
| Tworzenie koperty |
Utwórz nową kopertę w stanie WERSJA ROBOCZa z zapisanego szablonu lub bezpośrednio z dokumentów przekazanych za pomocą polecenia "Przekaż dokument". Wypełnij dokładnie jeden z "Szablon" lub "Dokumenty". W przypadku dokumentów dodaj również "Pola", aby każdy podpisujący mógł się podpisać — najprostszym sposobem jest zacytowanie frazy z dokumentu w dokumencie "Anchor text" zamiast wypracowania współrzędnych. WAŻNE: ta akcja tworzy tylko kopertę — żadna wiadomość e-mail nie została jeszcze wysłana. Dodaj akcję "Wyślij kopertę" bezpośrednio po tej akcji w przepływie, aby rzeczywiście wysłać ją do adresatów. |
| Usuń wersję roboczą koperty |
Usuń kopertę, która nigdy nie została wysłana — przepływ, który zakończył się niepowodzeniem w połowie, nieprawidłowy dokument. Tylko wersja robocza: po wyjęcie koperty zwraca błąd i nie można odwołać go z przepływu. |
| Wyślij kopertę |
Wyślij kopertę DRAFT do swoich adresatów na potrzeby podpisu — jest to krok, który faktycznie wysyła wiadomość e-mail. "Utwórz kopertę" zapisuje ją tylko jako wersję roboczą; nie wysyła niczego samodzielnie. Zawsze utwórz łańcuch tej akcji bezpośrednio po utworzeniu koperty w przepływie przy użyciu zwróconego identyfikatora koperty. |
Listy kopert
Pobierz listę kopert z podziałem na strony.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Która strona wyników ma być zwracana. Zaczyna się od 1. |
|
|
Rozmiar strony
|
limit | integer |
Ile kopert ma być zwracanych na stronę. |
|
|
Status
|
status | string |
Zwróć tylko koperty w tym stanie. Pozostaw wartość pustą, aby zwrócić każdy stan. |
Zwraca
- Body
- EnvelopeList
Pobieranie dziennika inspekcji
Pobierz plik dowodowy dla ukończonej koperty — kto podpisał, kiedy, z którego adresu IP, z którym czynniki uwierzytelniania. Zarchiwizuj go obok podpisanego pliku PDF: jest to, co włącza spór eIDAS.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
id | True | string |
Identyfikator koperty, której dziennik inspekcji chcesz pobrać. |
Zwraca
- response
- binary
Pobieranie podpisanego dokumentu
Pobierz podpisany plik PDF, dołączono stronę certyfikatu. Tylko po zakończeniu koperty — przed zwróceniem wartości 409, dlatego w polu "Koperta ukończona", zamiast sondowania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
id | True | string |
Identyfikator koperty, której podpisany dokument chcesz pobrać. |
Zwraca
- response
- binary
Pobierz kopertę
Uzyskaj bieżący stan i szczegóły koperty.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
id | True | string |
Identyfikator koperty do pobrania. |
Zwraca
- Body
- Envelope
Przekazywanie dokumentu
Przekaż plik PDF lub obraz (maksymalnie 50 MB). Zwraca identyfikator dokumentu — przekaż go do pozycji "Utwórz kopertę" w obszarze "Dokumenty".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
File
|
file | True | file |
Plik PDF lub obraz do przekazania, co najwyżej 50 MB. |
|
Nazwa dokumentu
|
name | string |
Nazwa pliku dokumentu w obszarze. Domyślnie jest to nazwa własna przekazanego pliku. |
Zwraca
- Body
- Document
Szablony list
Zwraca zapisane szablony kopert. Służy do zasilania selektora szablonów w obszarze "Utwórz kopertę".
Zwraca
- Body
- TemplateList
Tworzenie koperty
Utwórz nową kopertę w stanie WERSJA ROBOCZa z zapisanego szablonu lub bezpośrednio z dokumentów przekazanych za pomocą polecenia "Przekaż dokument". Wypełnij dokładnie jeden z "Szablon" lub "Dokumenty". W przypadku dokumentów dodaj również "Pola", aby każdy podpisujący mógł się podpisać — najprostszym sposobem jest zacytowanie frazy z dokumentu w dokumencie "Anchor text" zamiast wypracowania współrzędnych. WAŻNE: ta akcja tworzy tylko kopertę — żadna wiadomość e-mail nie została jeszcze wysłana. Dodaj akcję "Wyślij kopertę" bezpośrednio po tej akcji w przepływie, aby rzeczywiście wysłać ją do adresatów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Temat
|
subject | True | string |
Temat/tytuł koperty. |
|
Message
|
message | string |
Wiadomość wyświetlana adresatom. |
|
|
Template
|
templateId | string |
Wybierz zapisany szablon. Użyj tego lub "Dokumenty", a nie obu — szablon udostępnia własne dokumenty i pola podpisu. |
|
|
Documents
|
documentIds | array of string |
Identyfikatory dokumentów z "Przekaż dokument". Użyj tego lub "szablonu", a nie obu tych elementów. W przypadku korzystania z dokumentów dodaj też "Pola" — kopertę, której podpis nie ma pola podpisu, nie zostanie odrzucone w czasie wysyłania. |
|
|
Adres e-mail sygnatariusza
|
recipientEmail | True | string |
Musi dokładnie odpowiadać jednemu z powyższych adresatów. |
|
Numer dokumentu
|
documentIndex | integer |
Który dokument zawiera to pole, licząc od 0 w podanej powyżej kolejności. Pozostaw wartość pustą, gdy istnieje tylko jeden dokument. |
|
|
Strona
|
pageNumber | True | integer | |
|
Typ pola
|
fieldType | True | string | |
|
Tekst kotwicy (zalecane)
|
anchorText | string |
Tekst do wyszukania w dokumencie — pole jest umieszczone obok niego, więc nie potrzebujesz współrzędnych. Bez uwzględniania wielkości liter i znaleziono nawet wtedy, gdy plik PDF dzieli frazę między przebiegami. Pozostaw wartość pustą, aby zamiast tego użyć wartości X/Y. |
|
|
Umieszczanie zakotwiczenia
|
anchorPlacement | string |
Gdzie umieścić pole względem tekstu zakotwiczonego. |
|
|
Wystąpienie kotwicy
|
anchorIndex | integer |
Którego wystąpienia należy użyć, licząc od 0, gdy tekst kotwicy pojawia się kilka razy. |
|
|
X
|
x | True | number |
Punkty z lewej krawędzi. Ignorowane po znalezieniu kotwicy — przechowywane jako rezerwowe, więc pole nigdy nie zniknie. |
|
Y
|
y | True | number |
Punkty z górnej krawędzi. Ignorowane po znalezieniu kotwicy — przechowywane jako rezerwowe. |
|
Szerokość
|
width | True | number | |
|
Wysokość
|
height | True | number | |
|
Adres e-mail adresata
|
True | string | ||
|
Imię i nazwisko adresata
|
name | string | ||
|
Rola
|
role | string | ||
|
stan
|
status | string | ||
|
signedAt
|
signedAt | string | ||
|
Token dostępu
|
accessToken | string |
Otwiera stronę podpisywania tego adresata na tokeniehttps://certyneo.com/sign/<>. W piaskownicy nie wychodzi wiadomość e-mail z zaproszeniem, więc tak samodzielnie podpisujesz kopertę testową. Zwracane przez "Utwórz kopertę" i "Wyślij kopertę" — a nie przez "Pobierz kopertę", gdzie pozostaje puste. Traktuj je jako poświadczenia: każda osoba przechowując ją może podpisać jako ten odbiorca, więc nie rejestruj go ani nie upuść w arkuszu kalkulacyjnym. |
|
|
Poziom podpisu
|
signatureLevel | string | ||
|
Wygasa o
|
expiresAt | date-time | ||
|
Kategoria
|
category | string |
Klasyfikacja biznesowa wyświetlana na liście kopert. Pozostaw puste i Certyneo wywnioskuje jeden z tematu. |
|
|
Tagi
|
tags | array of string |
Etykiety dowolnych formularzy — kod projektu, dokumentacja klienta, stan wewnętrzny. Maksymalnie 10 znaków, z których każdy składa się z maksymalnie 40 znaków. Małe i zduplikowane po stronie serwera. |
|
|
Język
|
locale | string |
Język wszystkiego, co widzi podpisujący: strona podpisywania, zaproszenie, przypomnienia, wiadomość e-mail z ukończeniem. Kod BCP-47, np. nl, nl-BE, en-GB, de, fr. Pozostaw puste, aby dziedziczyć język konta Certyneo wysyłającego kopertę. Nieobsługiwany kod jest odrzucany z 400. |
|
|
Adres przekierowania URL
|
redirectUrl | string |
Gdzie podpisujący jest wysyłany po podpisaniu. Zastępuje domyślny przycisk Certyneo call-to-action pojedynczym przyciskiem "Kontynuuj" wskazującym tutaj. Musi zaczynać się od https:// — wszystkie inne elementy są odrzucane z 400. |
|
|
Inicjały na każdej stronie
|
initialsOnEveryPage | boolean |
Automatycznie oznaczaj inicjały podpisów u dołu każdej strony każdego dokumentu, oprócz każdego pola, które umieszczasz samodzielnie. Nie jest wymagana żadna konfiguracja poszczególnych stron — sygnatariusz wypełnia swoje inicjały raz i stosuje go wszędzie. Pomija stronę, na której ten podpis ma już pole (np. podpis na ostatniej stronie). |
|
|
Workspace
|
workspaceId | string |
Utwórz kopertę w udostępnionym obszarze roboczym, aby każdy członek tego obszaru roboczego mógł go zobaczyć i śledzić. Pozostaw wartość pustą, aby zachować ją na własnym koncie. Musisz być właścicielem obszaru roboczego lub być jego członkiem. |
Zwraca
- Body
- Envelope
Usuń wersję roboczą koperty
Usuń kopertę, która nigdy nie została wysłana — przepływ, który zakończył się niepowodzeniem w połowie, nieprawidłowy dokument. Tylko wersja robocza: po wyjęcie koperty zwraca błąd i nie można odwołać go z przepływu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
id | True | string |
Identyfikator koperty roboczej do usunięcia. |
Zwraca
- Body
- DeleteResult
Wyślij kopertę
Wyślij kopertę DRAFT do swoich adresatów na potrzeby podpisu — jest to krok, który faktycznie wysyła wiadomość e-mail. "Utwórz kopertę" zapisuje ją tylko jako wersję roboczą; nie wysyła niczego samodzielnie. Zawsze utwórz łańcuch tej akcji bezpośrednio po utworzeniu koperty w przepływie przy użyciu zwróconego identyfikatora koperty.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
id | True | string |
Identyfikator koperty roboczej do wysłania do adresatów. |
Zwraca
- Body
- Envelope
Wyzwalacze
| Gdy wystąpi zdarzenie koperty |
Wyzwala przepływ za każdym razem, gdy jedno z wybranych zdarzeń odbywa się na dowolnych kopertach (np. podpisanych, ukończonych, odrzuconych). Wspierane przez element webhook w czasie rzeczywistym — bez sondowania. |
Gdy wystąpi zdarzenie koperty
Wyzwala przepływ za każdym razem, gdy jedno z wybranych zdarzeń odbywa się na dowolnych kopertach (np. podpisanych, ukończonych, odrzuconych). Wspierane przez element webhook w czasie rzeczywistym — bez sondowania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Events
|
events | True | array of string |
Które zdarzenia koperty/adresata powinny wyzwolić ten przepływ. |
Zwraca
Dostarczono podpisany przy użyciu HMAC-SHA256 w nagłówku X-Certyneo-Signature (skrót szesnastkowy nieprzetworzonej treści JSON, kluczem tajnym subskrypcji). Przed zaufaniem ładunku w przepływie, który działa na nim (zobacz /developers/webhooks).
- Body
- WebhookEventPayload
Definicje
DeleteResult
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Powodzenie
|
success | boolean |
Wartość true, gdy zasób został usunięty. |
Paginacja
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączny
|
total | integer | |
|
page
|
page | integer | |
|
pageSize
|
pageSize | integer | |
|
pages
|
pages | integer |
Template
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
nazwa
|
name | string | |
|
opis
|
description | string | |
|
signerCount
|
signerCount | integer | |
|
documentCount
|
documentCount | integer |
Lista szablonów
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of Template | |
|
dzielenie na strony
|
pagination | Pagination |
Recipient
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres e-mail adresata
|
string | ||
|
Imię i nazwisko adresata
|
name | string | |
|
Rola
|
role | string | |
|
stan
|
status | string | |
|
signedAt
|
signedAt | string | |
|
Token dostępu
|
accessToken | string |
Otwiera stronę podpisywania tego adresata na tokeniehttps://certyneo.com/sign/<>. W piaskownicy nie wychodzi wiadomość e-mail z zaproszeniem, więc tak samodzielnie podpisujesz kopertę testową. Zwracane przez "Utwórz kopertę" i "Wyślij kopertę" — a nie przez "Pobierz kopertę", gdzie pozostaje puste. Traktuj je jako poświadczenia: każda osoba przechowując ją może podpisać jako ten odbiorca, więc nie rejestruj go ani nie upuść w arkuszu kalkulacyjnym. |
Dokument
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
nazwa
|
name | string | |
|
Mimetype
|
mimeType | string | |
|
size
|
size | integer | |
|
stan
|
status | string |
Koperta
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
subject
|
subject | string | |
|
komunikat
|
message | string | |
|
stan
|
status | string | |
|
signatureLevel
|
signatureLevel | string | |
|
recipients
|
recipients | array of Recipient | |
|
expiresAt
|
expiresAt | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string |
Lista kopert
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of Envelope | |
|
dzielenie na strony
|
pagination | Pagination |
Element webhookEventPayload
Dostarczono podpisany przy użyciu HMAC-SHA256 w nagłówku X-Certyneo-Signature (skrót szesnastkowy nieprzetworzonej treści JSON, kluczem tajnym subskrypcji). Przed zaufaniem ładunku w przepływie, który działa na nim (zobacz /developers/webhooks).
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wydarzenie
|
event | string | |
|
sygnatura czasowa
|
timestamp | date-time | |
|
Identyfikator koperty
|
data.envelopeId | string |
Zawsze dostępny. Przekaż go do "Pobierz kopertę" lub "Pobierz podpisany dokument". |
|
Temat
|
data.subject | string |
Prezentuj tylko na zdarzeniach koperty. |
|
Status
|
data.status | string | |
|
Poziom podpisu
|
data.signatureLevel | string |
Prezent na koperty.completed i recipient.signed. |
|
Zaawansowane osoby podpisające podpis z kluczem osobistym
|
data.aesSignerCount | integer |
koperta.ukończona tylko na kopercie ADVANCED. |
|
Zaawansowany certyfikat sygnatury szeregowej
|
data.aesCertificateSerial | string |
recipient.signed, gdy osoba podpisywana przy użyciu osobistego klucza zaawansowanego podpisu. |
|
Zaawansowany certyfikat podpisu SHA256
|
data.aesCertificateSha256 | string |
recipient.signed, gdy osoba podpisywana przy użyciu osobistego klucza zaawansowanego podpisu. |
|
Zaawansowany manifest podpisu SHA256
|
data.aesManifestSha256 | string |
recipient.signed, gdy osoba podpisywana przy użyciu osobistego klucza zaawansowanego podpisu. |
|
Znacznik czasu sygnatury zaawansowanej
|
data.aesTimestamped | boolean |
recipient.signed, gdy osoba podpisywana przy użyciu osobistego klucza zaawansowanego podpisu. |
|
Liczba adresatów
|
data.recipientCount | integer |
Prezentuj tylko na zdarzeniach koperty. |
|
Liczba podpisanych znaków
|
data.signedCount | integer |
Prezentuj tylko na zdarzeniach koperty. |
|
Identyfikator adresata
|
data.recipientId | string |
Prezentuj tylko na zdarzeniach adresatów. |
|
Adres e-mail adresata
|
data.email | string |
Prezentuj tylko na zdarzeniach adresatów. |
|
Imię i nazwisko adresata
|
data.name | string |
Prezentuj tylko na zdarzeniach adresatów. |
|
Rola adresata
|
data.role | string |
Prezentuj tylko na zdarzeniach adresatów. |
|
Podpisany pod adresem
|
data.signedAt | date-time |
Prezentuj tylko na zdarzeniach adresatów. |
|
Wyświetlane pod adresem
|
data.viewedAt | date-time |
Prezentuj tylko na zdarzeniach adresatów. |
binarny
Jest to podstawowy typ danych "binary".