Udostępnij przez

SignatureAPI

Wysyłanie dokumentów do podpisywania, śledzenie ich postępu i szybsze wykonywanie pracy za pomocą interfejsu SignatureAPI — platformy podpisu elektronicznego utworzonej na potrzeby automatyzacji. https://signatureapi.com/docs/integrations/power-automate/getting-started

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Signature API, Inc.
adres URL https://signatureapi.com
Email support@signatureapi.com
Metadane łącznika
Publisher SignatureAPI
Witryna internetowa https://signatureapi.com/power-automate
Zasady ochrony prywatności https://signatureapi.com/privacy
Kategorie Kolaboracja; Produktywność

SignatureAPI

SignatureAPI to elektroniczna platforma podpisu utworzona na potrzeby automatyzacji.

Wysyłanie dokumentów do podpisywania i śledzenie ich postępu przy użyciu naszej platformy podpisu elektronicznego dla usługi Power Automate, która udostępnia różne akcje i wyzwalacze, które ułatwiają tworzenie zarówno prostych, jak i złożonych przepływów pracy.

Podpisy elektroniczne wykonane za pomocą interfejsu SignatureAPI są prawnie wiążące i akceptowane globalnie, podobnie jak tradycyjne podpisy pisma oddyskowego w większości jurysdykcji.

Interfejs SignatureAPI oferuje ekonomiczne ceny dla automatyzacji dużych ilości. Zobacz nasze szczegóły cennika.

Najważniejsze funkcje    

  • Wielu adresatów: wysyłanie dokumentów do maksymalnie 10 osób podpisujących w jednej transakcji.
  • Równoległe lub sekwencyjne podpisywanie: wybierz opcję wysyłania dokumentów do wszystkich adresatów jednocześnie lub w określonej kolejności.
  • Szablony dokumentów: programowe generowanie dokumentów przy użyciu szablonów i danych dynamicznych.
  • Języki i lokalizacja: dostosuj interfejs podpisywania przy użyciu różnych języków, formatów daty i godziny oraz stref czasowych.
  • Podpisywanie bez konta: zezwalaj adresatom na podpisywanie dokumentów bez tworzenia lub logowania się na koncie.
  • Dziennik inspekcji: zachowaj szczegółowy dziennik zdarzeń dostępu do dokumentów, przeglądu i podpisu.
  • Sprawdzanie naruszenia: upewnij się, że integralność dokumentu została zweryfikowana i niepodważalna weryfikacja po podpisie.
  • Śledzenie kopert: monitorowanie postępu podpisywania za pomocą przyjaznego dla użytkownika pulpitu nawigacyjnego.
  • Real-Time Powiadomienia: otrzymywanie natychmiastowych aktualizacji dotyczących działań podpisywania za pośrednictwem poczty e-mail i elementów webhook.

Wymagania wstępne

Aby użyć tego łącznika, utwórz konto SignatureAPI i wygeneruj klucz interfejsu API. Uzyskaj bezpłatny testowy klucz interfejsu API i skonfiguruj połączenie.

Wprowadzenie

Najbardziej typowy przepływ pracy polega na wysyłaniu co najmniej jednego dokumentu do adresatów na potrzeby podpisu. Adresaci otrzymają wiadomość e-mail z linkiem umożliwiającym dostęp do interfejsu podpisywania.

Interfejs SignatureAPI obsługuje zaawansowane przepływy pracy. Zapoznaj się z naszymi przewodnikami dotyczącymi łączników , aby uzyskać instrukcje krok po kroku, przypadki użycia i strategie automatyzacji.

Krok 1. Tworzenie koperty

Zacznij od utworzenia pustej koperty. Koperta to kontener, który przechowuje dokumenty i zarządza procesem podpisywania.

Dostępne opcje:

Krok 2. Dodawanie adresatów

Określ, kto musi podpisać dokumenty, dodając adresatów do koperty. Obecnie obsługiwane są tylko osoby podpisające, ale w przyszłości będą dostępne dodatkowe typy adresatów.

Krok 3. Dodawanie dokumentów

Dodaj dokumenty, które wymagają podpisów do koperty. Możesz przekazać pliki PDF lub DOCX albo wygenerować dokumenty na podstawie szablonów przy użyciu danych.

Krok 4. Definiowanie miejsc w dokumentach

Miejsca są wyznaczonymi obszarami w dokumencie, w którym odbiorca wchodzi w interakcję, na przykład podpisywanie, dostarczanie inicjałów lub dodawanie tekstu. Mogą również zawierać wartości statyczne lub obliczeniowe, takie jak daty ukończenia.

Krok 5. Rozpoczęcie procesu podpisywania

Po pełnym przygotowaniu koperty zainicjuj proces podpisywania.

Krok 6. Oczekiwanie na ukończenie koperty

Aby zachować cały przepływ pracy w ramach tego samego przepływu, możesz poczekać na ukończenie koperty. Gwarantuje to, że wszyscy adresaci podpisali i zostanie wygenerowany element dostarczany (podpisany dokument).

Alternatywnie można wyzwolić oddzielny przepływ pracy po zakończeniu koperty i wygenerowaniu elementu dostarczanego.

Krok 7. Pobieranie podpisanego dokumentu

Po zakończeniu procesu pobierz podpisany dokument (dostarczany).

