Legalesign (wersja zapoznawcza)
Zaprojektowany pod kątem zgodności zespołów prawnych i operacyjnych łącznik Legalesign łączy platformę Microsoft Power Platform z podpisem prawnym eSignature w celu wyzwalania przepływów pracy dokumentów i adresatów, wysyłania przypomnień, pobierania plików PDF i danych formularza powierzchni. Wymaga aktywnej subskrypcji Legalesign zatwierdzonej do użycia interfejsu API.
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 | Obsługa interfejsu API |
| adres URL | https://legalesign.com/contact/ |
| sales@legalesign.com |
| Metadane łącznika | |
|---|---|
| Publisher | Legalesign |
| Dowiedz się więcej o legalesign | https://docs.microsoft.com/connectors/legalesign |
| Witryna internetowa | https://legalesign.com |
| Polityka prywatności | https://legalesign.com/opn/privacy/ |
| Kategorie | Zawartość i pliki; Produktywność |
Łącznik REST legalesign eSignature
Interfejs API REST Legalesign obsługuje przepływy pracy eSignature. Ten łącznik zapewnia pełny dostęp do interfejsu API i wyzwalacze w czasie rzeczywistym, umożliwiając bezproblemową integrację z usługami Microsoft Power Automate, Logic Apps i powiązanymi platformami.
Wymagania wstępne
Aby rozpocząć, potrzebujesz konta Legalesign i klucza interfejsu API: 1. Utwórz konto bezpłatnej wersji próbnej. 2. Utwórz grupę (indywidualne środowisko — na przykład jedno na potrzeby programowania i drugie dla środowiska produkcyjnego). 3. Zażądaj klucza interfejsu API, tworząc bilet pomocy technicznej. Uwzględnij przypadek użycia, firmę i rolę, aby pomoc techniczna mogła zweryfikować twoją tożsamość. 4. Po zweryfikowaniu zaloguj się do pulpitu nawigacyjnego interfejsu API , aby pobrać klucz.
Wdrożenie
Nowe konta zaczynają się w trybie piaskownicy z następującymi ograniczeniami: • Dokumenty można wysyłać tylko do testowych adresów e-mail skonfigurowanych na pulpicie nawigacyjnym interfejsu API. • Żądania są ograniczane do 100/minut.
Gdy wszystko będzie gotowe do pracy, utwórz bilet pomocy technicznej , aby przełączyć konto z piaskownicy do środowiska produkcyjnego. W tym momencie ograniczenia zostaną zniesione. Aby uzyskać szczegółowe informacje, zobacz Przewodnik wdrażania .
Triggers
Łącznik obsługuje dwa wyzwalacze w czasie rzeczywistym:
- Zdarzenia dokumentu (np. utworzone, odrzucone, podpisane, ostateczne utworzone pliki PDF)
- Zdarzenia adresata (np. ukończone, odrzucone, otwarte wiadomości e-mail, odbite, wysłane przypomnienia)
Można odbierać wszystkie dokumenty lub adresatów filtru według grupy lub typu zdarzenia. Wszystkie skojarzone elementy webhook z podpisem prawnym można zarządzać i monitorować na pulpicie nawigacyjnym interfejsu API.
Operations
Obsługiwane są operacje interfejsu API REST legalesign. Najczęściej spotykane jest pobieranie podpisanego pliku PDF, zarządzanie szablonami, dokumentami, adresatami i umieszczaniem pól. Aby uzyskać pełną specyfikację , zobacz pełną dokumentację interfejsu API .
W obszarze Legalesign przekazany dokument jest nazywany "szablonem". Gdy szablon jest wysyłany do co najmniej jednego adresata, staje się on "dokumentem". Zazwyczaj przekażesz szablon, odzyskasz jego identyfikator, a następnie wyślesz go do co najmniej jednego adresata.
Typowe operacje obejmują:
Szablony
-
Create PDF template— przekaż szablon (dowolny typ pliku, taki jak PDF, Word lub obraz). -
Get PDF embeddable link— link jednorazowy umożliwiający wyświetlenie edytora szablonów użytkownikowi
Documents
-
Location to download PDF— zwraca plik binarny PDF podpisanego dokumentu -
Create signing document— wysyłanie dokumentu (wybierz szablon i adresatów) -
Void/archive signing document— zatrzymanie podpisania dokumentu -
Permanently delete signing document— usuwanie dokumentu na zawsze
Adresaci (osoby podpisające)
-
Send signer reminder email- przypomnienie adresatowi o zakończeniu dokumentu -
Get signer rejection reason— jeśli dokument zostanie odrzucony, zobacz, dlaczego
Umieszczanie pola
Legalesign ma zaawansowany system formularzy z polami. Jeśli masz sygnatariuszy, każdy sygnatariusz musi mieć co najmniej jedno pole podpisu.
Istnieją cztery sposoby definiowania pól w szablonie:
- Przekaż plik PDF z osadzonymi polami (automatycznie przekonwertowany przez legalesign).
- Użyj tagów tekstowych Legalesign.
- Zdefiniuj współrzędne x/y.
- Użyj edytora formularzy Legalesign (za pośrednictwem linku osadzania lub aplikacji internetowej).
Kliknij tutaj, aby uzyskać przewodnik
Zapytania i obsługa techniczna
Aby uzyskać dodatkową pomoc techniczną lub zapytania, zaloguj się do konta Legalesign i utwórz bilet pomocy technicznej.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| klucz_api | securestring | Api_key dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Członek grupy |
Szczegóły określonego użytkownika w grupie. |
| Członkowie grup |
Listy wszystkich członków grup. |
| Dokument unieważniony i archiwalny |
Ustawia dokument ze stanem 40 -usunięto i zarchiwizuje go. |
| Pobieranie adresata |
Uzyskaj stan i szczegóły pojedynczego adresata. |
| Pobieranie dokumentu |
Zwróć określony dokument. |
| Pobieranie dokumentów |
Wyświetlanie listy niearchiwnych dokumentów podpisywania. |
| Pobieranie dziennika inspekcji dokumentu |
Plik PDF zawierający tylko dziennik inspekcji dokumentów. |
| Pobieranie grup |
Wyświetlanie listy grup, do których należy użytkownik interfejsu API. |
| Pobieranie linku do osadzania w formacie PDF |
Zwróć link jednorazowego do osadzenia edytora plików PDF. |
| Pobieranie przyczyny odrzucenia adresata |
Zwraca przyczynę, która została udzielona do odrzucenia dokumentu. |
| Pobieranie pól dokumentu |
Pola z dokumentu. |
| Pobieranie pól formularza adresata |
Zwróć pola formularza z określonego adresata. |
| Pobieranie szablonu PDF |
Szczegóły określonego szablonu PDF |
| Pobieranie szablonów plików PDF |
Wyświetlanie listy szablonów plików PDF |
| Pobieranie użytkownika |
Pobierz szczegóły użytkownika. |
| Pobieranie załącznika |
Pobierz załącznik. |
| Pobieranie załączników |
Wyświetlanie listy załączników. |
| Pobierz plik PDF |
Pobierz wersję roboczą lub końcowy plik PDF dla dokumentu podpisywania, w zależności od jego stanu. Zwróć uwagę, że odpowiedź 200 lub 302 jest możliwa. |
| Przekazywanie szablonu PDF |
Przekaż dokument PDF, który chcesz wysłać do podpisania. |
| Przekazywanie załącznika PDF |
Zapisz plik PDF w celu dołączenia do wiadomości e-mail adresata. |
| Trwałe usuwanie dokumentu |
Trwale usuwa dane i pliki. |
| Usuwanie załącznika |
Usuń załącznik. |
| Uzyskiwanie linku adresata |
Link jednorazowy dla adresata umożliwia przejście do stron podpisywania. |
| Wyślij dokument |
Wyślij dokument do podpisu lub zatwierdzenia. |
| Wyślij wiadomość e-mail z przypomnieniem o adresatach |
Wyślij adresatowi wiadomość e-mail z przypomnieniem. |
Członek grupy
Szczegóły określonego użytkownika w grupie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator elementu członkowskiego
|
memberId | True | uuid |
Identyfikator elementu członkowskiego |
Zwraca
- Body
- MemberResponse
Członkowie grup
Listy wszystkich członków grup.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
group | string |
Filtrowanie według określonej grupy |
|
|
Limit zapytań
|
limit | integer |
Użyj funkcji z przesunięciem, aby iterować wyniki. |
|
|
Przesunięcie zapytania
|
offset | integer |
Użyj funkcji z limitem, aby iterować wyniki. |
Zwraca
- Body
- MemberListResponse
Dokument unieważniony i archiwalny
Ustawia dokument ze stanem 40 -usunięto i zarchiwizuje go.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
|
Wysyłanie powiadomień e-mail do adresata
|
string |
Jeśli ustawiono wartość true lub 1, adresaci zostaną powiadomieni, że dokument zostanie unieważniony. |
Pobieranie adresata
Uzyskaj stan i szczegóły pojedynczego adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipientId | True | uuid |
Identyfikator adresata |
Zwraca
Szczegóły adresata
- Body
- SignerResponse
Pobieranie dokumentu
Zwróć określony dokument.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
Zwraca
Szczegóły dokumentu
Pobieranie dokumentów
Wyświetlanie listy niearchiwnych dokumentów podpisywania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
group | True | string |
Filtruj według określonej grupy, wymagane. |
|
Uwzględnij zarchiwizowane dokumenty
|
archived | string |
Filtruj według stanu zarchiwizowanego, wartość domyślna to niearchiwizowane, użyj wartości w tym parametrze, aby wykonywać zapytania o wszystkie dokumenty. |
|
|
Filtruj według wiadomości e-mail adresata
|
string |
Filtruj według wiadomości e-mail adresata. |
||
|
Limit zapytań
|
limit | integer |
Długość zestawu danych do zwrócenia. Użyj polecenia z zapytaniem przesunięcia, aby iterować wyniki. |
|
|
Przesunięcie zapytania
|
offset | integer |
Przesunięcie od początku zestawu danych. Użyj polecenia z zapytaniem limitu, aby iterować za pośrednictwem zestawu danych. |
|
|
Filtrowanie według stanu dokumentu
|
status | integer |
Filtruj według stanu dokumentu. |
|
|
Czy usunąć adresatów z odpowiedzi
|
nosigners | string |
Dodaj wartość 1, aby usunąć informacje o adresatach w celu szybszego wykonywania zapytań. |
|
|
Filtruj dla utworzonego po tej dacie
|
created_gt | date-time |
Odfiltruj te dokumenty utworzone po określonym czasie. |
|
|
Filtruj pod kątem modyfikacji po tej dacie
|
modified_gt | date-time |
Odfiltruj te dokumenty zmodyfikowane po określonym czasie. |
Zwraca
Listy dokumentów
- Body
- DocumentListResponse
Pobieranie dziennika inspekcji dokumentu
Plik PDF zawierający tylko dziennik inspekcji dokumentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
Zwraca
- response
- file
Pobieranie grup
Wyświetlanie listy grup, do których należy użytkownik interfejsu API.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Przesunięcie zapytania
|
offset | integer |
Przesunięcie od początku zestawu danych. Użyj polecenia z zapytaniem limitu, aby iterować za pośrednictwem zestawu danych. |
|
|
Limit zapytań
|
limit | integer |
Długość zestawu danych do zwrócenia. Użyj polecenia z zapytaniem przesunięcia, aby iterować wyniki. |
Zwraca
Lista grup
- Body
- GroupListResponse
Pobieranie linku do osadzania w formacie PDF
Zwróć link jednorazowego do osadzenia edytora plików PDF.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pliku PDF
|
pdfId | True | string |
Ustaw przekazany identyfikator pliku PDF. |
|
Ukryj listę pól z renderowanej strony
|
hide_sender_fields | boolean |
Ukryj listę pól z renderowanej strony. |
|
|
Kod szesnastkowy z wyłączeniem symbolu skrótu dla koloru tła
|
css_body_backgroundcolor | string |
Użyj kodu szesnastkowego z wyłączeniem symbolu skrótu, aby zmienić kolor tła. |
Pobieranie przyczyny odrzucenia adresata
Zwraca przyczynę, która została udzielona do odrzucenia dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipientId | True | uuid |
Identyfikator adresata |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | integer |
Posągi adresatów. |
|
powód
|
reason | string |
Odrzuć przyczynę. |
Pobieranie pól dokumentu
Pola z dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object |
Lista pól dokumentu |
|
|
element_type
|
element_type | string |
Typ elementu |
|
fieldorder
|
fieldorder | integer |
Kolejność pól |
|
etykieta
|
label | string |
Etykieta |
|
label_extra
|
label_extra | string |
Dodatkowa etykieta |
|
Osoby podpisującej
|
signer | integer |
Recipient |
|
stan
|
state | boolean | |
|
sprawdzanie poprawności
|
validation | integer |
Identyfikator weryfikacji |
|
value
|
value | string |
Wartość |
Pobieranie pól formularza adresata
Zwróć pola formularza z określonego adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipientId | True | uuid |
Identyfikator adresata |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
etykieta
|
label | string |
Etykieta |
|
label_extra
|
label_extra | string |
Dodatkowa etykieta |
|
stan
|
state | boolean |
State |
|
fieldorder
|
fieldorder | integer |
Kolejność pól |
|
value
|
value | string |
Jeśli pole jest plikiem osoby podpisającego, ta wartość będzie krótkotrwałym adresem URL pobierania. |
Pobieranie szablonu PDF
Szczegóły określonego szablonu PDF
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Przekazany identyfikator pliku PDF
|
pdfId | True | uuid |
Przekazany identyfikator pliku PDF |
Zwraca
Szczegóły szablonu
- Body
- TemplatePdfResponse
Pobieranie szablonów plików PDF
Wyświetlanie listy szablonów plików PDF
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
group | string |
Może być pełny resource_uri lub tylko identyfikator. |
|
|
Limit zapytań
|
limit | integer |
Długość zestawu danych do zwrócenia. Użyj polecenia z zapytaniem przesunięcia, aby iterować wyniki. |
|
|
Przesunięcie zapytania
|
offset | integer |
Przesunięcie od początku zestawu danych. Użyj polecenia z zapytaniem limitu, aby iterować za pośrednictwem zestawu danych. |
Zwraca
Listy szablonów
Pobieranie użytkownika
Pobierz szczegóły użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | uuid |
Identyfikator użytkownika |
Zwraca
Szczegóły użytkownika.
- Body
- UserDetailResponse
Pobieranie załącznika
Pobierz załącznik.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator załącznika
|
attachId | True | uuid |
Identyfikator załącznika |
Zwraca
Dołącz element.
- Body
- AttachmentResponse
Pobieranie załączników
Wyświetlanie listy załączników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
group | string |
Filtruj według określonej grupy. |
|
|
Limit zapytań
|
limit | integer |
Użyj funkcji z przesunięciem, aby iterować wyniki. |
|
|
Przesunięcie zapytania
|
offset | integer |
Użyj funkcji z limitem, aby iterować wyniki. |
Zwraca
Lista załączników
Pobierz plik PDF
Pobierz wersję roboczą lub końcowy plik PDF dla dokumentu podpisywania, w zależności od jego stanu. Zwróć uwagę, że odpowiedź 200 lub 302 jest możliwa.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
Zwraca
- response
- file
Przekazywanie szablonu PDF
Przekaż dokument PDF, który chcesz wysłać do podpisania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Archiwum po wysłaniu
|
archive_upon_send | boolean |
Ustaw wartość true, jeśli przekazywanie będzie dotyczyć tylko jednego użycia. |
|
|
Grupa
|
group | True | string |
Określ grupę, w której będzie używana. |
|
Pdf
|
pdf_file | True | byte |
Dane pliku PDF zakodowane w formacie Base64. |
|
Tagi procesu
|
process_tags | boolean |
Jeśli plik zawiera tagi tekstowe, przekonwertuj je na pola. |
|
|
Title
|
title | string |
Nazwij ten rekord, jeśli nie zostanie użyty, użyje nazwy pliku. |
|
|
User
|
user | string |
Przypisz do członka grupy, jeśli nie jest użytkownikiem interfejsu API. |
Przekazywanie załącznika PDF
Zapisz plik PDF w celu dołączenia do wiadomości e-mail adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
grupa
|
group | True | string |
Identyfikator URI zasobu grupy |
|
pdf_file
|
pdf_file | True | byte |
Dane pliku PDF zakodowane w formacie Base64, maksymalny rozmiar to ustawienie grupy, domyślnie 5 MB. |
|
filename
|
filename | True | string |
Prosta nazwa alfanumeryczna kończąca się .pdf |
|
użytkownik
|
user | string |
Przypisz do innego użytkownika. |
|
|
opis
|
description | string |
Trwałe usuwanie dokumentu
Trwale usuwa dane i pliki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
docId | True | uuid |
Identyfikator dokumentu |
Usuwanie załącznika
Usuń załącznik.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator załącznika
|
attachId | True | uuid |
Identyfikator dołączania |
Uzyskiwanie linku adresata
Link jednorazowy dla adresata umożliwia przejście do stron podpisywania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipientId | True | uuid |
Identyfikator adresata |
Wyślij dokument
Wyślij dokument do podpisu lub zatwierdzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Grupa
|
group | True | string |
Identyfikator URI zasobu grupy |
|
Name
|
name | True | string |
Określanie nazwy dokumentu |
|
Szablon PDF
|
templatepdf | True | string |
Przekazany plik PDF do wysłania. |
|
e-mail
|
True |
|
||
|
imię
|
firstname | True | string |
Imię |
|
nazwisko
|
lastname | True | string |
Nazwisko |
|
attachments
|
attachments | array of string |
Listaris zasobów załącznika. |
|
|
Wygasa
|
expires | date-time |
ISO8601 utworzona data/godzina, ustawiona na wartość TZ nadawcy lub strefy czasowej, jeśli jest używana |
|
|
komunikat
|
message | string |
Twoja osobista wiadomość dla strony, wprowadzona w środku szablonu wiadomości e-mail grupy. Użyj nazwy zapisanego szablonu wiadomości e-mail poprzedzonej symbolem skrótu, aby użyć tego szablonu. Jeśli istnieje więcej niż jeden szablon o tej samej nazwie, wybierze ten ostatnio zmodyfikowany. |
|
|
imię
|
firstname | string |
Imię |
|
|
nazwisko
|
lastname | string |
Nazwisko |
|
|
e-mail
|
True |
|
||
|
include_link
|
include_link | boolean |
Dołącz link do stron podpisywania, aby umożliwić recenzentowi podpisywanie |
|
|
wiadomość SMS
|
sms | string |
Użyj numeru formatu międzynarodowego, aby dodać weryfikację wiadomości SMS. Wymagane, jeśli świadek lub świadek podpisuje. |
|
|
Temat
|
subject | string |
Wiersz tematu dla wychodzącej wiadomości e-mail |
|
|
timezone
|
timezone | string |
Funkcja TZ znaku musi być prawidłowa jako wartość timezoneenum (zobacz User for timezoneenum details ( Zobacz User for timezoneenum details (Szczegóły dotyczące liczby stref czasowych). Jeśli wartość pusta używa wartości tz nadawcy. |
|
|
Typ podpisu
|
signature_type | integer |
Użyj wersji 4, aby uzyskać certyfikat PDF. Zalecane. Wartość domyślna to 1 (używa skrótu sha256 dla integralności dokumentu). |
|
|
Dołączanie pliku PDF
|
append_pdf | boolean |
Dołącz informacje weryfikacji przypisania prawnego do końcowego pliku PDF. |
|
|
auto_archive
|
auto_archive | boolean |
Wyślij do archiwum wkrótce po podpisaniu. Sprawia, że aplikacja internetowa jest bezpłatna |
|
|
Korzystanie z wiadomości e-mail z podpisem prawnym
|
do_email | boolean |
Użyj adresu e-mail Legalesign, aby wysłać wiadomości e-mail z powiadomieniami. Jeśli wartość false pomija wszystkie wiadomości e-mail. |
|
|
DW po zakończeniu
|
cc_emails | string |
Rozdzielany przecinkami ciąg adresów e-mail, które są powiadamiane o podpisaniu lub odrzuceniu. |
|
|
Konwertowanie pustych pól nadawcy na pierwsze pola adresata
|
convert_sender_to_signer | boolean |
Jeśli jakiekolwiek pola nadawcy są puste, przekonwertuj je na pola dla pierwszego adresata. |
|
|
Hasło PDF
|
pdf_password | string |
Ustaw hasło. Musi być w stanie kodować ascii, należy również ustawić signature_type na 4 i wybrać pdf_password_type. |
|
|
Ustawienia hasła w formacie PDF
|
pdf_password_type | integer |
1 do przechowywania hasła, 2, aby usunąć z naszych rekordów po ostatecznym podpisaniu. |
|
|
pdftext
|
pdftext | object |
Przypisz wartości do pól nadawcy PDF, użyj etykiety pola szablonu lub jego identyfikatora uuid jako kluczy obiektów. Zobacz templatepdf/:id/fields/ i filter for element_type="admin", aby uzyskać odpowiednie pola z etykietą lub identyfikatorem uuid. Zobacz również strict_fields. |
|
|
Adres URL przekierowania
|
redirect | string |
Adres URL do wysłania użytkownika podpisującego po podpisaniu (zamiast strony pobierania). Adres URL będzie zawierać parametry zapytania z informacjami o identyfikatorze i stanie w następujący sposób: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status] |
|
|
Harmonogram przypomnień
|
reminders | string |
Umieść wartość domyślną, jeśli chcesz użyć domyślnego harmonogramu przypomnień w grupie (przejdź do aplikacji internetowej, aby ustawić domyślny harmonogram) |
|
|
Linki do znaku zwrotnego
|
return_signer_links | boolean |
Zwracanie linków dokumentów dla osób podpisujących w treści odpowiedzi. |
|
|
wysyłanie sekwencjonowania
|
signers_in_order | boolean |
Powiadamianie osób podpisujących w kolejności zamówień. Jeśli fałsz wszystkie są powiadamiane symulowanie. |
|
|
tekst signer
|
signertext | object |
Dodaj niestandardowe symbole zastępcze do pól osób podpisających. Użyj etykiet pól lub identyfikatora uuid jako kluczy w obiekcie (tak jak w przypadku tekstu pdf). Zobacz templatepdf/:id/fields/ i filtruj dla element_type = "text", aby uzyskać odpowiednie pola z ich etykietami lub identyfikatorem uuid. |
|
|
Wymuszanie walidacji pola
|
strict_fields | boolean |
Sprawdzanie poprawności tekstu pdf nie powiedzie się w trybie dyskretnym, ustaw wartość true na walidację. |
|
|
Odwołanie
|
tag | string |
Tag |
|
|
Odwołanie
|
tag1 | string |
Tag |
|
|
Odwołanie
|
tag2 | string |
Tag |
|
|
użytkownik
|
user | string |
Przypisz dokument innemu użytkownikowi w grupie. |
Wyślij wiadomość e-mail z przypomnieniem o adresatach
Wyślij adresatowi wiadomość e-mail z przypomnieniem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipientId | True | uuid |
Identyfikator adresata |
|
SMS
|
text | string |
Tekst niestandardowej wiadomości |
Wyzwalacze
| Zdarzenie adresata |
Wyzwalacz dla wystąpienia zdarzenia adresata |
| Zdarzenie dokumentu |
Wyzwalacz zdarzenia dokumentu |
Zdarzenie adresata
Wyzwalacz dla wystąpienia zdarzenia adresata
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
Filtr zdarzeń |
|
grupa
|
group | string |
Filtr grupy |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
wersja |
|
obiekt
|
object | string |
Object |
|
oznaczyć
|
data.tag | string |
Tag |
|
tag1
|
data.tag1 | string |
Tag1 |
|
tag2
|
data.tag2 | string |
Tag2 |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
data.uuid | string |
Identyfikator adresata |
|
e-mail
|
data.email | string |
|
|
grupa
|
data.group | string |
Grupa |
|
porządek
|
data.order | integer |
Zamówienie |
|
stan
|
data.status | integer |
Status |
|
dokument
|
data.document | string |
Dokument |
|
nazwisko
|
data.lastname | string |
Nazwisko |
|
roleText
|
data.roleText | string |
Tekst roli |
|
imię
|
data.firstname | string |
Imię |
|
statusText (Tekst statusu)
|
data.statusText | string |
Tekst stanu |
|
emailBounce
|
data.emailBounce | integer |
Wiadomość e-mail nie odbiła się |
|
resourceUri
|
data.resourceUri | string |
Identyfikator URI zasobu adresata |
|
documentName (nazwa_dokumentu)
|
data.documentName | string |
Nazwa dokumentu |
|
rejectReason
|
data.rejectReason | string |
Odrzuć przyczynę |
|
groupResourceUri
|
data.groupResourceUri | string |
Identyfikator URI zasobu grupy |
|
emailBounceMessage
|
data.emailBounceMessage | string |
Wiadomość e-mail odbicia |
|
documentResourceUri
|
data.documentResourceUri | string |
Identyfikator URI zasobu dokumentu |
|
utworzone
|
created | integer |
Created |
|
id
|
id | string |
identyfikator |
|
wydarzenie
|
event | string |
Event |
Zdarzenie dokumentu
Wyzwalacz zdarzenia dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
Filtr zdarzeń |
|
grupa
|
group | string |
Filtr grupy |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
wersja |
|
obiekt
|
object | string |
Object |
|
tag1
|
data.tag1 | string |
Tag |
|
recipients
|
data.recipients | array of object |
Adresatów |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
data.recipients.uuid | string |
Identyfikator adresata |
|
e-mail
|
data.recipients.email | string |
Adres e-mail adresata |
|
porządek
|
data.recipients.order | integer |
Numer zamówienia odbiorcy |
|
stan
|
data.recipients.status | integer |
Stan adresata |
|
nazwisko
|
data.recipients.lastname | string |
Nazwisko adresata |
|
roleText
|
data.recipients.roleText | string |
Tekst roli adresata |
|
imię
|
data.recipients.firstname | string |
Imię adresata |
|
statusText (Tekst statusu)
|
data.recipients.statusText | string |
Stan adresataTekst |
|
resourceUri
|
data.recipients.resourceUri | string |
Identyfikator URI zasobu adresata |
|
rejectReason
|
data.recipients.rejectReason | string |
rejectReason |
|
groupResourceUri
|
data.groupResourceUri | string |
Identyfikator URI zasobu grupy |
|
statusText (Tekst statusu)
|
data.statusText | string |
Tekst stanu dokumentu |
|
nazwa
|
data.name | string |
Nazwa dokumentu |
|
oznaczyć
|
data.tag | string |
Tag |
|
resourceUri
|
data.resourceUri | string |
Identyfikator URI zasobu |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
data.uuid | string |
Identyfikator dokumentu |
|
tag2
|
data.tag2 | string |
Tag2 |
|
grupa
|
data.group | string |
Grupa |
|
stan
|
data.status | integer |
Stan dokumentu |
|
utworzone
|
created | integer |
Created |
|
id
|
id | string |
Czy |
|
wydarzenie
|
event | string |
Event |
Definicje
PermissionsEnum
ListMeta
Metadane dotyczące wyświetlania listy.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
limit
|
limit | integer |
Maksymalna liczba obiektów. |
|
następny
|
next | string |
Adres URL następnego zestawu obiektów. |
|
przesunąć
|
offset | integer |
Liczba elementów od początku zestawu wyników. |
|
poprzedni
|
previous | string |
Adres URL poprzedniego zestawu obiektów. |
|
total_count
|
total_count | integer |
Całkowita liczba obiektów. |
GroupListResponse
Lista grup
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Meta
|
meta | ListMeta |
Metadane dotyczące wyświetlania listy. |
|
— obiekty
|
objects | array of object | |
|
utworzone
|
objects.created | date-time |
Created |
|
is_active
|
objects.is_active | boolean |
Aktywna |
|
Zmodyfikowano
|
objects.modified | date-time |
Zmodyfikowano |
|
nazwa
|
objects.name | string |
Name |
|
public_name
|
objects.public_name | string |
Nazwa publiczna |
|
resource_uri
|
objects.resource_uri | string |
Identyfikator URI zasobu |
|
ślimak
|
objects.slug | string |
Unikatowa nazwa |
|
użytkownik
|
objects.user | string |
Identyfikator URI zasobu twórcy |
|
xframe_allow
|
objects.xframe_allow | boolean |
Zezwalaj na podpisywanie osadzania |
|
xframe_allow_pdf_edit
|
objects.xframe_allow_pdf_edit | boolean |
Zezwalaj na edycję osadzania |
TemplatePdfListResponse
Listy szablonów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Meta
|
meta | ListMeta |
Metadane dotyczące wyświetlania listy. |
|
— obiekty
|
objects | array of TemplatePdfResponse |
TemplatePdfResponse
Szczegóły szablonu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | date-time |
Created |
|
grupa
|
group | string |
Identyfikator URI grupy |
|
Zmodyfikowano
|
modified | date-time |
Zmodyfikowano |
|
Strony
|
parties | string |
Tablica stron dokumentów w formacie JSON z ciągami. |
|
page_count
|
page_count | integer |
Liczba stron |
|
resource_uri
|
resource_uri | string |
Identyfikator URI zasobu |
|
signer_count
|
signer_count | integer |
Liczba osób podpisanych |
|
title
|
title | string |
Title |
|
użytkownik
|
user | string |
Identyfikator URI zasobu twórcy |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
uuid | uuid |
Identyfikator pliku PDF |
|
prawidłowy
|
valid | boolean |
Można wysłać (jeśli pola nie są weryfikowane). |
DocumentListResponse
Listy dokumentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Meta
|
meta | ListMeta |
Metadane dotyczące wyświetlania listy. |
|
— obiekty
|
objects | array of object |
Documents |
|
Archiwizowane
|
objects.archived | boolean |
Archiwizowane |
|
auto_archive
|
objects.auto_archive | boolean |
Archiwum po wysłaniu. |
|
cc_emails
|
objects.cc_emails | string |
Rozdzielane przecinkami wiadomości e-mail z listą dw po zakończeniu. |
|
utworzone
|
objects.created | date-time |
Created |
|
do_email
|
objects.do_email | boolean |
Użyj wiadomości e-mail legalesign. |
|
download_final
|
objects.download_final | boolean |
Jest gotowy do pobrania po zakończeniu. |
|
grupa
|
objects.group | string |
Identyfikator URI zasobu grupy. |
|
Zmodyfikowano
|
objects.modified | date-time |
Zmodyfikowano |
|
nazwa
|
objects.name | string |
Nazwa dokumentu |
|
pdftext
|
objects.pdftext | string |
Wartości pól nadawcy |
|
Przekierowanie
|
objects.redirect | string |
Adres URL przekierowania adresata po podpisaniu |
|
resource_uri
|
objects.resource_uri | string |
Identyfikator URI zasobu |
|
return_signer_links
|
objects.return_signer_links | boolean |
Dodawanie linków adresatów do odpowiedzi |
|
Sygnatariuszy
|
objects.signers | array of array |
Zagnieżdżone tablice ze szczegółami logowania |
|
items
|
objects.signers | array of |
Always contains [signer uri, first name, last name, email, sms number, has_fields, status, signer order (0-indexed)] |
|
signers_in_order
|
objects.signers_in_order | integer |
Adresaci wiadomości e-mail symulują lub sekwencyjnie |
|
stan
|
objects.status | DocumentStatusEnum |
Opcje stanu dokumentu:
|
|
oznaczyć
|
objects.tag | string |
Dokument tagu |
|
tag1
|
objects.tag1 | string |
Dokument tagu |
|
tag2
|
objects.tag2 | string |
Dokument tagu |
|
szablon
|
objects.template | string |
Identyfikator URI zasobu szablonu, jeśli jest używany |
|
templatepdf
|
objects.templatepdf | string |
Identyfikator URI zasobu szablonu pdf |
|
SMS
|
objects.text | string |
Tekst podpisywania |
|
użytkownik
|
objects.user | string |
Identyfikator URI twórcy |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
objects.uuid | uuid |
Identyfikator dokumentu |
DocumentStatusEnum
Opcje stanu dokumentu:
- 10 — Stan początkowy, sprawdź stan osoby podpisowej pod kątem wysłanych/nieoznajdowanych
- 20 — Pola zostały ukończone
- 30 — Podpisane
- 40 — Usunięte (przed podpisaniem)
- 50 — Odrzucono
Opcje stanu dokumentu:
- 10 — Stan początkowy, sprawdź stan osoby podpisowej pod kątem wysłanych/nieoznajdowanych
- 20 — Pola zostały ukończone
- 30 — Podpisane
- 40 — Usunięte (przed podpisaniem)
- 50 — Odrzucono
SignerResponse
Szczegóły adresata
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dokument
|
document | string |
Dokument |
|
e-mail
|
string |
Adres e-mail adresata |
|
|
imię
|
first_name | string |
Imię adresata |
|
nazwisko
|
last_name | string |
Nazwisko adresata |
|
has_fields
|
has_fields | boolean |
Adresat ma pola |
|
porządek
|
order | integer |
Kolejność adresatów |
|
resource_uri
|
resource_uri | string |
Identyfikator URI zasobu adresata |
|
stan
|
status | SignerStatusEnum |
Opcje stanu logowania:
|
SignerStatusEnum
Opcje stanu logowania:
- 4 — niewykonalne
- 5 — zaplanowane wysłanie
- 10 — wysłane
- 15 — otwarta wiadomość e-mail
- 20 — odwiedzone
- 30 — ukończone pola
- 35 — pola zakończą podpis ex
- 39 — oczekiwanie na ukończenie monitora
- 40 — podpisane
- 50 — pobrane
- 60 — odrzucone
Opcje stanu logowania:
- 4 — niewykonalne
- 5 — zaplanowane wysłanie
- 10 — wysłane
- 15 — otwarta wiadomość e-mail
- 20 — odwiedzone
- 30 — ukończone pola
- 35 — pola zakończą podpis ex
- 39 — oczekiwanie na ukończenie monitora
- 40 — podpisane
- 50 — pobrane
- 60 — odrzucone
DocumentResponseDetail
Szczegóły dokumentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Archiwizowane
|
archived | boolean |
Jest zarchiwizowane |
|
auto_archive
|
auto_archive | boolean |
Wyślij archiwum dokumentów po podpisaniu. |
|
cc_emails
|
cc_emails | string |
Kto będzie mieć wartość cc'd z nadawcą w powiadomieniu e-mail po podpisaniu |
|
utworzone
|
created | date-time |
Created |
|
do_email
|
do_email | boolean |
Korzystanie z wiadomości e-mail z podpisem prawnym |
|
download_final
|
download_final | boolean |
Ostateczny plik PDF jest dostępny do pobrania |
|
stopka
|
footer | string |
Dokumentacja HTML — tekst stopki, jeśli jest używany |
|
footer_height
|
footer_height | integer |
DOKUMENTACJA HTMl — wysokość px stopki, jeśli jest używana |
|
grupa
|
group | string |
Identyfikator URI zasobu grupy |
|
has_fields
|
has_fields | boolean |
Dokument zawiera pola |
|
hash_value
|
hash_value | string |
Sha256 suma kontrolna końcowego dokumentu, użyj go do zweryfikowania końcowego pobierania pliku PDF |
|
nagłówek
|
header | string |
Dokumentacja HTML — tekst nagłówka, jeśli jest używany |
|
header_height
|
header_height | integer |
DOKUMENTACJA HTMl — wysokość pikseli nagłówka, jeśli jest używana |
|
Zmodyfikowano
|
modified | date-time |
Zmodyfikowano |
|
nazwa
|
name | string |
Nazwa dokumentu |
|
pdf_password
|
pdf_password | string |
Hasło PDF |
|
pdf_password_type
|
pdf_password_type | string |
Jeśli hasło pdf jest zachowywane |
|
pdftext
|
pdftext | string |
Ignoruj to |
|
Przekierowanie
|
redirect | string |
Adres URL przekierowania adresata po podpisaniu |
|
resource_uri
|
resource_uri | string |
Identyfikator URI zasobu |
|
return_signer_links
|
return_signer_links | boolean |
Ignoruj |
|
sign_mouse
|
sign_mouse | boolean |
ignorować |
|
sign_time
|
sign_time | date-time |
Godzina podpisania |
|
sign_type
|
sign_type | boolean |
starsze |
|
sign_upload
|
sign_upload | boolean |
starsze |
|
signature_placement
|
signature_placement | integer |
starsze |
|
signature_type
|
signature_type | integer |
starsza wersja — zawsze 4 |
|
Sygnatariuszy
|
signers | array of array |
Zagnieżdżone tablice ze szczegółami logowania |
|
items
|
signers | array of |
Always contains [signer uri, first name, last name, email, sms number, has_fields, status, signer order (0-indexed)] |
|
signer_objects
|
signer_objects | array of object |
Lista adresatów |
|
e-mail
|
signer_objects.email | string |
|
|
imię
|
signer_objects.firstname | string |
Imię |
|
nazwisko
|
signer_objects.lastname | string |
Nazwisko |
|
Telefon
|
signer_objects.tel | string |
Numer tel |
|
porządek
|
signer_objects.order | integer |
Kolejność podpisywania |
|
resource_uri
|
signer_objects.resource_uri | string |
Identyfikator URI zasobu |
|
rola
|
signer_objects.role | string |
Role |
|
stan
|
signer_objects.status | integer |
Kod stanu odbiorcy |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
signer_objects.uuid | string |
Identyfikator adresata |
|
signers_in_order
|
signers_in_order | boolean |
Adresaci wiadomości e-mail symulują lub sekwencyjnie |
|
stan
|
status | DocumentStatusEnum |
Opcje stanu dokumentu:
|
|
oznaczyć
|
tag | string |
Odwołanie |
|
tag1
|
tag1 | string |
Odwołanie |
|
tag2
|
tag2 | string |
Odwołanie |
|
szablon
|
template | string |
Identyfikator URI zasobu dla szablonu tekstowego, jeśli jest używany |
|
templatepdf
|
templatepdf | string |
Identyfikator URI zasobu dla szablonu pdf, jeśli jest używany |
|
SMS
|
text | string |
Tekst dokumentu, jeśli jest używany |
|
użytkownik
|
user | string |
Identyfikator URI zasobu użytkownika. |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
uuid | uuid |
Identyfikator dokumentu |
MemberListResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Meta
|
meta | ListMeta |
Metadane dotyczące wyświetlania listy. |
|
— obiekty
|
objects | array of MemberResponse |
MemberResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | date-time |
Created |
|
grupa
|
group | string |
Identyfikator URI zasobu grupy |
|
Zmodyfikowano
|
modified | date-time |
Zmodyfikowano |
|
uprawnienie
|
permission | PermissionsEnum |
Opcje uprawnień |
|
resource_uri
|
resource_uri | string |
Identyfikator URI zasobu |
|
użytkownik
|
user | string |
Identyfikator URI zasobu użytkownika. |
AttachmentResponse
Dołącz element.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
utworzone
|
created | date-time |
Created |
|
opis
|
description | string |
Description |
|
filename
|
filename | string |
Nazwa pliku |
|
grupa
|
group | string |
Grupa |
|
resource_uri
|
resource_uri | string |
Dołączanie identyfikatora URI zasobu |
|
użytkownik
|
user | string |
Identyfikator URI zasobu użytkownika |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
uuid | uuid |
Identyfikator dołączania |
AttachmentListResponse
Lista załączników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Meta
|
meta | ListMeta |
Metadane dotyczące wyświetlania listy. |
|
— obiekty
|
objects | array of object |
Aukcji |
|
utworzone
|
objects.created | date-time |
Created |
|
opis
|
objects.description | string |
Description |
|
filename
|
objects.filename | string |
Nazwa pliku |
|
grupa
|
objects.group | string |
Grupa |
|
resource_uri
|
objects.resource_uri | string |
Identyfikator URI zasobu |
|
użytkownik
|
objects.user | string |
Identyfikator URI zasobu użytkownika |
|
UUID (Uniwersalnie Unikalny Identyfikator)
|
objects.uuid | uuid |
Identyfikator dołączania |
UserDetailResponse
Szczegóły użytkownika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
date_joined
|
date_joined | date-time |
Data dołączenia |
|
e-mail
|
|
||
|
imię
|
first_name | string |
Imię |
|
groups
|
groups | array of string |
Lista grup, do których dołączył ten użytkownik. |
|
last_login
|
last_login | date-time |
Ostatnie logowanie |
|
nazwisko
|
last_name | string |
Nazwisko |
|
resource_uri
|
resource_uri | string |
Identyfikator URI zasobu |
|
timezone
|
timezone | string |
Strefa czasowa |
|
nazwa użytkownika
|
username | string |
Nazwa użytkownika |
plik
Jest to podstawowy typ danych "file".