SignNow EU (wersja zapoznawcza)
Usługa SignNow umożliwia bezpieczne, zgodne i gotowe do inspekcji przepływy pracy eSignature dla firm, prawnych, kadr, opieki zdrowotnej i zespołów finansowych. Wysyłaj i śledź żądania podpisów w polach dokumentów opartych na rolach, wstępnie wypełniaj dokumenty i zarządzaj nimi przy użyciu łącznika SignNow.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Centrum pomocy |
| adres URL | https://support.signnow.com/ |
| integrations@pdffiller.com |
| Metadane łącznika | |
|---|---|
| Publisher | DaDaDocs |
| Witryna internetowa | https://signnow.com |
| Zasady ochrony prywatności | https://www.signnow.com/privacy_policy |
| Kategorie | Produktywność; Zasoby ludzkie |
Łącznik SignNow EU
Usługa SignNow umożliwia bezpieczne, zgodne i gotowe do inspekcji przepływy pracy eSignature dla firm, prawnych, kadr, opieki zdrowotnej i zespołów finansowych. Wysyłaj i śledź żądania podpisów w polach dokumentów opartych na rolach, wstępnie wypełniaj dokumenty i zarządzaj nimi przy użyciu łącznika SignNow.
Pre-requisites
Aby kontynuować, musisz mieć konto SignNow EU (wybierz pozycję Serwer UE na ekranie logowania) i subskrypcję interfejsu API SignNow.
Wdrażanie przykładu
Najpierw zaktualizuj wartość clientId we własnym apiProperties.json.
Uruchom następujące polecenia i postępuj zgodnie z monitami:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
Obsługiwane akcje i wyzwalacze
Aby uzyskać więcej informacji, zobacz dokumentację .
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Anuluj zaproszenie |
Anulowanie zaproszenia do podpisu |
| Generowanie linku zaproszenia osadzonego dokumentu |
Ta akcja generuje link dla zaproszenia osadzonego dokumentu |
| Generowanie osadzonego linku zapraszania grupy dokumentów |
Ta akcja generuje link dla osadzonego zaproszenia grupy dokumentów |
| Pobieranie grup dokumentów |
Pobieranie listy grup dokumentów użytkownika |
| Pobieranie grupy dokumentów |
Pobieranie listy grup dokumentów użytkownika |
| Pobieranie listy dokumentów |
Pobieranie listy dokumentów użytkownika |
| Pobieranie pól dokumentu (wersja zapoznawcza) |
Pobieranie wartości z pól, które można wypełnić w dokumencie |
| Pobieranie pól dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz pola dokumentu .
|
| Pobieranie schematu dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz schemat dokumentu .
|
| Pobierz dokument |
Pobieranie dokumentu z aplikacji SignNow |
| Przekazywanie dokumentu |
Przekazywanie dokumentu do aplikacji SignNow |
| Przestarzałe — zaawansowane zaproszenie do dokumentu |
Akcja jest przestarzała. Zaproś żądanie przy użyciu ręcznie zdefiniowanego schematu. Umożliwia skonfigurowanie zaproszenia do dokumentu, który zostanie wygenerowany w przyszłości |
| Przestarzałe — zaproszenie do podpisania |
Akcja jest przestarzała. Zaproś inne osoby do wypełnienia i podpisania dokumentu |
| Przestarzałe — zaproszenie do podpisania grupy dokumentów |
Akcja jest przestarzała. Zaproś inne osoby do wypełnienia i podpisania grupy dokumentów |
| Tworzenie dokumentu na podstawie szablonu |
Generowanie dokumentu na podstawie wybranego szablonu |
| Tworzenie grupy dokumentów na podstawie szablonu grupy |
Tworzenie grupy dokumentów na podstawie wybranego szablonu grupy |
| Tworzenie grupy dokumentów na podstawie wielu plików |
Tworzenie grupy dokumentów przez przekazanie wielu plików jako ciągów zakodowanych w formacie base64 |
| Tworzenie linku podpisywania |
Generowanie linku do dokumentu i udostępnianie go w celu podpisania dokumentu |
| Tworzenie linku wysyłania osadzonego dokumentu |
Ta akcja generuje osadzony link wysyłający dla określonego dokumentu, umożliwiając użytkownikom innych firm przygotowanie i wysłanie dokumentu do podpisu |
| Tworzenie osadzonego linku wysyłania grupy dokumentów |
Ta akcja generuje osadzony link wysyłający dla określonej grupy dokumentów, umożliwiając użytkownikom innych firm przygotowanie i wysłanie grupy dokumentów do podpisu |
| Tworzenie osadzonego zaproszenia grupy dokumentów |
Ta akcja powoduje utworzenie osadzonego zaproszenia podpisywania dla grupy dokumentów. Po utworzeniu zaproszenia wygeneruj osadzony link podpisywania |
| Tworzenie zaproszenia osadzonego dokumentu |
Ta akcja powoduje utworzenie osadzonego zaproszenia podpisywania dla dokumentu. Po utworzeniu zaproszenia wygeneruj osadzony link podpisywania |
| Usuwanie zaproszenia osadzonego dokumentu |
Ta akcja powoduje usunięcie osadzonego zaproszenia dla dokumentu |
| Usuń dokument |
Usuwanie dokumentu z aplikacji SignNow |
| Usuń osadzone zaproszenie grupy dokumentów |
Ta akcja powoduje usunięcie osadzonego zaproszenia dla określonej grupy dokumentów |
| Uzyskiwanie informacji o dokumencie |
Pobierz właściwości dokumentu, takie jak nazwa, identyfikator, daty tworzenia/aktualizowania itp. |
| Uzyskiwanie stanu zaproszenia do dokumentu |
Ta akcja pobiera informacje o zaproszeniu dokumentu, w tym o stanie każdego kroku i akcji |
| Uzyskiwanie stanu zaproszenia do grupy dokumentów |
Ta akcja pobiera informacje o zaproszeniu grupy dokumentów, w tym o stanie każdego kroku i akcji |
| Wstępne wypełnianie wartości pól dokumentu (wersja zapoznawcza) |
Automatyczne wypełnianie pól w dokumencie określonymi wartościami |
| Wstępne wypełnianie wartości pól dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj wstępnie wypełnianych wartości pól dokumentu .
|
| Wstępne wypełnianie wartości pól grupy dokumentów |
Automatyczne wypełnianie pól w dokumentach określonymi wartościami |
| Wstępne wypełnianie wartości pól inteligentnych |
Wstępne wypełnianie wartości pól inteligentnych dla określonego dokumentu |
| Wstępne wypełnianie wartości pól inteligentnych grupy dokumentów |
Automatyczne wypełnianie pól inteligentnych w dokumentach określonymi wartościami |
| Zamień adresatów na zaproszenie grupy dokumentów |
Ta akcja zastępuje adresatów w grupie dokumentów zaproszeń według identyfikatora zaproszenia. Można również ustawić wygasanie zaproszenia, przypomnienia, ponowne przypisywanie uprawnień i odrzucanie opcji dla każdego dokumentu |
| Zaproszenie do podpisania grupy dokumentów |
Ta akcja powoduje utworzenie zaproszenia do podpisania grupy dokumentów. Możesz skonfigurować wieloetapowy przepływ pracy, w którym różni adresaci działają w grupie dokumentów na różnych etapach |
| Zaproś do podpisania dokumentu |
Ta akcja tworzy i wysyła zaproszenie pola do podpisania dokumentu |
| Zastępowanie adresatów w zaproś do dokumentu |
Ta akcja zastępuje adresatów w zaproszeniu dokumentu na podstawie ich ról. Umożliwia również aktualizowanie ustawień zaproszenia, takich jak typ uwierzytelniania, dni wygaśnięcia i inne zaawansowane parametry dla każdej roli |
Anuluj zaproszenie
Anulowanie zaproszenia do podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie identyfikatora dokumentu na potrzeby anulowania zaproszenia do podpisu |
Zwraca
- response
- object
Generowanie linku zaproszenia osadzonego dokumentu
Ta akcja generuje link dla zaproszenia osadzonego dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Identyfikator zaproszenia pola
|
field_invite_id | True | string |
Osadzony identyfikator zaproszenia z akcji "Utwórz zaproszenie osadzonego dokumentu" |
|
Wygaśnięcie łącza
|
link_expiration | integer |
Określa, ile minut link pozostanie aktywny. Prawidłowy zakres:15–45 minut |
|
|
Wygaśnięcie sesji
|
session_expiration | integer |
Określa, ile minut sesja podpisywania pozostanie aktywna. Prawidłowy zakres:15–1440 minut |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Link
|
data.link | string |
Wygenerowany link zaproszenia osadzonego dla dokumentu |
Generowanie osadzonego linku zapraszania grupy dokumentów
Ta akcja generuje link dla osadzonego zaproszenia grupy dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
|
Identyfikator zaproszenia osadzonego grupy dokumentów
|
invite_id | True | string |
Identyfikator osadzonego zaproszenia grupy dokumentów z akcji "Utwórz osadzoną grupę dokumentów" |
|
Email
|
True |
Adres e-mail adresata |
||
|
Wygaśnięcie łącza
|
link_expiration | integer |
Określa, ile minut link pozostanie aktywny. Prawidłowy zakres:15–45 minut |
|
|
Wygaśnięcie sesji
|
session_expiration | integer |
Określa, ile minut sesja podpisywania pozostanie aktywna. Prawidłowy zakres:15–1440 minut |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Link zaproszenia osadzonego
|
link | string |
Link do osadzonego zaproszenia grupy dokumentów |
Pobieranie grup dokumentów
Pobieranie listy grup dokumentów użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Określ, czy należy pobrać grupy dokumentów lub szablony grup |
|
Ograniczenie
|
limit | integer |
Całkowita liczba zwróconych elementów (od 1 do 50) |
|
|
Przesunięcie
|
offset | integer |
Przesunięcie (na podstawie zera) pierwszego elementu w kolekcji w celu zwrócenia |
Zwraca
Pobieranie grupy dokumentów
Pobieranie listy grup dokumentów użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szablon grupy
|
doc_group_id | True | string |
Wybierz szablon grupy z listy |
|
Template
|
template | True | boolean |
Określ, czy należy pobrać grupę dokumentów lub szablon grupy |
Zwraca
Pobieranie listy dokumentów
Pobieranie listy dokumentów użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template | boolean |
Określ, czy dokumenty lub szablony mają być pobierane |
|
|
Dołącz szablon domyślny
|
includeDefaultTemplate | boolean |
Określ, czy szablon domyślny ma zostać dodany do listy szablonów |
Zwraca
- response
- array of DocumentProperties
Pobieranie pól dokumentu (wersja zapoznawcza)
Pobieranie wartości z pól, które można wypełnić w dokumencie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Określanie szablonu dokumentu do pobierania pól z |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
Zwraca
Pobieranie pól dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz pola dokumentu .
Pobieranie wartości pól dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Określanie szablonu dokumentu do pobierania pól z |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
Zwraca
Pobieranie schematu dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz schemat dokumentu .
Pobieranie schematu dokumentu OpenAPI
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | string |
Określanie unikatowego identyfikatora dokumentu |
|
|
Filtr typu pola
|
select | string |
Oddzielaj przecinkami, jakie typy pól chcesz pobrać |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
properties
|
properties | object |
Pobierz dokument
Pobieranie dokumentu z aplikacji SignNow
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | True | string |
Określ unikatowy identyfikator dokumentu lub wybierz dokument z listy |
|
Format
|
mode | string |
Wybieranie formatu dokumentu do pobrania |
Zwraca
- response
- binary
Przekazywanie dokumentu
Przekazywanie dokumentu do aplikacji SignNow
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
File
|
file | True | file |
Plik do przekazania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
Przestarzałe — zaawansowane zaproszenie do dokumentu
Akcja jest przestarzała. Zaproś żądanie przy użyciu ręcznie zdefiniowanego schematu. Umożliwia skonfigurowanie zaproszenia do dokumentu, który zostanie wygenerowany w przyszłości
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | True | string |
Podaj identyfikator dokumentu |
|
Name
|
role | string |
Nazwa roli osoby podpisającego |
|
|
E-mail
|
Określanie poczty e-mail dla użytkownika podpisjącego |
|||
|
Numer telefonu (zaproszenie za pośrednictwem wiadomości SMS)
|
phone_invite | string |
Określ numer telefonu odbiorcy +XXXXXXXXXXXX. Wymagane do zaproszenia za pośrednictwem wiadomości SMS. |
|
|
Zamówienie
|
order | integer |
Ustawianie kolejności podpisywania dla wielu osób podpisujących |
|
|
Spersonalizowany temat
|
subject | string |
Dodawanie spersonalizowanego tematu dla osoby podpisającego |
|
|
Spersonalizowana wiadomość
|
message | string |
Dodawanie spersonalizowanej wiadomości dla użytkownika podpisjącego |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Weryfikowanie tożsamości użytkownika za pośrednictwem hasła, wiadomości SMS lub połączenia telefonicznego |
|
|
Hasło
|
password | string |
Ustaw hasło dla typu uwierzytelniania Hasło |
|
|
Telefon
|
phone | string |
Określ numer telefonu +XXXXXXXXXXXX dla typu uwierzytelniania Telefon lub SMS |
|
|
Dni do wygaśnięcia
|
expiration_days | integer |
Otrzymuj powiadomienie o tym, ile dni wygasa zaproszenie |
|
|
Wyślij przypomnienie w
|
reminder | integer |
Liczba dni po wysłaniu zaproszenia w celu automatycznego wysłania przypomnienia e-mail |
|
|
Wyślij przypomnienie co X dni
|
remind_repeat | integer |
Odbiorca otrzyma wiadomość e-mail z przypomnieniem co zestaw dni. |
|
|
Zezwalaj na przekazywanie
|
reassign | boolean |
Zezwalaj użytkownikowi podpisującego na delegowanie podpisywania do innej osoby |
|
|
Pokaż odrzuć przy podpisie
|
decline_by_signature | boolean |
Oznaczanie pola podpisu jako Odrzuć do podpisania, jeśli odbiorca odmówił podpisania dokumentu |
|
|
napis
|
cc | string |
Wiadomości e-mail rozdzielone przecinkami, które będą kopiowane w zaproszeniu |
|
|
Temat
|
subject | string |
Wpisz temat |
|
|
Message
|
message | string |
Wpisz wiadomość |
|
|
Wyślij wiadomość e-mail na wszystkie strony po zakończeniu
|
on_complete | string |
Wszystkie strony otrzymują wiadomość e-mail z powiadomieniem po podpisaniu dokumentu |
Zwraca
- response
- object
Przestarzałe — zaproszenie do podpisania
Akcja jest przestarzała. Zaproś inne osoby do wypełnienia i podpisania dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Określ, czy dokumenty lub szablony mają być pobierane |
|
Dokument
|
template_id | True | string |
Wybierz szablon z listy |
|
body
|
body | True | dynamic |
Zwraca
- response
- object
Przestarzałe — zaproszenie do podpisania grupy dokumentów
Akcja jest przestarzała. Zaproś inne osoby do wypełnienia i podpisania grupy dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Określ, czy należy pobrać grupy dokumentów lub szablony grup |
|
Grupa dokumentów
|
template_group_id | True | string |
Wybierz grupę dokumentów z listy |
|
body
|
body | True | dynamic |
Zwraca
- response
- object
Tworzenie dokumentu na podstawie szablonu
Generowanie dokumentu na podstawie wybranego szablonu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szablon dokumentu
|
doc_id | True | string |
Wybierz szablon z listy |
|
Nazwa dokumentu
|
document_name | string |
Wprowadź nową nazwę pliku dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
Tworzenie grupy dokumentów na podstawie szablonu grupy
Tworzenie grupy dokumentów na podstawie wybranego szablonu grupy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szablon grupy
|
doc_group_id | True | string |
Wybierz szablon grupy z listy |
|
Nazwa grupy dokumentów
|
group_name | string |
Wprowadź nową nazwę grupy dokumentów |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | DocumentGroupId |
Unikatowy identyfikator grupy dokumentów |
Tworzenie grupy dokumentów na podstawie wielu plików
Tworzenie grupy dokumentów przez przekazanie wielu plików jako ciągów zakodowanych w formacie base64
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa grupy dokumentów
|
group_name | True | string |
Wprowadź nazwę grupy dokumentów |
|
Nazwa dokumentu
|
name | True | string |
Nazwa dokumentu z rozszerzeniem: Report.pdf, Letter.docx itp. |
|
Zawartość pliku
|
content | True | string |
Ciąg zakodowany w formacie Base64 reprezentujący zawartość dokumentu |
Zwraca
Tworzenie linku podpisywania
Generowanie linku do dokumentu i udostępnianie go w celu podpisania dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | True | string |
Określ unikatowy identyfikator dokumentu lub wybierz dokument z listy |
|
pola
|
fields | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
adres URL
|
url_no_signup | string |
Łącze podpisywania |
Tworzenie linku wysyłania osadzonego dokumentu
Ta akcja generuje osadzony link wysyłający dla określonego dokumentu, umożliwiając użytkownikom innych firm przygotowanie i wysłanie dokumentu do podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Typ
|
type | string |
Określa krok wysyłania, w którym powinien zostać otwarty link. Możliwe wartości: "Zaproś": otwiera stronę Wyślij zaproszenie dla dokumentu, gdzie użytkownik może dodawać wiadomości e-mail, temat, temat, wiadomość itp.: otwiera dokument w edytorze, aby dodać pola do wypełnienia, a następnie otwiera stronę Wyślij zaproszenie |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Strona, która zostanie otwarta po skonfigurowaniu osadzonego wysyłania. Wymagane, jeśli dodano element docelowy przekierowania |
|
|
Wygaśnięcie łącza
|
link_expiration | integer |
Określa, ile minut link pozostanie aktywny. Dozwolony zakres: od 15 do 45 minut. Użytkownicy na poziomie administratora mogą ustawić czas trwania maksymalnie 43200 minut |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
URL
|
url | string |
Link do osadzonego dokumentu wysyłającego |
Tworzenie osadzonego linku wysyłania grupy dokumentów
Ta akcja generuje osadzony link wysyłający dla określonej grupy dokumentów, umożliwiając użytkownikom innych firm przygotowanie i wysłanie grupy dokumentów do podpisu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
|
Typ
|
type | string |
Określa krok wysyłania, w którym powinien zostać otwarty link osadzony: "zarządzaj" — otwiera link na stronie Dodawanie dokumentów do grupy dokumentów; "edit": otwiera link w edytorze; "send-invite": otwiera link na stronie Wyślij zaproszenie |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Strona, która zostanie otwarta po skonfigurowaniu osadzonego wysyłania. Wymagane, jeśli dodano element docelowy przekierowania |
|
|
Wygaśnięcie łącza
|
link_expiration | integer |
Określa, ile minut link pozostanie aktywny. Dozwolony zakres: od 15 do 45 minut. Użytkownicy na poziomie administratora mogą ustawić czas trwania maksymalnie 43200 minut |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
URL
|
url | string |
Link do osadzonej grupy dokumentów wysyłającej |
Tworzenie osadzonego zaproszenia grupy dokumentów
Ta akcja powoduje utworzenie osadzonego zaproszenia podpisywania dla grupy dokumentów. Po utworzeniu zaproszenia wygeneruj osadzony link podpisywania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
|
Zamówienie
|
order | True | integer |
Krok podpisywania zamówienia. Wszyscy osoby podpisujących przypisane do określonego |
|
Email
|
True | string |
Adres e-mail adresata |
|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Role
|
role | string |
Rola adresata w dokumencie. Nie należy określać ról dla akcji "wyświetl" |
|
|
Akcja
|
action | True | string |
Akcja wymagana od adresata w dokumencie. Dozwolone wartości: "znak", "wyświetl" |
|
Zamówienie
|
order | True | string |
Krok podpisywania zamówienia |
|
Email
|
True | string |
Adres e-mail adresata |
|
|
Język
|
language | string |
Określa język sesji podpisywania i wiadomości e-mail z powiadomieniami dla użytkownika podpisującego. Możliwe wartości: En for English, Es for Spanish i Fr for French. Jeśli nie zostanie ustawiona, język jest określany przez język konta SignNow |
|
|
Imię
|
first_name | string |
Imię adresata |
|
|
Nazwisko
|
last_name | string |
Nazwisko adresata |
|
|
Wymagana wstępnie ustawiona nazwa podpisu
|
required_preset_signature_name | string |
Wstępnie wypełniony tekst pola podpisu, zablokowany do edycji przez adresata |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Link otwierany po zakończeniu sesji podpisywania |
|
|
Odrzuć identyfikator URI przekierowania
|
decline_redirect_uri | string |
Link otwierany po odrzuceniu podpisania dokumentu przez adresata |
|
|
Zamknij identyfikator URI przekierowania
|
close_redirect_uri | string |
Link otwierany po kliknięciu przez adresata przycisku Zapisz postęp i Zakończ później podczas sesji podpisywania lub Zamknij w trybie wyświetlania |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
|
|
Typ dostawy
|
delivery_type | string |
Definiuje sposób wysyłania zaproszenia |
|
|
Wygaśnięcie łącza
|
link_expiration | integer |
Ile minut wygasa zaproszenie e-mail. Można użyć tylko wtedy, gdy "Typ dostawy=wiadomość e-mail". Prawidłowy zakres: 15–43200 minut |
|
|
Wygaśnięcie sesji
|
session_expiration | integer |
Ile minut wygasa sesja podpisywania. Jeśli dla tego zaproszenia zostanie wygenerowany link, wygaśnięcie sesji zostanie zresetowane. Dotyczy tylko wtedy, gdy "Typ dostawy=wiadomość e-mail" i dla akcji "podpisz". Prawidłowy zakres: 15–1440 minut |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło uwierzytelniania
|
authentication_password | string |
Hasło ustawione na potrzeby uwierzytelniania użytkownika podpisjącego. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon uwierzytelniania
|
authentication_phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Wiadomość SMS z uwierzytelnianiem
|
authentication_sms_message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z wygenerowanym automatycznie hasłem (kod odblokowania) — "Dokument SignNow zaprasza kod odblokowywania: 123456". Przykład: wprowadź hasło {password} w celu odblokowania dokumentu |
|
|
Podpis QES
|
signature | string |
Typ QES. Możliwe wartości: "Eideasy", "Nom151". Służy do żądania podpisów QES od osób podpisujących. Wszyscy osoby podpisujących w zaproszeniu muszą używać tego samego typu podpisu. Aby utworzyć zaproszenie za pomocą QES, użytkownik musi należeć do organizacji z włączoną funkcją QES |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zaproszenia
|
id | string |
Identyfikator utworzonego osadzonego zaproszenia |
Tworzenie zaproszenia osadzonego dokumentu
Ta akcja powoduje utworzenie osadzonego zaproszenia podpisywania dla dokumentu. Po utworzeniu zaproszenia wygeneruj osadzony link podpisywania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Adres e-mail sygnatariusza
|
True |
Adres e-mail adresata |
||
|
Role
|
role | True | string |
Nazwa roli adresata, np. "Signer 1" (role osoby przeglądającego nie są obsługiwane) |
|
Zamówienie
|
order | True | integer |
Kolejność podpisywania |
|
Formuła nazwy
|
name_formula | string |
Formuła do wygenerowania ukończonej nazwy dokumentu przy użyciu prefiksu (dowolnego tekstu) i danych pól z możliwością wypełnienia. Przykład: "Contract|signer_name|signed_date", gdzie "Contract" jest prefiksem, a "signer_name" i "signed_date" to nazwy pól do wypełnienia |
|
|
Role
|
role | True | string |
Nazwa roli adresata, np. "Signer 1" (role osoby przeglądającego nie są obsługiwane) |
|
Język
|
language | string |
Określa język sesji podpisywania i wiadomości e-mail z powiadomieniami dla użytkownika podpisującego. Możliwe wartości: En for English, Es for Spanish i Fr for French. Jeśli nie zostanie ustawiona, język jest określany przez język konta SignNow |
|
|
Imię
|
first_name | string |
Imię adresata |
|
|
Nazwisko
|
last_name | string |
Nazwisko adresata |
|
|
Wymagana wstępnie ustawiona nazwa podpisu
|
required_preset_signature_name | string |
Wstępnie wypełniony tekst pola podpisu zablokowany do edycji przez adresata. Nie można używać z "prefill_signature_name" lub "force_new_signature" |
|
|
Wstępnego wypełniania nazwy podpisu
|
prefill_signature_name | string |
Ciąg z nazwą podpisu wyświetlaną po kliknięciu pola podpisu przez osoby podpisujące. Podpis może edytować podpis |
|
|
Wymagaj nowego podpisu
|
force_new_signature | boolean |
Określa, czy podpis może używać zapisanego podpisu, czy nie. W przypadku ustawienia wartości "true" podpis musi dodać nowy podpis. W przypadku ustawienia wartości "false" podpis może użyć zapisanego podpisu |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Link otwierany po zakończeniu sesji podpisywania |
|
|
Odrzuć identyfikator URI przekierowania
|
decline_redirect_uri | string |
Link otwierany po odrzuceniu podpisania dokumentu przez adresata |
|
|
Zamknij identyfikator URI przekierowania
|
close_redirect_uri | string |
Link otwierany po kliknięciu przez adresata przycisku Zapisz postęp i Zakończ później podczas sesji podpisywania lub Zamknij w trybie wyświetlania |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło uwierzytelniania
|
authentication_password | string |
Hasło ustawione na potrzeby uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon uwierzytelniania
|
authentication_phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Wiadomość SMS z uwierzytelnianiem
|
authentication_sms_message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z automatycznie wygenerowanym hasłem (kod odblokowania) — "Kod odblokowania zaproszenia dokumentu SignNow: 123456" Przykład: wprowadź hasło {password} w celu odblokowania dokumentu |
|
|
Typ dostawy
|
delivery_type | string |
Definiuje sposób wysyłania zaproszenia |
|
|
Wygaśnięcie łącza
|
link_expiration | integer |
Ile minut wygasa zaproszenie e-mail. Można użyć tylko wtedy, gdy "Typ dostawy=wiadomość e-mail". Prawidłowy zakres: 15–43200 minut |
|
|
Wygaśnięcie sesji
|
session_expiration | integer |
Ile minut wygasa sesja podpisywania. Jeśli dla tego zaproszenia zostanie wygenerowany link, wygaśnięcie sesji zostanie zresetowane. Dotyczy tylko wtedy, gdy "Typ dostawy=wiadomość e-mail" i dla akcji "podpisz". Prawidłowy zakres: 15–1440 minut |
|
|
Podpis QES
|
signature | string |
Typ QES. Możliwe wartości: "Eideasy", "Nom151". Służy do żądania podpisów QES od osób podpisujących. Wszyscy osoby podpisujących w zaproszeniu muszą używać tego samego typu podpisu. Aby utworzyć zaproszenie za pomocą QES, użytkownik musi należeć do organizacji z włączoną funkcją QES |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of object |
Dane |
|
Id
|
data.id | string |
Identyfikator utworzonego osadzonego zaproszenia |
|
Email
|
data.email | string |
Adres e-mail adresata |
|
Identyfikator roli
|
data.role_id | string |
Identyfikator roli adresata |
|
Zamówienie
|
data.order | integer |
Kolejność odbiorcy podpisywania |
|
Status
|
data.status | string |
Stan zaproszenia osadzonego |
Usuwanie zaproszenia osadzonego dokumentu
Ta akcja powoduje usunięcie osadzonego zaproszenia dla dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
Usuń dokument
Usuwanie dokumentu z aplikacji SignNow
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Stan usuwania dokumentu |
Usuń osadzone zaproszenie grupy dokumentów
Ta akcja powoduje usunięcie osadzonego zaproszenia dla określonej grupy dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
Uzyskiwanie informacji o dokumencie
Pobierz właściwości dokumentu, takie jak nazwa, identyfikator, daty tworzenia/aktualizowania itp.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template | True | boolean |
Określ, czy dokumenty lub szablony mają być pobierane |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określ unikatowy identyfikator dokumentu lub wybierz dokument z listy |
Zwraca
- Body
- DocumentProperties
Uzyskiwanie stanu zaproszenia do dokumentu
Ta akcja pobiera informacje o zaproszeniu dokumentu, w tym o stanie każdego kroku i akcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Odrzucono dokument
|
is_document_declined | boolean |
Prawda, jeśli dokument został odrzucony przez osoby podpisującego lub zatwierdzającego, w przeciwnym razie wartość false |
|
steps
|
steps | array of object |
Steps |
|
Kolejność podpisywania
|
steps.signing_order | integer |
Kolejność podpisywania |
|
Adres e-mail adresata
|
steps.signer_email | string |
Adres e-mail adresata |
|
Nazwa roli
|
steps.role_name | string |
Nazwa roli adresata |
|
Typ akcji
|
steps.action_type | string |
Akcja wymagana od adresata w dokumencie. Możliwe wartości: "Sign", "View", "Approve" lub "FreeFormSign" |
|
Identyfikator zaproszenia
|
steps.invite_id | string |
Identyfikator zaproszenia |
|
Status
|
steps.status | string |
Stan podpisywania. Możliwe wartości: "created", "pending", "fulfilled", "canceled", "skipped" |
|
Odrzucone
|
steps.declined | boolean |
Zwraca wartość "true", jeśli odbiorca tego kroku odrzucił dokument |
|
Przyczyna odrzucenia
|
steps.decline_reason | string |
Wiadomość dostarczona przez adresata podczas odrzucania dokumentu |
|
Created
|
steps.created | integer |
Data utworzenia kroku |
|
Updated
|
steps.updated | integer |
Data ostatniej aktualizacji stanu kroku |
Uzyskiwanie stanu zaproszenia do grupy dokumentów
Ta akcja pobiera informacje o zaproszeniu grupy dokumentów, w tym o stanie każdego kroku i akcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zaproszenia grupy dokumentów
|
document_group_invite_id | string |
Identyfikator zaproszenia grupy dokumentów |
|
Stan grupy dokumentów
|
status | string |
Stan podpisywania grupy dokumentów. Możliwe wartości: "created", "pending", "fulfilled", "canceled" |
|
Adres e-mail właściciela
|
owner_email | string |
Adres e-mail właściciela grupy dokumentów |
|
Odrzucono grupę dokumentów
|
is_document_declined | boolean |
Zwraca wartość "true", jeśli jakikolwiek dokument w grupie jest odrzucany przez osoby podpisującego lub zatwierdzającego; w przeciwnym razie zwraca wartość "false" |
|
steps
|
steps | array of object |
Steps |
|
Identyfikator kroku
|
steps.step_id | string |
Identyfikator kroku z zaproszenia do grupy dokumentów |
|
Kolejność podpisywania
|
steps.signing_order | integer |
Kolejność podpisywania |
|
Identyfikator dokumentu
|
steps.document_id | string |
Identyfikator dokumentu |
|
Nazwa dokumentu
|
steps.document_name | string |
Nazwa dokumentu |
|
Adres e-mail sygnatariusza
|
steps.signer_email | string |
Adres e-mail adresata |
|
Nazwa roli
|
steps.role_name | string |
Nazwa roli adresata |
|
Typ akcji
|
steps.action_type | string |
Akcja wymagana od adresata w dokumencie. Możliwe wartości: "Sign", "View", "Approve" lub "FreeFormSign" |
|
Identyfikator zaproszenia kroku
|
steps.invite_id | string |
Identyfikator kroku zaproszenia |
|
Status
|
steps.status | string |
Stan podpisywania kroku |
|
Odrzucone
|
steps.declined | boolean |
Prawda, jeśli odbiorca w tym kroku odrzucił dokument |
|
Przyczyna odrzucenia
|
steps.decline_reason | string |
Wiadomość dostarczona przez adresata podczas odrzucania dokumentu |
|
Created
|
steps.created | integer |
Data utworzenia kroku |
|
Updated
|
steps.updated | integer |
Data ostatniej aktualizacji stanu kroku |
Wstępne wypełnianie wartości pól dokumentu (wersja zapoznawcza)
Automatyczne wypełnianie pól w dokumencie określonymi wartościami
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Określanie szablonu dokumentu do pobierania pól z |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
|
pola
|
fields | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
Wstępne wypełnianie wartości pól dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj wstępnie wypełnianych wartości pól dokumentu .
Wstępne wypełnianie wartości pól i właściwości.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Określanie szablonu dokumentu do pobierania pól z |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
|
pola
|
fields | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
Wstępne wypełnianie wartości pól grupy dokumentów
Automatyczne wypełnianie pól w dokumentach określonymi wartościami
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_group_id | True | string |
Określanie szablonu grupy dokumentów w celu pobrania pól z |
|
Identyfikator grupy dokumentów
|
doc_group_id | True | string |
Określanie unikatowego identyfikatora grupy dokumentów |
|
pola
|
fields | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | DocumentGroupId |
Unikatowy identyfikator grupy dokumentów |
Wstępne wypełnianie wartości pól inteligentnych
Wstępne wypełnianie wartości pól inteligentnych dla określonego dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Określanie szablonu dokumentu do pobierania pól z |
|
Identyfikator dokumentu
|
doc_id | True | string |
Określanie unikatowego identyfikatora dokumentu |
|
pola
|
fields | dynamic |
Wstępne wypełnianie wartości pól inteligentnych grupy dokumentów
Automatyczne wypełnianie pól inteligentnych w dokumentach określonymi wartościami
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Template
|
template_group_id | True | string |
Określanie szablonu grupy dokumentów w celu pobrania pól z |
|
Identyfikator grupy dokumentów
|
doc_group_id | True | string |
Określanie unikatowego identyfikatora grupy dokumentów |
|
pola
|
fields | dynamic |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | DocumentGroupId |
Unikatowy identyfikator grupy dokumentów |
Zamień adresatów na zaproszenie grupy dokumentów
Ta akcja zastępuje adresatów w grupie dokumentów zaproszeń według identyfikatora zaproszenia. Można również ustawić wygasanie zaproszenia, przypomnienia, ponowne przypisywanie uprawnień i odrzucanie opcji dla każdego dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
|
Identyfikator zaproszenia
|
invite_id | True | string |
Identyfikator zaproszenia grupy dokumentów |
|
Identyfikator kroku
|
step_id | string |
Identyfikator kroku zaproszenia z zaproszenia grupy dokumentów |
|
|
Adresat, który ma zastąpić
|
recipient_to_update | string |
Adres e-mail adresata, który ma zastąpić |
|
|
Nowy adresat
|
new_recipient | string |
Adres e-mail nowego adresata |
|
|
Dni wygaśnięcia
|
expiration_days | integer |
Ile dni wygasa zaproszenie; Maksymalnie 30 dni |
|
|
Przypomnienie
|
reminder | integer |
Ile dni wysłać przypomnienie do sygnatariusza; Maksymalnie 30 dni |
|
|
Identyfikator dokumentu
|
document_id | True | string |
Identyfikator dokumentu z grupy dokumentów |
|
Zezwalaj na przekazywanie
|
allow_forwarding | boolean |
Czy zezwolić adresatom na ponowne przypisanie tego zaproszenia na inny adres e-mail. Możliwe wartości: Fałsz — niedozwolone. True — dozwolone. |
|
|
Zezwalaj na odrzucanie według podpisu
|
decline_by_signature | boolean |
Określa, czy ma być wyświetlana opcja Odrzuć do logowania w polach podpisu. Prawda: pokaż opcję odrzucenia; Fałsz: ukryj opcję odrzucenia |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Stan zastąpienia adresatów |
Zaproszenie do podpisania grupy dokumentów
Ta akcja powoduje utworzenie zaproszenia do podpisania grupy dokumentów. Możesz skonfigurować wieloetapowy przepływ pracy, w którym różni adresaci działają w grupie dokumentów na różnych etapach
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy dokumentów
|
id | True | string |
Identyfikator grupy dokumentów |
|
Zamówienie
|
order | True | integer |
Kolejność podpisywania krok: 1 — adresaci podpiszą najpierw grupę dokumentów, a następnie grupa dokumentów jest wysyłana do 2,3 itd. Kilku adresatów może przechowywać tę samą kolejność podpisywania |
|
Email
|
string |
Adres e-mail adresata |
||
|
Grupa wiadomości e-mail
|
email_group | string |
Grupa kontaktów adresatów |
|
|
Nazwa roli
|
role_name | True | string |
Nazwa roli adresata w dokumencie (może służyć do identyfikowania pól w dokumencie przypisanym do tego konkretnego adresata) |
|
Akcja
|
action | True | string |
Dozwolona akcja z dokumentem. Możliwe wartości: Wyświetl, Podpis, Zatwierdź |
|
Identyfikator dokumentu
|
document_id | True | string |
Identyfikator dokumentu, na którym są wymagane akcje od tego adresata |
|
Wymagana wstępnie ustawiona nazwa podpisu
|
required_preset_signature_name | string |
Wstępnie wypełniony tekst pola podpisu, zablokowany do edycji przez adresata |
|
|
Zezwalaj na przekazywanie
|
allow_reassign | boolean |
Określa, czy adresat może przekazać zaproszenie na inny adres e-mail. "true": odbiorca może przekazać zaproszenie; "false": odbiorca nie może przekazać zaproszenia |
|
|
Zezwalaj na odrzucanie według podpisu
|
decline_by_signature | boolean |
Określa, czy ma być wyświetlana opcja Odrzuć do logowania w polach podpisu. Prawda: pokaż opcję odrzucenia; Fałsz: ukryj opcję odrzucenia |
|
|
Typ uwierzytelniania
|
type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło
|
value | string |
Hasło ustawione na potrzeby uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon
|
phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Message
|
message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z automatycznie wygenerowanym hasłem (kod odblokowania) — "Kod odblokowywania zaproś dokument SignNow: 123456" |
|
|
MerchantId
|
merchant_id | string |
Identyfikator konta kupca dodanego do organizacji |
|
|
Waluta
|
currency | string |
Żądana waluta płatności |
|
|
Kwota
|
amount | string |
Żądana kwota płatności |
|
|
Uri
|
redirect_uri | string |
Po zakończeniu i podpisaniu wszystkich żądanych pól identyfikator URI jest przekierowywany do tego identyfikatora URI |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
|
|
Odrzuć identyfikator URI przekierowania
|
decline_redirect_uri | string |
Link otwierany po odrzuceniu dokumentu przez adresata |
|
|
Zamknij identyfikator URI przekierowania
|
close_redirect_uri | string |
Link otwierany po kliknięciu przycisku Zapisz postęp i Zakończ później podczas sesji podpisywania lub Zamknij w trybie wyświetlania |
|
|
Zakończenie przekierowania zostało anulowane
|
is_finish_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania ukończenia jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Czy zamknięcie przekierowania zostało anulowane
|
is_close_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania postępu zapisywania jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Czy odrzuć przekierowanie zostało anulowane
|
is_decline_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania odrzucenia jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Język
|
language | string |
Określa język sesji podpisywania i wiadomości e-mail z powiadomieniami dla użytkownika podpisującego. Możliwe wartości: En for English, Es for Spanish i Fr for French. Jeśli nie zostanie ustawiona, język jest określany przez język konta SignNow |
|
|
Zamówienie
|
order | True | integer |
Kolejność podpisywania krok: 1 — adresaci podpiszą najpierw grupę dokumentów, a następnie grupa dokumentów jest wysyłana do 2,3 itd. Kilku adresatów może przechowywać tę samą kolejność podpisywania |
|
Email
|
True | string |
Adres e-mail adresata |
|
|
Grupa wiadomości e-mail
|
email_group | string |
Grupa kontaktów adresatów |
|
|
Temat
|
subject | string |
Niestandardowy temat wiadomości e-mail dla adresata |
|
|
Message
|
message | string |
Niestandardowa wiadomość e-mail dla adresata |
|
|
Dni do wygaśnięcia
|
expiration_days | integer |
W ciągu x dni zaproszenie wygasa (od 3 do 180 dni) |
|
|
Wysyłanie przypomnienia w dniach X
|
remind_after | integer |
X dni po zaproszeniu otrzyma wiadomość e-mail z przypomnieniem (od 1 do 179 dni). Musi być mniejsza niż liczba dni wygaśnięcia |
|
|
Wyślij przypomnienie w ciągu X dni przed wygaśnięciem
|
remind_before | integer |
X dni przed wygaśnięciem, recepient otrzymuje wiadomość e-mail z przypomnieniem (od 1 do 179 dni). Musi być mniejsza niż liczba dni wygaśnięcia |
|
|
Wyślij przypomnienie co X dni
|
remind_repeat | integer |
Recepient otrzymuje wiadomość e-mail z przypomnieniem co x dni po wysłaniu zaproszenia (od 1 do 7 dni) |
|
|
Id
|
id | string |
Identyfikator grupy poczty e-mail. Unikatowy 40-znakowy identyfikator, który należy utworzyć wcześniej |
|
|
Name
|
name | string |
Nazwa grupy. Użyj go w grupie "Zaproś kroki > wiadomości e-mail" |
|
|
Email
|
string |
Adres e-mail, który powinien otrzymać zaproszenie |
||
|
Email
|
string |
Adres e-mail odbiorcy, który otrzyma wiadomość e-mail z ukończeniem |
||
|
Wyłączanie załącznika dokumentu
|
disable_document_attachment | boolean |
Czy wyłączyć wysyłanie załączników dokumentów za pomocą wiadomości e-mail z ukończeniem. Możliwe wartości: Fałsz — włączanie załącznika dokumentu, Prawda — wyłączanie załącznika dokumentu |
|
|
Temat
|
subject | string |
Temat niestandardowy wiadomości e-mail z ukończeniem |
|
|
Message
|
message | string |
Niestandardowa wiadomość e-mail dotycząca ukończenia |
|
|
Podpis jako scalony
|
sign_as_merged | boolean |
Jeśli wartość true, umożliwia użytkownikowi interfejsu API wysłanie zaproszenia, które zostanie otwarte jako scalona grupa dokumentów w jednym dokumencie |
|
|
Sygnatura czasowa klienta
|
client_timestamp | integer |
Sygnatura czasowa zaproszenia grupy dokumentów |
|
|
Email
|
string |
Adres e-mail, który powinien otrzymać zaproszenie |
||
|
Podpis QES
|
signature | string |
Typ QES. Możliwe wartości: "Eideasy", "Nom151". Służy do żądania podpisów QES od osób podpisujących. Wszyscy osoby podpisujących w zaproszeniu muszą używać tego samego typu podpisu. Aby utworzyć zaproszenie za pomocą QES, użytkownik musi należeć do organizacji z włączoną funkcją QES |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator zaproszenia grupy dokumentów |
|
Oczekujące łącze zaproszenia
|
pending_invite_link | string |
Oczekujące łącze zaproszenia |
Zaproś do podpisania dokumentu
Ta akcja tworzy i wysyła zaproszenie pola do podpisania dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Email
|
string |
Adres e-mail adresata |
||
|
Grupa wiadomości e-mail
|
email_group | string |
Grupa użytkowników, którzy powinni otrzymać zaproszenie. Gdy jeden z użytkowników podpisuje dokument, jest uznawany za ukończony. Musi być używany z zaawansowanym parametrem "grupy poczty e-mail". Wymagane, jeśli nie dodano opcji "Wiadomość e-mail" lub "Zaproszenie na telefon", ale nie można jej używać w tym samym czasie z jednym z tych parametrów |
|
|
Zaproszenie na telefon
|
phone_invite | string |
Numer telefonu odbiorcy. Wymagane do zaproszenia za pośrednictwem wiadomości SMS |
|
|
Role
|
role | True | string |
Nazwa roli adresata. np. Signer 1, Signer 2 |
|
Zamówienie
|
order | True | integer |
Kolejność podpisywania. Kolejność podpisywania definiuje sekwencję, w której adresaci muszą podpisać lub wypełnić dokument. Po zakończeniu podpisywania wszystkich adresatów w kroku zamówienia dokument przechodzi do następnego kroku zamówienia (np. 2, 3). Wielu adresatów może współdzielić to samo zamówienie podpisywania |
|
Role
|
role | True | string |
Nazwa roli adresata używana do mapowania parametrów zaawansowanych |
|
Wstępnego wypełniania nazwy podpisu
|
prefill_signature_name | string |
Wstępnie wypełniony tekst w polu podpisu dostępny do edycji przez sygnatariusza |
|
|
Wymagana wstępnie ustawiona nazwa podpisu
|
required_preset_signature_name | string |
Wstępnie wypełniony tekst pola podpisu zablokowany do edycji przez adresata. Nie można używać z nazwą podpisu wstępnego lub "Wymagaj nowego podpisu" |
|
|
Wymagaj nowego podpisu
|
force_new_signature | boolean |
Określa, czy podpis może używać zapisanego podpisu. Fałsz — podpis może używać zapisanego podpisu; True — podpis musi utworzyć nowy podpis |
|
|
Zezwalaj na przekazywanie
|
reassign | boolean |
Określa, czy adresat może przekazać zaproszenie na inny adres e-mail. "true": odbiorca może przekazać zaproszenie; "false": odbiorca nie może przekazać zaproszenia |
|
|
Zezwalaj na odrzucanie według podpisu
|
decline_by_signature | boolean |
Określa, czy ma być wyświetlana opcja Odrzuć do logowania w polach podpisu. True — pokaż opcję odrzucenia; false — ukrywa opcję odrzucenia |
|
|
Wysyłanie przypomnienia w dniach X
|
remind_after | integer |
X dni po zaproszeniu otrzyma wiadomość e-mail z przypomnieniem (od 1 do 179 dni). Musi być mniejsza niż "Dni do wygaśnięcia" |
|
|
Wyślij przypomnienie w ciągu X dni przed wygaśnięciem
|
remind_before | integer |
X dni przed wygaśnięciem, recepient otrzymuje wiadomość e-mail z przypomnieniem (od 1 do 179 dni). Musi być mniejsza niż "Dni do wygaśnięcia" |
|
|
Wyślij przypomnienie co X dni
|
remind_repeat | integer |
Recepient otrzymuje wiadomość e-mail z przypomnieniem co x dni po wysłaniu zaproszenia (od 1 do 7 dni) |
|
|
Dni do wygaśnięcia
|
expiration_days | integer |
W ciągu X dni zaproszenie wygasa (od 3 do 180 dni) |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło uwierzytelniania
|
password | string |
Hasło ustawione na potrzeby uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon uwierzytelniania
|
phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Wiadomość SMS z uwierzytelnianiem
|
authentication_sms_message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z wygenerowanym automatycznie hasłem (kod odblokowania) — "Dokument SignNow zaprasza kod odblokowywania: 123456". Przykład: wprowadź hasło {password} w celu odblokowania dokumentu |
|
|
Temat
|
subject | string |
Niestandardowy temat wiadomości e-mail dla adresata |
|
|
Message
|
message | string |
Niestandardowa wiadomość e-mail dla adresata |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Po zakończeniu i podpisaniu wszystkich żądanych pól identyfikator URI jest przekierowywany do tego identyfikatora URI |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
|
|
Odrzuć identyfikator URI przekierowania
|
decline_redirect_uri | string |
Link otwierany po odrzuceniu dokumentu przez adresata |
|
|
Zamknij identyfikator URI przekierowania
|
close_redirect_uri | string |
Link otwierany po kliknięciu przez adresata przycisku Zapisz postęp i Zakończ później podczas sesji podpisywania lub Zamknij w trybie wyświetlania |
|
|
Zakończenie przekierowania zostało anulowane
|
is_finish_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania ukończenia jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Czy zamknięcie przekierowania zostało anulowane
|
is_close_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania postępu zapisywania jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Czy odrzuć przekierowanie zostało anulowane
|
is_decline_redirect_canceled | boolean |
Określa, czy ustawienie przekierowania odrzucenia jest anulowane dla organizacji. True — przekierowanie jest anulowane; False — przekierowanie pozostaje aktywne |
|
|
Język
|
language | string |
Określa język sesji podpisywania i wiadomości e-mail z powiadomieniami dla użytkownika podpisującego. Możliwe wartości: En for English, Es for Spanish i Fr for French. Jeśli nie zostanie ustawiona, język jest określany przez język konta SignNow |
|
|
Email
|
True | string |
Adres e-mail osoby przeglądającego |
|
|
Role
|
role | True | string |
Nazwa roli osoby przeglądającego |
|
Zamówienie
|
order | True | integer |
Liczba całkowita: kolejność wysyłania, począwszy od 1 |
|
Role
|
role | True | string |
Nazwa roli osoby przeglądająca. Służy do mapowania parametrów zaawansowanych |
|
Temat
|
subject | string |
Niestandardowy temat wiadomości e-mail dla przeglądarki |
|
|
Message
|
message | string |
Niestandardowa wiadomość e-mail dla przeglądarki |
|
|
Email
|
True | string |
Adres e-mail osoby zatwierdzającej |
|
|
Role
|
role | True | string |
Nazwa roli osoby zatwierdzającej |
|
Zamówienie
|
order | True | integer |
Kolejność odbierania żądania zatwierdzenia |
|
Role
|
role | True | string |
Nazwa roli osoby zatwierdzającej. Służy do mapowania parametrów zaawansowanych |
|
Dni wygaśnięcia
|
expiration_days | integer |
Liczba dni przed wygaśnięciem zaproszenia |
|
|
Message
|
message | string |
Niestandardowa wiadomość e-mail dla osoby zatwierdzającej |
|
|
Temat
|
subject | string |
Niestandardowy temat wiadomości e-mail dla osoby zatwierdzającej |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło
|
password | string |
Hasło ustawione na potrzeby uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon
|
phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Wiadomość SMS z uwierzytelnianiem
|
authentication_sms_message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z wygenerowanym automatycznie hasłem (kod odblokowania) — "Dokument SignNow zaprasza kod odblokowywania: 123456". Przykład: wprowadź hasło {password} w celu odblokowania dokumentu |
|
|
Identyfikator URI przekierowania
|
redirect_uri | string |
Adres URL otwierany po zatwierdzeniu dokumentu przez osoby zatwierdzające |
|
|
Cel przekierowania
|
redirect_target | string |
Określa, czy otworzyć identyfikator URI przekierowania na nowej karcie w przeglądarce, czy na tej samej karcie po sesji podpisywania. Możliwe wartości: "Na nowej karcie" — otwiera link na nowej karcie "Na tej samej karcie" — otwiera link na tej samej karcie |
|
|
Źródło
|
from | string |
Adres e-mail nadawcy. Można użyć tylko adresu e-mail skojarzonego z kontem SignNow (adres e-mail logowania). Jeśli pole pozostanie puste, zostanie ono ustawione automatycznie |
|
|
identyfikator
|
id | string |
Identyfikator grupy poczty e-mail. Unikatowy 40-znakowy identyfikator, który należy utworzyć wcześniej |
|
|
Name
|
name | string |
Nazwa grupy. Użyj go w polu Grupa wiadomości e-mail osoby podpisujących > |
|
|
Email
|
string |
Adres e-mail, który powinien otrzymać zaproszenie |
||
|
Email
|
string |
Adres e-mail, który powinien otrzymać zaproszenie |
||
|
Name
|
name | string |
Nazwa kroku |
|
|
Email
|
string |
Adres e-mail adresata CC |
||
|
Step
|
step | integer |
Kolejność wysyłania, począwszy od 1 |
|
|
Temat
|
subject | string |
Temat wiadomości e-mail dla wszystkich adresatów |
|
|
Message
|
message | string |
Wiadomość e-mail dla wszystkich adresatów |
|
|
Temat CC
|
cc_subject | string |
Temat wiadomości e-mail CC dla wszystkich adresatów CC |
|
|
Komunikat CC
|
cc_message | string |
Wiadomość e-mail CC dla wszystkich adresatów CC |
|
|
Podpis QES
|
signature | string |
Typ QES. Możliwe wartości: "Eideasy", "Nom151". Służy do żądania podpisów QES od osób podpisujących. Wszyscy osoby podpisujących w zaproszeniu muszą używać tego samego typu podpisu. Aby utworzyć zaproszenie za pomocą QES, użytkownik musi należeć do organizacji z włączoną funkcją QES |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Status |
Zastępowanie adresatów w zaproś do dokumentu
Ta akcja zastępuje adresatów w zaproszeniu dokumentu na podstawie ich ról. Umożliwia również aktualizowanie ustawień zaproszenia, takich jak typ uwierzytelniania, dni wygaśnięcia i inne zaawansowane parametry dla każdej roli
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Role
|
role | True | string |
Nazwa roli adresata, który ma zostać zastąpiony |
|
Nowa wiadomość e-mail
|
True | string |
Adres e-mail nowego adresata |
|
|
Role
|
role | True | string |
Nazwa roli, która wymaga dodatkowych parametrów zaproszenia |
|
Dni wygaśnięcia
|
expiration_days | integer |
Ile dni wygasa zaproszenie. Maksymalnie 30 dni |
|
|
Zezwalaj na odrzucanie według podpisu
|
decline_by_signature | boolean |
Określa, czy ma być wyświetlana opcja Odrzuć do logowania w polach podpisu. Prawda: pokaż opcję odrzucenia; Fałsz: ukryj opcję odrzucenia |
|
|
Przypomnienie
|
reminder | integer |
Ile dni wyślij przypomnienie do adresata. Maksymalnie 30 dni |
|
|
Typ uwierzytelniania
|
authentication_type | string |
Typ uwierzytelniania używany do uwierzytelniania adresata podczas sesji podpisywania. Dozwolone wartości: "Hasło", "Połączenie telefoniczne" i "Sms" |
|
|
Hasło uwierzytelniania
|
authentication_password | string |
Hasło ustawione na potrzeby uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Hasło" |
|
|
Telefon uwierzytelniania
|
authentication_phone | string |
Numer telefonu używany do uwierzytelniania sygnatariusza. Wymagany dla typu uwierzytelniania "Połączenie telefoniczne" i "Sms". Przykład: +1XXXXXXXXX |
|
|
Wiadomość SMS z uwierzytelnianiem
|
authentication_sms_message | string |
Niestandardowa wiadomość SMS wysłana do osoby podpisjącej zawierająca symbol zastępczy {password}. Używany z typem uwierzytelniania "Sms". Bez tego parametru podpisujący otrzymuje domyślną wiadomość SMS z wygenerowanym automatycznie hasłem (kod odblokowania) — "Dokument SignNow zaprasza kod odblokowywania: 123456". Przykład: wprowadź hasło {password} w celu odblokowania dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zamienniki
|
replacements | array of object |
Szczegóły nowych adresatów |
|
Nowy identyfikator zaproszenia
|
replacements.new_invite_id | string |
Identyfikator zaproszenia nowego pola |
|
Role
|
replacements.role | string |
Nazwa roli adresata, który został zastąpiony |
|
Nowa wiadomość e-mail
|
replacements.new_email | string |
Adres e-mail nowego adresata |
Wyzwalacze
| Uruchamianie przepływu w zdarzeniu dokumentu (wersja zapoznawcza) |
Wybierz zdarzenie do wyzwolenia: nowe lub zaktualizowane zaproszenie podpisu; gdy ktoś tworzy, aktualizuje, kończy lub usuwa dokument |
| Uruchamianie przepływu w zdarzeniu dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Uruchom przepływ w zdarzeniu dokumentu .
|
Uruchamianie przepływu w zdarzeniu dokumentu (wersja zapoznawcza)
Wybierz zdarzenie do wyzwolenia: nowe lub zaktualizowane zaproszenie podpisu; gdy ktoś tworzy, aktualizuje, kończy lub usuwa dokument
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Event
|
event | True | string |
Wybierz zdarzenie, które powinno wyzwolić przepływ |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Event
|
meta.event | string |
Zdarzenie dokumentu, które spowodowało wyzwalacz. |
|
Identyfikator dokumentu
|
content.document_id | string |
Unikatowy identyfikator dokumentu docelowego, który spowodował zdarzenie. |
|
Nazwa dokumentu
|
content.document_name | string |
Docelowa nazwa pliku dokumentu bez rozszerzenia |
Uruchamianie przepływu w zdarzeniu dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Uruchom przepływ w zdarzeniu dokumentu .
Wyzwalacz można utworzyć dla jednego z tych zdarzeń: tworzenie dokumentu, aktualizowanie dokumentu, usuwanie dokumentu, ukończenie dokumentu, tworzenie zaproś, aktualizowanie zaproś
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Event
|
event | True | string |
Wybierz zdarzenie, które powinno wyzwolić przepływ. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sygnatura czasowa
|
meta.timestamp | integer |
Data i godzina wystąpienia zdarzenia (format znacznika czasu systemu Unix). |
|
Event
|
meta.event | string |
Zdarzenie dokumentu, które spowodowało wyzwalacz. |
|
Identyfikator dokumentu
|
content.document_id | string |
Unikatowy identyfikator dokumentu docelowego, który spowodował zdarzenie. |
|
Nazwa dokumentu
|
content.document_name | string |
Docelowa nazwa pliku dokumentu bez rozszerzenia |
Definicje
Właściwości dokumentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
|
Nazwa dokumentu
|
document_name | string |
Nazwa pliku dokumentu bez rozszerzenia |
|
Liczba stron
|
page_count | integer |
Liczba stron w dokumencie |
|
Created
|
created | integer |
Data i godzina utworzenia dokumentu w formacie znacznika czasu systemu Unix |
|
Updated
|
updated | integer |
Data i godzina aktualizacji dokumentu w formacie znacznika czasu systemu Unix |
|
Nazwa szablonu
|
original_filename | string |
Nazwa pliku szablonu z rozszerzeniem (jeśli istnieje) |
|
Identyfikator szablonu
|
origin_document_id | string |
Identyfikator dokumentu szablonu (jeśli istnieje) |
|
Czy szablon
|
template | boolean |
wartość true, jeśli dokument jest szablonem. |
|
Stan dokumentu
|
status | string |
Stan dokumentu |
DocumentGroupsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
document_groups
|
document_groups | array of DocumentGroupProperties | |
|
Łączna liczba grup dokumentów
|
document_group_total_count | integer |
Całkowita liczba grup dokumentów na koncie SignNow |
DocumentGroupProperties
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator grupy dokumentów
|
group_id | DocumentGroupId |
Unikatowy identyfikator grupy dokumentów |
|
Nazwa grupy dokumentów
|
group_name | string |
Nazwa grupy dokumentów |
|
Documents
|
documents | array of DocumentGroupDocumentProperties |
Documents |
DocumentGroupDocumentProperties
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dokumentu
|
id | DocumentId |
Unikatowy identyfikator dokumentu |
|
Nazwa dokumentu
|
document_name | string |
Nazwa pliku dokumentu bez rozszerzenia |
|
Identyfikator szablonu
|
origin_document_id | string |
Identyfikator dokumentu szablonu (jeśli istnieje) |
CreateDocumentGroupFromFilesResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa grupy dokumentów
|
group_name | string |
Nazwa grupy dokumentów |
|
Identyfikator grupy dokumentów
|
group_id | string |
Identyfikator grupy dokumentów |
|
dokumenty
|
documents | array of object | |
|
Identyfikator dokumentu
|
documents.id | DocumentId |
Unikatowy identyfikator dokumentu |
|
Nazwa dokumentu
|
documents.name | string |
Nazwa dokumentu |
Identyfikator dokumentu
DocumentGroupId
Unikatowy identyfikator grupy dokumentów
Unikatowy identyfikator grupy dokumentów
- Identyfikator grupy dokumentów
- string
obiekt
Jest to typ 'obiekt'.
binarny
Jest to podstawowy typ danych "binary".