Praca z wyzwalaczami

Interfejs SignatureAPI oferuje wyzwalacze automatyzowania przepływów pracy i usprawniania procesów. Dowiedz się więcej o pełnej liście wyzwalaczy i sposobach ich używania.

Często używane wyzwalacze

Po wygenerowaniu elementu dostarczanego

Wyzwalany po zakończeniu koperty, a podpisany dokument (dostarczany) jest gotowy.

Po zakończeniu koperty przez adresata

Wyzwalane za każdym razem, gdy odbiorca zakończy swoją część procesu podpisywania.

Gdy adres e-mail adresata odbije się

Wyzwalane, gdy adres e-mail odbiorcy nie może odebrać żądania.

Znane problemy i ograniczenia

Typowe błędy i rozwiązania

  • Upewnij się, że akcja Pobierz element dostarczany jest uruchamiana po akcji Zaczekaj na kopertę . Częścią elementów dostarczanych jest tylko wtedy, gdy wszyscy odbiorcy ukończyli swoją część.
  • Jeśli przełączysz się z klucza interfejsu API testowego do klucza interfejsu API na żywo, zaktualizuj wyzwalacz, aby upewnić się, że element webhook został utworzony w poprawnym środowisku (na żywo lub w teście). Aby uzyskać szczegółowe informacje, zobacz nasz przewodnik rozwiązywania problemów .

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 interfejsu API securestring Klucz interfejsu API dla konta SignatureAPI. Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Czekaj na kopertę

Czeka na dotarcie koperty do stanu ukończenia lub innego stanu końcowego. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Dodawanie adresata — osoba podpisowa

Dodaje adresata do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Dodawanie danych do szablonu

Dodaje dane do szablonu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Dodawanie dokumentu — DOCX

Dodaje dokument DOCX do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Dodawanie dokumentu — PDF

Dodaje dokument PDF do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Dodawanie miejsca — data ukończenia adresata

Dodaje miejsce daty ukończenia adresata do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Dodawanie miejsca — data ukończenia koperty

Dodaje miejsce daty ukończenia koperty do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Dodawanie miejsca — inicjały

Dodaje inicjały do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Dodawanie miejsca — podpis

Dodaje miejsce podpisu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Dodawanie miejsca — tekst

Dodaje miejsce tekstowe do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Dodawanie miejsca — wprowadzanie tekstu

Dodaje miejsce wprowadzania tekstu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Dodawanie szablonu — DOCX

Dodaje szablon DOCX do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Pobieranie adresata

Pobiera szczegóły adresata według ich identyfikatora. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Pobieranie koperty

Pobiera szczegóły koperty według jego identyfikatora. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Pobieranie przechwyconej wartości

Pobiera wartość wprowadzoną przez adresata w miejscu wejściowym podczas podpisywania. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Tworzenie ceremonii — uwierzytelnianie linku pocztą e-mail

Tworzy ceremonię, w której odbiorca jest uwierzytelniany za pośrednictwem linku wysłanego do wiadomości e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Tworzenie ceremonii — uwierzytelnianie niestandardowe

Tworzy ceremonię, w której odbiorca jest uwierzytelniany zewnętrznie w interfejsie SignatureAPI. Służy do uzyskiwania adresu URL ceremonii do udostępniania adresatom. Przed rozpoczęciem korzystania z uwierzytelniania niestandardowego odczyt https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Tworzenie koperty

Tworzy nową kopertę, do której można dodawać adresatów i dokumenty. Gdy wszystko będzie gotowe, użyj akcji "Uruchom kopertę", aby zainicjować proces podpisywania. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Uruchamianie koperty

Inicjuje proces podpisywania koperty. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Usuwanie koperty

Usuwa kopertę i wszystkie skojarzone informacje. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Uzyskiwanie elementu dostarczanego

Pobiera element dostarczany przy użyciu jego identyfikatora. Użyj go, aby pobrać podpisaną kopię koperty. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Czekaj na kopertę

Identyfikator operacji:
WaitEnvelope

Czeka na dotarcie koperty do stanu ukończenia lub innego stanu końcowego. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.

Zwraca

Body
Envelope

Dodawanie adresata — osoba podpisowa

Identyfikator operacji:
AddRecipient

Dodaje adresata do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.
Nazwa adresata
 name True string

Nazwa adresata.
Adres e-mail adresata
 email True string

Adres e-mail odbiorcy.
Klucz odbiorcy
 key True string

Klucz identyfikujący odbiorcę w kopercie.
Tworzenie ceremonii adresata
 ceremony_creation string

Sposób tworzenia ceremonii adresata.
Typ dostarczania adresata
 delivery_type string

Sposób wysyłania elementu dostarczanego do adresata.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
AddRecipientSignerOutput

Dodawanie danych do szablonu

Identyfikator operacji:
AddTemplateData

Dodaje dane do szablonu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Nazwa pola
 field_name True string

Nazwa pola w szablonie.
Wartość
 value True string

Wartość pola w szablonie.

Dodawanie dokumentu — DOCX

Identyfikator operacji:
AddDocumentDocx

Dodaje dokument DOCX do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.
Tytuł dokumentu
 title string

Tytuł tego dokumentu. Może to być wyświetlane adresatom.
Zawartość pliku
 file_content True byte

Zawartość pliku dokumentu.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
AddDocumentOutput

Dodawanie dokumentu — PDF

Identyfikator operacji:
AddDocument

Dodaje dokument PDF do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.
Tytuł dokumentu
 title string

Tytuł tego dokumentu. Może to być wyświetlane adresatom.
Zawartość pliku
 file_content True byte

Zawartość pliku dokumentu.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
AddDocumentOutput

Dodawanie miejsca — data ukończenia adresata

Identyfikator operacji:
AddPlaceRecipientCompletedDate

Dodaje miejsce daty ukończenia adresata do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Klucz odbiorcy
 recipient_key True string

Kluczem adresata jest to miejsce.
Format daty
 date_format string

Definiuje format daty i godziny. Zapoznaj się z dokumentacją, aby uzyskać dozwolone wartości.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie miejsca — data ukończenia koperty

Identyfikator operacji:
AddPlaceEnvelopeCompletedDate

Dodaje miejsce daty ukończenia koperty do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Format daty
 date_format string

Definiuje format daty i godziny. Zapoznaj się z dokumentacją, aby uzyskać dozwolone wartości.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie miejsca — inicjały

Identyfikator operacji:
AddPlaceInitials

Dodaje inicjały do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Klucz odbiorcy
 recipient_key True string

Kluczem adresata jest to miejsce.
Wysokość miejsca
 height number

Ustaw niestandardową wysokość, a szerokość dostosowuje się proporcjonalnie.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie miejsca — podpis

Identyfikator operacji:
AddPlaceSignature

Dodaje miejsce podpisu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Klucz odbiorcy
 recipient_key True string

Kluczem adresata jest to miejsce.
Wysokość miejsca
 height number

Ustaw niestandardową wysokość, a szerokość dostosowuje się proporcjonalnie.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie miejsca — tekst

Identyfikator operacji:
AddPlaceText

Dodaje miejsce tekstowe do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Wartość
 value True string

Wartość tego miejsca tekstowego.
Rozmiar czcionki
 font_size number

Rozmiar czcionki w punktach.
Kolor czcionki
 font_color string

Kolor czcionki w notacji szesnastkowej.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie miejsca — wprowadzanie tekstu

Identyfikator operacji:
AddPlaceTextInput

Dodaje miejsce wprowadzania tekstu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu.
Umieść klucz
 key True string

Klucz identyfikujący to miejsce w dokumencie.
Klucz odbiorcy
 recipient_key True string

Kluczem adresata jest to miejsce.
Przechwyć jako
 capture_as string

Klucz, który przechowuje dane wejściowe odbiorcy i jest uwzględniony w przechwytywaniu kopert.
Hint
 hint string

Komunikat etykietki narzędzia wyświetlany w polu wejściowym adresata.
Podpowiedź
 prompt string

Komunikat zastępczy wyświetlany wewnątrz pola tekstowego wejściowego podczas ceremonii podpisywania.
Wymaganie
 requirement string

Określa, czy odbiorca musi wypełnić to pole, aby ukończyć ceremonię podpisania.
Format
 format string

Określa prawidłowy format danych wejściowych użytkownika. Zapoznaj się z dokumentacją, aby uzyskać dozwolone wartości.
Formatuj komunikat
 format_message string

Komunikat wyświetlany, gdy dane wejściowe użytkownika nie są zgodne z wymaganym formatem.
Numer strony
 page number

Numer strony do położenia tego miejsca.
Odległość od góry
 top number

Odległość (w punktach) od góry strony do dołu miejsca.
Odległość od lewej
 left number

Odległość (w punktach) od lewej strony do miejsca.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Dodawanie szablonu — DOCX

Identyfikator operacji:
AddTemplate

Dodaje szablon DOCX do koperty. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.
Tytuł dokumentu
 title string

Tytuł tego dokumentu. Może to być wyświetlane adresatom.
Zawartość pliku
 file_content True byte

Zawartość pliku dokumentu.
Dane szablonu
 data array of string

Pole: para wartości zawierająca dane, które mają być wypełniane w szablonie.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
AddDocumentOutput

Pobieranie adresata

Identyfikator operacji:
GetRecipient

Pobiera szczegóły adresata według ich identyfikatora. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator adresata
 recipientId True string

Identyfikator odbiorcy.

Zwraca

Body
Recipient

Pobieranie koperty

Identyfikator operacji:
GetEnvelope

Pobiera szczegóły koperty według jego identyfikatora. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.

Zwraca

Body
Envelope

Pobieranie przechwyconej wartości

Identyfikator operacji:
GetCapture

Pobiera wartość wprowadzoną przez adresata w miejscu wejściowym podczas podpisywania. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.
Klucz przechwytywania
 captureKey True string

Klucz przechwyconej wartości.

Zwraca

Body
Capture

Tworzenie ceremonii — uwierzytelnianie linku pocztą e-mail

Identyfikator operacji:
CreateCeremonyEmailLink

Tworzy ceremonię, w której odbiorca jest uwierzytelniany za pośrednictwem linku wysłanego do wiadomości e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator adresata
 recipientId True string

Identyfikator odbiorcy.
Adres URL przekierowania
 redirect_url string

Adres URL przekierowania odbiorcy do adresu po zakończeniu ceremonii. Dowiedz się więcej w: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

response
object

Tworzenie ceremonii — uwierzytelnianie niestandardowe

Identyfikator operacji:
CreateCeremonyCustom

Tworzy ceremonię, w której odbiorca jest uwierzytelniany zewnętrznie w interfejsie SignatureAPI. Służy do uzyskiwania adresu URL ceremonii do udostępniania adresatom. Przed rozpoczęciem korzystania z uwierzytelniania niestandardowego odczyt https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator adresata
 recipientId True string

Identyfikator odbiorcy.
Dostawca uwierzytelniania
 provider True string

Nazwa dostawcy uwierzytelniania. Ta wartość jest dowolna i będzie wyświetlana w dziennikach inspekcji koperty.
Dane uwierzytelniania
 data True array of string

Klucz: para wartości zawierająca metadane uwierzytelniania. Te szczegóły zostaną uwzględnione w dziennikach inspekcji koperty.
Adres URL przekierowania
 redirect_url string

Adres URL przekierowania odbiorcy do adresu po zakończeniu ceremonii. Dowiedz się więcej w: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
CreateCeremonyCustomOutput

Tworzenie koperty

Identyfikator operacji:
CreateEnvelope

Tworzy nową kopertę, do której można dodawać adresatów i dokumenty. Gdy wszystko będzie gotowe, użyj akcji "Uruchom kopertę", aby zainicjować proces podpisywania. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parametry

Nazwa Klucz Wymagane Typ Opis
Tytuł koperty
 title True string

Tytuł tej koperty. Może to być wyświetlane adresatom.
Etykieta koperty
 label string

Etykieta niestandardowa nadana kopertom w celu łatwiejszej identyfikacji. Etykiety są przeznaczone do użytku wewnętrznego i nie są wyświetlane adresatom.
Wiadomość koperty
 message string

Wiadomość, która zostanie wysłana do adresatów.
Tryb koperty
 mode string

Koperty trybu testowego są niewiążące i nie są rozliczane.
Routing koperty
 routing string

Kolejność, w której adresaci podpiszą kopertę. Może to być równoległe, gdzie wszyscy adresaci mogą podpisywać się jednocześnie lub sekwencyjnie, gdzie adresaci podpiszą się po drugim.
Język
 language string

Domyślny język, który ma być używany podczas ceremonii podpisywania i elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny język konta. https://signatureapi.com/docs/localization/language
Strefa czasowa
 timezone string

Strefa czasowa, która ma być używana na potrzeby sygnatur czasowych w elementach dostarczanych. Jeśli nie zostanie określony, zostanie użyte domyślne przesunięcie strefy czasowej konta. https://signatureapi.com/docs/localization/timezone
Format znacznika czasu
 timestamp_format string

Format daty i godziny, który ma być używany w znacznikach czasu dla elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny format znacznika czasu konta. https://signatureapi.com/docs/localization/timestamp_format
Zaświadczenie koperty
 attestation string

Zaświadczenie dotyczące przepisów lub zgodności
Name
 name string

Nazwa nadawcy.
Email
 email string

Adres e-mail nadawcy.
Tematy koperty
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.
Dodatkowe właściwości
 extra string

Dodatkowe właściwości rozszerzalności

Zwraca

Body
CreateEnvelopeOutput

Uruchamianie koperty

Identyfikator operacji:
StartEnvelope

Inicjuje proces podpisywania koperty. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.

Zwraca

Body
StartEnvelopeOutput

Usuwanie koperty

Identyfikator operacji:
DeleteEnvelope

Usuwa kopertę i wszystkie skojarzone informacje. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator koperty
 envelopeId True string

Identyfikator koperty.

Uzyskiwanie elementu dostarczanego

Identyfikator operacji:
GetDeliverable

Pobiera element dostarczany przy użyciu jego identyfikatora. Użyj go, aby pobrać podpisaną kopię koperty. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator elementu dostarczanego
 deliverableId True string

Identyfikator elementu dostarczanego.

Zwraca

Body
Deliverable

Wyzwalacze

Gdy element dostarczany zakończy się niepowodzeniem

To zdarzenie występuje, gdy generowanie elementu dostarczanego kończy się niepowodzeniem, co powoduje niepowodzenie stanu elementu dostarczanego.
Gdy koperta kończy się niepowodzeniem

To zdarzenie występuje, gdy koperta kończy się niepowodzeniem, co powoduje niepowodzenie koperty.
Gdy odbiorca jest ponownie wyświetlany

To zdarzenie występuje, gdy żądanie jest ponownie wysyłane do adresata.
Gdy odbiorca odbije się

To zdarzenie występuje, gdy wiadomość e-mail jest niemożliwa do odebrania, tymczasowo (soft-bounce) lub trwale (hard-bounce).
Gdy odbiorca zakończy się niepowodzeniem

To zdarzenie występuje, gdy występuje błąd związany z adresatem, co powoduje niepowodzenie odbiorcy.
Po anulowaniu koperty

To zdarzenie występuje, gdy proces podpisywania został celowo zatrzymany przed zakończeniem, co powoduje stan koperty anulowanego.
Po odrzuceniu adresata

To zdarzenie występuje, gdy odbiorca odrzuci kopertę.
Po rozpoczęciu koperty

To zdarzenie występuje, gdy stan koperty przechodzi z przetwarzania do in_progress, wskazując, że jest gotowy do wysłania do adresatów.
Po utworzeniu koperty

To zdarzenie występuje za każdym razem, gdy zostanie utworzona koperta.
Po wygenerowaniu elementu dostarczanego

To zdarzenie występuje, gdy element dostarczany, taki jak dziennik inspekcji, zostanie pomyślnie wygenerowany.
Po wysłaniu adresata

To zdarzenie występuje, gdy żądanie jest wysyłane do adresata.
Po zakończeniu adresata

To zdarzenie występuje, gdy odbiorca zakończył swoją część procesu podpisywania.
Po zakończeniu koperty

To zdarzenie występuje, gdy stan koperty przechodzi z in_progress na ukończone, wskazując, że został ukończony przez wszystkich adresatów.
Po zastąpieniu adresata

To zdarzenie występuje, gdy odbiorca zostanie zastąpiony nowym.
Po zwolnieniu adresata

To zdarzenie występuje, gdy odbiorca jest gotowy do wysłania żądania ukończenia koperty.

Gdy element dostarczany zakończy się niepowodzeniem

Identyfikator operacji:
CreateEndpointForDeliverableFailed

To zdarzenie występuje, gdy generowanie elementu dostarczanego kończy się niepowodzeniem, co powoduje niepowodzenie stanu elementu dostarczanego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForDeliverableFailed

Gdy koperta kończy się niepowodzeniem

Identyfikator operacji:
CreateEndpointForEnvelopeFailed

To zdarzenie występuje, gdy koperta kończy się niepowodzeniem, co powoduje niepowodzenie koperty.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForEnvelopeFailed

Gdy odbiorca jest ponownie wyświetlany

Identyfikator operacji:
CreateEndpointForRecipientResent

To zdarzenie występuje, gdy żądanie jest ponownie wysyłane do adresata.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientResent

Gdy odbiorca odbije się

Identyfikator operacji:
CreateEndpointForRecipientBounced

To zdarzenie występuje, gdy wiadomość e-mail jest niemożliwa do odebrania, tymczasowo (soft-bounce) lub trwale (hard-bounce).

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientBounced

Gdy odbiorca zakończy się niepowodzeniem

Identyfikator operacji:
CreateEndpointForRecipientFailed

To zdarzenie występuje, gdy występuje błąd związany z adresatem, co powoduje niepowodzenie odbiorcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientFailed

Po anulowaniu koperty

Identyfikator operacji:
CreateEndpointForEnvelopeCanceled

To zdarzenie występuje, gdy proces podpisywania został celowo zatrzymany przed zakończeniem, co powoduje stan koperty anulowanego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForEnvelopeCanceled

Po odrzuceniu adresata

Identyfikator operacji:
CreateEndpointForRecipientRejected

To zdarzenie występuje, gdy odbiorca odrzuci kopertę.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientRejected

Po rozpoczęciu koperty

Identyfikator operacji:
CreateEndpointForEnvelopeStarted

To zdarzenie występuje, gdy stan koperty przechodzi z przetwarzania do in_progress, wskazując, że jest gotowy do wysłania do adresatów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForEnvelopeStarted

Po utworzeniu koperty

Identyfikator operacji:
CreateEndpointForEnvelopeCreated

To zdarzenie występuje za każdym razem, gdy zostanie utworzona koperta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForEnvelopeCreated

Po wygenerowaniu elementu dostarczanego

Identyfikator operacji:
CreateEndpointForDeliverableGenerated

To zdarzenie występuje, gdy element dostarczany, taki jak dziennik inspekcji, zostanie pomyślnie wygenerowany.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForDeliverableGenerated

Po wysłaniu adresata

Identyfikator operacji:
CreateEndpointForRecipientSent

To zdarzenie występuje, gdy żądanie jest wysyłane do adresata.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientSent

Po zakończeniu adresata

Identyfikator operacji:
CreateEndpointForRecipientCompleted

To zdarzenie występuje, gdy odbiorca zakończył swoją część procesu podpisywania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientCompleted

Po zakończeniu koperty

Identyfikator operacji:
CreateEndpointForEnvelopeCompleted

To zdarzenie występuje, gdy stan koperty przechodzi z in_progress na ukończone, wskazując, że został ukończony przez wszystkich adresatów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForEnvelopeCompleted

Po zastąpieniu adresata

Identyfikator operacji:
CreateEndpointForRecipientReplaced

To zdarzenie występuje, gdy odbiorca zostanie zastąpiony nowym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientReplaced

Po zwolnieniu adresata

Identyfikator operacji:
CreateEndpointForRecipientReleased

To zdarzenie występuje, gdy odbiorca jest gotowy do wysłania żądania ukończenia koperty.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tematy
 topics array of string

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Zwraca

Body
NotificationForRecipientReleased

Definicje

Koperta

Nazwa Ścieżka Typ Opis
Identyfikator koperty
 id EnvelopeId

Identyfikator koperty.
Tytuł koperty
 title EnvelopeTitle

Tytuł tej koperty. Może to być wyświetlane adresatom.
Etykieta koperty
 label EnvelopeLabel

Etykieta niestandardowa nadana kopertom w celu łatwiejszej identyfikacji. Etykiety są przeznaczone do użytku wewnętrznego i nie są wyświetlane adresatom.
Wiadomość koperty
 message EnvelopeMessage

Wiadomość, która zostanie wysłana do adresatów.
nadawca
 sender EnvelopeSender
Stan koperty
 status EnvelopeStatus

Stan koperty.
Zadanie
 deliverable EnvelopeDeliverable
Koperta zakończona o
 completed_at EnvelopeCompletedAt

Godzina ukończenia koperty przez wszystkich adresatów.
Tryb koperty
 mode EnvelopeMode

Koperty trybu testowego są niewiążące i nie są rozliczane.
Routing koperty
 routing EnvelopeRouting

Kolejność, w której adresaci podpiszą kopertę. Może to być równoległe, gdzie wszyscy adresaci mogą podpisywać się jednocześnie lub sekwencyjnie, gdzie adresaci podpiszą się po drugim.
Strefa czasowa
 timezone EnvelopeTimezone

Strefa czasowa, która ma być używana na potrzeby sygnatur czasowych w elementach dostarczanych. Jeśli nie zostanie określony, zostanie użyte domyślne przesunięcie strefy czasowej konta. https://signatureapi.com/docs/localization/timezone
Format znacznika czasu
 timestamp_format EnvelopeTimestampFormat

Format daty i godziny, który ma być używany w znacznikach czasu dla elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny format znacznika czasu konta. https://signatureapi.com/docs/localization/timestamp_format
Zaświadczenie koperty
 attestation EnvelopeAttestation

Zaświadczenie dotyczące przepisów lub zgodności
Tematy koperty
 topics EnvelopeTopics

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Recipient

Nazwa Ścieżka Typ Opis
Identyfikator adresata
 id RecipientId

Identyfikator odbiorcy.
Identyfikator koperty
 envelope_id EnvelopeId

Identyfikator koperty.
Typ adresata
 type RecipientType

Typ adresata.
Klucz odbiorcy
 key RecipientKey

Klucz identyfikujący odbiorcę w kopercie.
Nazwa adresata
 name RecipientName

Nazwa adresata.
Adres e-mail adresata
 email RecipientEmail

Adres e-mail odbiorcy.
Stan adresata
 status RecipientStatus

Stan odbiorcy.
Tworzenie ceremonii adresata
 ceremony_creation RecipientCeremonyCreation

Sposób tworzenia ceremonii adresata.
Typ dostarczania adresata
 delivery_type RecipientDeliveryType

Sposób wysyłania elementu dostarczanego do adresata.
Odbiorca ukończony pod adresem
 completed_at RecipientCompletedAt

Czas ukończenia koperty przez odbiorcę.

Zadanie

Nazwa Ścieżka Typ Opis
Identyfikator elementu dostarczanego
 id DeliverableId

Identyfikator elementu dostarczanego.
Typ elementu dostarczanego
 type DeliverableType

Typ elementu dostarczanego.
Stan elementu dostarczanego
 status DeliverableStatus

Stan elementu dostarczanego.
Zawartość pliku
 file_content DeliverableFileContent

Zawartość pliku elementu dostarczanego. Użyj go, aby zapisać podpisaną kopię koperty.

Capture

Nazwa Ścieżka Typ Opis
Wartość przechwytywania
 value CaptureValue

Wartość przechwytywania danych wejściowych adresata

CreateEnvelopeOutput

Nazwa Ścieżka Typ Opis
Identyfikator koperty
 id EnvelopeId

Identyfikator koperty.
Tytuł koperty
 title EnvelopeTitle

Tytuł tej koperty. Może to być wyświetlane adresatom.
Etykieta koperty
 label EnvelopeLabel

Etykieta niestandardowa nadana kopertom w celu łatwiejszej identyfikacji. Etykiety są przeznaczone do użytku wewnętrznego i nie są wyświetlane adresatom.
Wiadomość koperty
 message EnvelopeMessage

Wiadomość, która zostanie wysłana do adresatów.
nadawca
 sender EnvelopeSender
Tryb koperty
 mode EnvelopeMode

Koperty trybu testowego są niewiążące i nie są rozliczane.
Routing koperty
 routing EnvelopeRouting

Kolejność, w której adresaci podpiszą kopertę. Może to być równoległe, gdzie wszyscy adresaci mogą podpisywać się jednocześnie lub sekwencyjnie, gdzie adresaci podpiszą się po drugim.
Strefa czasowa
 timezone EnvelopeTimezone

Strefa czasowa, która ma być używana na potrzeby sygnatur czasowych w elementach dostarczanych. Jeśli nie zostanie określony, zostanie użyte domyślne przesunięcie strefy czasowej konta. https://signatureapi.com/docs/localization/timezone
Format znacznika czasu
 timestamp_format EnvelopeTimestampFormat

Format daty i godziny, który ma być używany w znacznikach czasu dla elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny format znacznika czasu konta. https://signatureapi.com/docs/localization/timestamp_format
Zaświadczenie koperty
 attestation EnvelopeAttestation

Zaświadczenie dotyczące przepisów lub zgodności
Tematy koperty
 topics EnvelopeTopics

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

StartEnvelopeOutput

Nazwa Ścieżka Typ Opis
Stan koperty
 status EnvelopeStatus

Stan koperty.

AddDocumentOutput

Nazwa Ścieżka Typ Opis
Identyfikator dokumentu
 id DocumentId

Identyfikator dokumentu

AddRecipientSignerOutput

Nazwa Ścieżka Typ Opis
Identyfikator adresata
 id RecipientId

Identyfikator odbiorcy.
Nazwa adresata
 name RecipientName

Nazwa adresata.
Adres e-mail adresata
 email RecipientEmail

Adres e-mail odbiorcy.
Klucz odbiorcy
 key RecipientKey

Klucz identyfikujący odbiorcę w kopercie.
Tworzenie ceremonii adresata
 ceremony_creation RecipientCeremonyCreation

Sposób tworzenia ceremonii adresata.
Typ dostarczania adresata
 delivery_type RecipientDeliveryType

Sposób wysyłania elementu dostarczanego do adresata.

CreateCeremonyCustomOutput

Nazwa Ścieżka Typ Opis
Adres URL ceremonii
 url CeremonyUrl

Adres URL, który odbiorca musi odwiedzić, aby zainicjować ceremonię

Identyfikator koperty

Identyfikator koperty.

Identyfikator koperty.

Identyfikator koperty
string

KopertaTitle

Tytuł tej koperty. Może to być wyświetlane adresatom.

Tytuł tej koperty. Może to być wyświetlane adresatom.

Tytuł koperty
string

KopertaBel

Etykieta niestandardowa nadana kopertom w celu łatwiejszej identyfikacji. Etykiety są przeznaczone do użytku wewnętrznego i nie są wyświetlane adresatom.

Etykieta niestandardowa nadana kopertom w celu łatwiejszej identyfikacji. Etykiety są przeznaczone do użytku wewnętrznego i nie są wyświetlane adresatom.

Etykieta koperty
string

KopertaKomunikat

Wiadomość, która zostanie wysłana do adresatów.

Wiadomość, która zostanie wysłana do adresatów.

Wiadomość koperty
string

KopertaRouting

Kolejność, w której adresaci podpiszą kopertę. Może to być równoległe, gdzie wszyscy adresaci mogą podpisywać się jednocześnie lub sekwencyjnie, gdzie adresaci podpiszą się po drugim.

Kolejność, w której adresaci podpiszą kopertę. Może to być równoległe, gdzie wszyscy adresaci mogą podpisywać się jednocześnie lub sekwencyjnie, gdzie adresaci podpiszą się po drugim.

Routing koperty
string

KopertaTimezone

Strefa czasowa, która ma być używana na potrzeby sygnatur czasowych w elementach dostarczanych. Jeśli nie zostanie określony, zostanie użyte domyślne przesunięcie strefy czasowej konta. https://signatureapi.com/docs/localization/timezone

Strefa czasowa, która ma być używana na potrzeby sygnatur czasowych w elementach dostarczanych. Jeśli nie zostanie określony, zostanie użyte domyślne przesunięcie strefy czasowej konta. https://signatureapi.com/docs/localization/timezone

Strefa czasowa
string

KopertaTimestampFormat

Format daty i godziny, który ma być używany w znacznikach czasu dla elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny format znacznika czasu konta. https://signatureapi.com/docs/localization/timestamp_format

Format daty i godziny, który ma być używany w znacznikach czasu dla elementów dostarczanych. Jeśli nie zostanie określony, zostanie użyty domyślny format znacznika czasu konta. https://signatureapi.com/docs/localization/timestamp_format

Format znacznika czasu
string

Koperty

Nazwa Ścieżka Typ Opis
Nazwa nadawcy
 name string

Nazwa nadawcy.
Adres e-mail nadawcy
 email string

Adres e-mail nadawcy.

KopertaStatus

Stan koperty.

Stan koperty.

Stan koperty
string

Tryb koperty

Koperty trybu testowego są niewiążące i nie są rozliczane.

Koperty trybu testowego są niewiążące i nie są rozliczane.

Tryb koperty
string

KopertaTopics

Służy do klasyfikowania kopert i filtrowania powiadomień elementu webhook.

Nazwa Ścieżka Typ Opis
Przedmioty
 string

Zaświadczenie koperty

Zaświadczenie dotyczące przepisów lub zgodności

Zaświadczenie dotyczące przepisów lub zgodności

Zaświadczenie koperty
string

Koperta — możliwe do wywłaszniania

Nazwa Ścieżka Typ Opis
Identyfikator elementu dostarczanego
 id string

Identyfikator elementu dostarczanego. Użyj tej opcji, aby pobrać podpisaną kopię koperty.

KopertaCompletedAt

Godzina ukończenia koperty przez wszystkich adresatów.

Godzina ukończenia koperty przez wszystkich adresatów.

Koperta zakończona o
date-time

Identyfikator dokumentu

Identyfikator dokumentu

Identyfikator dokumentu

Identyfikator dokumentu
string

Identyfikator odbiorcy

Identyfikator odbiorcy.

Identyfikator odbiorcy.

Identyfikator adresata
string

Typ adresata

Typ adresata.

Typ adresata.

Typ adresata
string

Nazwa odbiorcy

Nazwa adresata.

Nazwa adresata.

Nazwa adresata
string

Adresaci

Adres e-mail odbiorcy.

Adres e-mail odbiorcy.

Adres e-mail adresata
string

Klucz odbiorcy

Klucz identyfikujący odbiorcę w kopercie.

Klucz identyfikujący odbiorcę w kopercie.

Klucz odbiorcy
string

Stan adresata

Stan odbiorcy.

Stan odbiorcy.

Stan adresata
string

RecipientCeremonyCreation

Sposób tworzenia ceremonii adresata.

Sposób tworzenia ceremonii adresata.

Tworzenie ceremonii adresata
string

RecipientDeliveryType

Sposób wysyłania elementu dostarczanego do adresata.

Sposób wysyłania elementu dostarczanego do adresata.

Typ dostarczania adresata
string

AdresatCompletedAt

Czas ukończenia koperty przez odbiorcę.

Czas ukończenia koperty przez odbiorcę.

Odbiorca ukończony pod adresem
date-time

Identyfikator elementu dostarczanego

Identyfikator elementu dostarczanego.

Identyfikator elementu dostarczanego.

Identyfikator elementu dostarczanego
string

DeliverableType

Typ elementu dostarczanego.

Typ elementu dostarczanego.

Typ elementu dostarczanego
string

Stan elementu dostarczanego

Stan elementu dostarczanego.

Stan elementu dostarczanego.

Stan elementu dostarczanego
string

Element dostarczanyFileContent

Zawartość pliku elementu dostarczanego. Użyj go, aby zapisać podpisaną kopię koperty.

Zawartość pliku elementu dostarczanego. Użyj go, aby zapisać podpisaną kopię koperty.

Zawartość pliku
byte

CeremoniaUrl

Adres URL, który odbiorca musi odwiedzić, aby zainicjować ceremonię

Adres URL, który odbiorca musi odwiedzić, aby zainicjować ceremonię

Adres URL ceremonii
string

CaptureValue

Wartość przechwytywania danych wejściowych adresata

Wartość przechwytywania danych wejściowych adresata

Wartość przechwytywania
string

NotificationForEnvelopeCreated

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.

NotificationForEnvelopeStarted

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.

NotificationForEnvelopeCompleted

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.

NotificationForEnvelopeFailed

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Szczegół
 data.detail string

Informacje o błędzie.

NotificationForEnvelopeCanceled

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.

NotificationForRecipientReleased

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.

NotificationForRecipientSent

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.

NotificationForRecipientCompleted

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.

NotificationForRecipientRejected

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.
Przyczyna
 data.reason string

Wyjaśnienie adresata dotyczące odrzucenia.

NotificationForRecipientBounced

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.
Szczegół
 data.detail string

Informacje o odbicia.

NotificationForRecipientFailed

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.
Szczegół
 data.detail string

Informacje o błędzie.

NotificationForRecipientReplaced

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.
Nowy identyfikator adresata
 data.new_recipient_id string

Identyfikator nowego adresata.

NotificationForRecipientResent

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator adresata
 data.object_id EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.
Typ adresata
 data.recipient_type EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.
Klucz odbiorcy
 data.recipient_key EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.

NotificationForDeliverableGenerated

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator elementu dostarczanego
 data.object_id EventDeliverableId

Identyfikator dostarczanego zdarzenia odnosi się do.

NotificationForDeliverableFailed

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
 id EventId

Identyfikator zdarzenia.
Sygnatura czasowa zdarzenia
 timestamp EventTimestamp

Data i godzina zdarzenia w formacie ISO 8601.
Typ zdarzenia
 type EventType

Typ zdarzenia.
Identyfikator koperty
 data.envelope_id EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.
Identyfikator elementu dostarczanego
 data.object_id EventDeliverableId

Identyfikator dostarczanego zdarzenia odnosi się do.
Szczegół
 data.detail string

Informacje o błędzie.

EventId

Identyfikator zdarzenia.

Identyfikator zdarzenia.

Identyfikator zdarzenia
string

Znacznik czasu zdarzenia

Data i godzina zdarzenia w formacie ISO 8601.

Data i godzina zdarzenia w formacie ISO 8601.

Sygnatura czasowa zdarzenia
date-time

Typ Wydarzenia

Typ zdarzenia.

Typ zdarzenia.

Typ zdarzenia
string

EventEnvelopeId

Identyfikator koperty, do których odnosi się to zdarzenie.

Identyfikator koperty, do których odnosi się to zdarzenie.

Identyfikator koperty
string

EventRecipientId

Identyfikator adresata, do których odwołuje się to zdarzenie.

Identyfikator adresata, do których odwołuje się to zdarzenie.

Identyfikator adresata
string

EventRecipientType

Typ adresata, do których odnosi się to zdarzenie.

Typ adresata, do których odnosi się to zdarzenie.

Typ adresata
string

EventRecipientKey

Klucz adresata, do których odnosi się to zdarzenie.

Klucz adresata, do których odnosi się to zdarzenie.

Klucz odbiorcy
string

EventDeliverableId

Identyfikator dostarczanego zdarzenia odnosi się do.

Identyfikator dostarczanego zdarzenia odnosi się do.

Identyfikator elementu dostarczanego
string

obiekt

Jest to typ 'obiekt'.