Nitro Sign Enterprise Verified (wersja zapoznawcza)

Nitro Sign Enterprise Verified to znane rozwiązanie podpisów cyfrowych, które oferuje ogromną ilość metod podpisu i zgodności z najbardziej rygorystycznymi (między)krajowymi przepisami. NSEV umożliwia przekształcenie dowolnego procesu opartego na papierze w kompleksowe przepływy cyfrowe z niezrównanym środowiskiem użytkownika. Usprawnij proces podpisywania dokładnie tak, jak chcesz, i wyślij, podpisz i śledź wszystkie typy dokumentów bezpośrednio z ulubionych aplikacji biznesowych.

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	Obsługa nitro
adres URL	https://www.gonitro.com/support
Email	service@gonitro.com

Metadane łącznika
Publisher	Nitro Software Belgia NV
Witryna internetowa	https://www.gonitro.com
Zasady ochrony prywatności	https://www.gonitro.com/legal/privacy-policy
Kategorie	Operacje IT; Produktywność

Łącznik zweryfikowany przez firmę Nitro

Nitro Software, specjalista ds. rozwiązań inteligentnych dokumentów, udostępnił łącznik Nitro Sign Enterprise Verified Connector dla usługi Power Automate. Łącznik umożliwia firmom przekazywanie dokumentów, które wymagają podpisu cyfrowego bezpośrednio z ulubionych aplikacji platformy Microsoft 365 — od usługi Microsoft Teams do programów Word, SharePoint, Dynamics, OneDrive i wielu innych. Nitro Sign Enterprise Verified — wcześniej znany jako Nitro Sign Premium i Connective eSignatures.

Wymagania wstępne

Aby rozpocząć korzystanie z łącznika, wymagana jest istniejąca subskrypcja konta Nitro Sign Enterprise Verified. Skontaktuj się z Tobą pod adresem Nitro Software lub przejdź do naszej strony pomocy i pomocy technicznej w naszej witrynie internetowej, aby otrzymać poświadczenia.

Dokumentacja

Na tej stronie szczegółowo przedstawiono różne dostępne akcje, a także szczegółowe informacje na temat różnych sposobów implementacji tych akcji.

Nie wahaj się przejrzeć naszej witryny internetowej dokumentacji , aby uzyskać więcej informacji lub skontaktować się z zespołem pomocy technicznej za pośrednictwem naszej strony pomocy i pomocy technicznej lub skrzynki pocztowej pomocy technicznej : mailto:service@gonitro.com. Dokumentacja interfejsu API jest również dostępna w formacie Postman.

Słownik jest dostępny do wyjaśnienia różnych terminów używanych w tej dokumentacji

Obsługiwane operacje

Łącznik Nitro Sign Enterprise Verified jest oparty na interfejsie API w wersji 4 zweryfikowanego przez Nitro Sign Enterprise. Interfejs API to interfejs API REST, który umożliwia aplikacjom zewnętrznym integrację z funkcjami wymienionymi w tym dokumencie i korzystanie z nich w celu tworzenia przepływów podpisywania i zarządzania nimi.

Dostępne akcje można zgrupować w różnych grupach

Grupa akcji	Dostępne akcje
Packages	Pobieranie wszystkich pakietów
	Pobieranie pakietu według identyfikatora
	Uzyskiwanie stanu pakietu
	Tworzenie nowego pakietu (standardowego lub natychmiastowego)
	Usuwanie pakietu według identyfikatora
	Aktualizowanie stanu pakietu
	Pobieranie daty wygaśnięcia pakietu
	Aktualizowanie daty wygaśnięcia pakietu
	Pomiń osoby podpisające
	Wysyłanie przypomnień
	Pobieranie pakietu
	Pobieranie dziennika inspekcji pakietu
Documents	Dodawanie dokumentu do pakietu
	Pobieranie podpisanego dokumentu z pakietu
Interesariusze	Usuwanie uczestnika projektu według identyfikatora
	Pobieranie wszystkich uczestników projektu pakietu
	Dodawanie uczestnika projektu do pakietu
Proces	Pobieranie wszystkich kroków procesu pakietu
Proces	Dodawanie kroku w procesie pakietu
Proces	Zastępowanie kroków procesu pakietu
Proces	Pobieranie wszystkich akcji kroku procesu
Proces	Usuwanie kroku procesu i wszystkich jego aktorów
Proces	Dodawanie aktora do kroku procesu
Proces	Pobieranie wszystkich akcji w bieżącym kroku procesu
Other	Pobierz wszystkie języki włączone w aplikacji
	Pobieranie wszystkich motywów, które można przypisać do pakietu
	Pobierz wszystkie grupy dokumentów, do których można przypisać pakiet
	Pobieranie wszystkich skonfigurowanych metod podpisywania

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
Host podpisywania nitro	ciąg	hostowanie i ścieżka do środowiska nitro sign, np. contoso.sign.gonitro.com/esig	Prawda
Nazwa użytkownika interfejsu API	securestring	Nazwa użytkownika interfejsu API w celu uzyskania dostępu do interfejsu API	Prawda
Hasło interfejsu API	securestring	Hasło interfejsu API w celu uzyskania dostępu do interfejsu API	Prawda

Limity ograniczania

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

Akcje

Aktualizowanie daty wygaśnięcia pakietu	Aktualizowanie daty wygaśnięcia pakietu
Aktualizowanie stanu pakietu	Aktualizuje stan pakietu.
Dodawanie aktora do kroku procesu	Dodaje aktora do kroku procesu.
Dodawanie dokumentu do pakietu	Dodaje dokument do istniejącego pakietu.
Dodawanie kroku w procesie pakietu	Dodaje zestaw akcji do procesu pakietu.
Dodawanie uczestnika projektu do pakietu	Dodaje uczestnika projektu do pakietu
Pobieranie daty wygaśnięcia pakietu	Pobieranie daty wygaśnięcia pakietu
Pobieranie dokumentu z pakietu	Pobierz podpisany dokument z pakietu. Każdy dokument zostanie pobrany jako plik PDF lub XML.
Pobieranie dziennika inspekcji pakietu	Pobierz podpisany dziennik inspekcji dotyczący okresu istnienia pakietu.
Pobieranie pakietu według identyfikatora	Pobiera pakiet według jego identyfikatora.
Pobieranie wszystkich akcji kroku procesu	Pobiera określony zestaw akcji, które można wykonać równolegle z procesu.
Pobieranie wszystkich akcji w bieżącym kroku procesu	Pobiera bieżący zestaw akcji, które można wykonać równolegle.
Pobieranie wszystkich grup dokumentów, do których można przypisać pakiety	Pobiera wszystkie grupy dokumentów, do których można przypisać pakiety
Pobieranie wszystkich języków, które są włączone w aplikacji	Pobiera wszystkie języki, które są włączone w aplikacji
Pobieranie wszystkich kroków procesu	Pobiera wszystkie akcje, które będą musiały zostać wykonane w pakiecie.
Pobieranie wszystkich motywów, które można przypisać do pakietu	Pobiera wszystkie motywy, które można przypisać do pakietu. Możliwe do stronicowania wyniku przez podanie elementu MaxQuantity i parametru continuationToken
Pobieranie wszystkich pakietów	Pobiera wszystkie pakiety. Są one sortowane według parametru creationDate
Pobieranie wszystkich uczestników projektu pakietu	Pobiera uczestników projektu pakietu
Pobierz pakiet	Służy do pobierania wszystkich dokumentów w określonym pakiecie jako pliku zip.
Pomiń osoby podpisające	To wywołanie pomija wszystkie osoby podpisujące, które jeszcze nie zostały zakończone, i ustawia ich stan na "Pominięto", co powoduje oznaczenie kompletnego pakietu jako "Zakończono".
Tworzenie nowego pakietu (standardowego lub natychmiastowego)	Tworzy nowy pakiet. Domyślnie pakiet jest tworzony jako wersja robocza. Aby utworzyć pakiet błyskawiczny, który jest natychmiast gotowy do podpisania status , ustaw właściwość na Pending. Nuta: Punkt POST /packages końcowy umożliwia tworzenie zarówno standardowych, jak i błyskawicznych pakietów.
Usuwanie kroku procesu i wszystkich jego aktorów	Usuwa krok procesu i wszystkich jego aktorów.
Usuwanie pakietu według identyfikatora	Usuwa pakiet według jego identyfikatora.
Usuwanie uczestnika projektu według identyfikatora	Usuwa uczestnika projektu według jego identyfikatora.
Uzyskiwanie stanu pakietu	Pobiera bieżący stan pakietu.
Wysyłanie przypomnień o pakiecie	Zasady firmy mogą wymagać obsługi dokumentu w danym przednadaniu. Wyzwolenie wywołania "wyślij przypomnienia" spowoduje wyszukanie wszystkich osób, które nie podpisały się i wyśle do nich dodatkowe powiadomienie jako przypomnienie.
Zastępowanie kroków procesu pakietu	Zastępuje wszystkich aktorów w pakiecie przy użyciu tablicy 2D, w której każdy zestaw aktorów to akcje, które mogą być wykonywane równolegle.
Zwracanie wszystkich aktualnie skonfigurowanych metod podpisywania	Zwraca wszystkie metody podpisywania, które są obecnie skonfigurowane

Aktualizowanie daty wygaśnięcia pakietu

Identyfikator operacji:

Packages_PutExpiryDate

Aktualizowanie daty wygaśnięcia pakietu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Znacznik czasu wygaśnięcia	ExpiryTimestamp		date-time	Wartość daty/godziny w formacie ISO 8601

Aktualizowanie stanu pakietu

Identyfikator operacji:

Packages_UpdateStatus

Aktualizuje stan pakietu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
body	body	True	string

Dodawanie aktora do kroku procesu

Identyfikator operacji:

Process_StepPost

Dodaje aktora do kroku procesu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Indeks kroku procesu	stepIndex	True	integer	Indeks kroku procesu
Typ	Type	True	string	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Identyfikator uczestnika projektu	StakeholderId	True	string	Identyfikator uczestnika projektu w pakiecie
Pomijanienotyfikacji	SuppressNotifications		boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl		url	Adres URL przekierowania po zakończeniu akcji aktora
Id	Id		string	Identyfikator istniejącego elementu. W przypadku użycia wszystkie inne pola powinny być puste.
Typ	Type		string	Typ elementu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
Identyfikator dokumentu	DocumentId		string	Identyfikator dokumentu w pakiecie
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Język	Language		string	Dwuliterowy kod ISO kraju (ISO 639-1)

Zwraca

Body

Response.Actor

Dodawanie dokumentu do pakietu

Identyfikator operacji:

Documents_AddToPackage

Dodaje dokument do istniejącego pakietu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Name	Name	True	string	Nazwa dokumentu
IsOptional	IsOptional		boolean	Wskazuje, czy dokument powinien być opcjonalny do podpisywania
Język	Language	True	string	Dwuliterowy kod ISO kraju (ISO 639-1)
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
ProofCorrelationId	ProofCorrelationId		string	Unikatowy identyfikator globalny
TypDocelowy	TargetType		string	Będzie działać tylko wtedy, gdy serwer jest skonfigurowany do konwersji dokumentów.
Format docelowy	TargetFormat		string	Format docelowy określa, czy należy wykonać dodatkową konwersję.
PdfErrorHandling	PdfErrorHandling		string	Jak radzić sobie z plikami PDF zawierającymi drobne wady
Typ zawartości	ContentType	True	string	Typ MIME dokumentu
Base64Data	Base64Data	True	byte	Zawartość dokumentu zakodowana w formacie Base64
Typ	Type	True	string	Typ elementu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Język	Language		string	Dwuliterowy kod ISO kraju (ISO 639-1)

Zwraca

Body

Response.Document

Dodawanie kroku w procesie pakietu

Identyfikator operacji:

Process_PostStep

Dodaje zestaw akcji do procesu pakietu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Typ	Type	True	string	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Identyfikator uczestnika projektu	StakeholderId	True	string	Identyfikator uczestnika projektu w pakiecie
Pomijanienotyfikacji	SuppressNotifications		boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl		url	Adres URL przekierowania po zakończeniu akcji aktora
Id	Id		string	Identyfikator istniejącego elementu. W przypadku użycia wszystkie inne pola powinny być puste.
Typ	Type		string	Typ elementu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
Identyfikator dokumentu	DocumentId		string	Identyfikator dokumentu w pakiecie
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Język	Language		string	Dwuliterowy kod ISO kraju (ISO 639-1)

Zwraca

Zestaw aktorów w kroku procesu.

response

array of Response.Actor

Dodawanie uczestnika projektu do pakietu

Identyfikator operacji:

Packages_AddStakeholder

Dodaje uczestnika projektu do pakietu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Typ	Type	True	string	Typ uczestnika projektu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Język	Language	True	string	Dwuliterowy kod ISO kraju (ISO 639-1)
Imię (pierwsze)	FirstName		string	Imię uczestnika projektu
Nazwisko	LastName	True	string	Nazwisko uczestnika projektu
Adres e-mail	EmailAddress	True	email	Adres poczty elektronicznej
Dataurodzenia	BirthDate		date
Numer Telefonu	PhoneNumber		string	Numer telefonu
AdditionalProperties	AdditionalProperties		object	Konfigurowalne dodatkowe właściwości uczestnika projektu
Typ	Type	True	string	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Pomijanienotyfikacji	SuppressNotifications		boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl		url	Adres URL przekierowania po zakończeniu akcji aktora
Typ przekierowania	RedirectType		string
BackButtonUrl	BackButtonUrl		url	Adres URL, do którego użytkownik jest wysyłany po zamknięciu sesji
Id	Id		string	Identyfikator istniejącego elementu. W przypadku użycia wszystkie inne pola powinny być puste.
Typ	Type		string	Typ elementu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
Identyfikator dokumentu	DocumentId		string	Identyfikator dokumentu w pakiecie
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Język	Language		string	Dwuliterowy kod ISO kraju (ISO 639-1)

Zwraca

Body

Response.Stakeholder

Pobieranie daty wygaśnięcia pakietu

Identyfikator operacji:

Packages_GetExpiryDate

Pobieranie daty wygaśnięcia pakietu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

Wartość daty/godziny w formacie ISO 8601

response

Common.DateTime

Pobieranie dokumentu z pakietu

Identyfikator operacji:

Documents_DownloadDocumentFromPackage

Pobierz podpisany dokument z pakietu. Każdy dokument zostanie pobrany jako plik PDF lub XML.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Unikatowy identyfikator dokumentu zawartego w pakiecie	documentId	True	string	Unikatowy identyfikator dokumentu zawartego w pakiecie

Zwraca

response

binary

Pobieranie dziennika inspekcji pakietu

Identyfikator operacji:

Packages_DownloadAuditTrail

Pobierz podpisany dziennik inspekcji dotyczący okresu istnienia pakietu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Kod ISO języka 2 litery (ISO 639-1)	culture	True	string	Kod ISO języka 2 litery (ISO 639-1)

Zwraca

response

binary

Pobieranie pakietu według identyfikatora

Identyfikator operacji:

Packages_GetPackage

Pobiera pakiet według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

Body

Response.Package.Get

Pobieranie wszystkich akcji kroku procesu

Identyfikator operacji:

Process_GetStep

Pobiera określony zestaw akcji, które można wykonać równolegle z procesu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Indeks kroku procesu	stepIndex	True	integer	Indeks kroku procesu

Zwraca

Nazwa	Ścieżka	Typ	Opis
Przedmioty	Items	array of Response.Actor

Pobieranie wszystkich akcji w bieżącym kroku procesu

Identyfikator operacji:

Process_GetCurrentStep

Pobiera bieżący zestaw akcji, które można wykonać równolegle.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

Nazwa	Ścieżka	Typ	Opis
Przedmioty	Items	array of Response.Actor

Pobieranie wszystkich grup dokumentów, do których można przypisać pakiety

Identyfikator operacji:

GetDocumentGroups

Pobiera wszystkie grupy dokumentów, do których można przypisać pakiety

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa grupy dokumentów (lub część) do wyszukania	name		string	Nazwa grupy dokumentów (lub część) do wyszukania

Zwraca

Nazwa	Ścieżka	Typ	Opis
Grupy dokumentów	DocumentGroups	array of object	Lista grup dokumentów
Code	DocumentGroups.Code	string	Kod grupy dokumentów
Name	DocumentGroups.Name	string	Nazwa grupy dokumentów

Pobieranie wszystkich języków, które są włączone w aplikacji

Identyfikator operacji:

GetAllEnabledLanguages

Pobiera wszystkie języki, które są włączone w aplikacji

Zwraca

Nazwa	Ścieżka	Typ	Opis
EnabledLanguages	EnabledLanguages	array of object	Lista obsługiwanych języków
Nazwa wyświetlana	EnabledLanguages.DisplayName	string	Nazwa wyświetlana języka
Nazwa_natywna	EnabledLanguages.NativeName	string	Natywna nazwa języka
IsoCultureCode	EnabledLanguages.IsoCultureCode	string	Dwuliterowy kod ISO (ISO 639-1) języka

Pobieranie wszystkich kroków procesu

Identyfikator operacji:

Process_Get

Pobiera wszystkie akcje, które będą musiały zostać wykonane w pakiecie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

Nazwa	Ścieżka	Typ	Opis
		array of array
items		array of Response.Actor	Zestaw aktorów w kroku procesu.

Pobieranie wszystkich motywów, które można przypisać do pakietu

Identyfikator operacji:

GetAllThemes

Pobiera wszystkie motywy, które można przypisać do pakietu. Możliwe do stronicowania wyniku przez podanie elementu MaxQuantity i parametru continuationToken

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Token umożliwiający uzyskanie następnego zestawu wyników	continuationToken		string	Token umożliwiający uzyskanie następnego zestawu wyników
Maksymalna ilość wyników do zwrócenia	maxQuantity		integer	Maksymalna ilość wyników do zwrócenia
Kolejność sortowania wyników	sortOrder		string	Kolejność sortowania wyników
określ, które pole ma być sortowane	sortField		string	określ, które pole ma być sortowane

Zwraca

Nazwa	Ścieżka	Typ	Opis
ContinuationToken	ContinuationToken	string	Token do pobierania następnej strony wyników
Przedmioty	Items	array of object	Lista zawierająca motywy
Code	Items.Code	string	Kod motywu
Name	Items.Name	string	Nazwa motywu
MaxQuantity	MaxQuantity	integer	Maksymalna liczba wyników, które zostaną zwrócone na żądanie
Total	Total	integer	Łączna liczba wyników.

Pobieranie wszystkich pakietów

Identyfikator operacji:

Packages_Get

Pobiera wszystkie pakiety. Są one sortowane według parametru creationDate

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Numer strony do pobrania	pageNumber		integer	Numer strony do pobrania
Liczba elementów na stronę	pageSize		integer	Liczba elementów na stronę
Zwracanie pakietów utworzonych przed tą datą	createdBefore		date-time	Zwracanie pakietów utworzonych przed tą datą
Zwracanie pakietów utworzonych po tej dacie	createdAfter		date-time	Zwracanie pakietów utworzonych po tej dacie
Stan pakietów do filtrowania	status		string	Stan pakietów do filtrowania
Kod grupy dokumentów do filtrowania pakietów	documentGroupCode		string	Kod grupy dokumentów do filtrowania pakietów
Adres e-mail inicjatora pakietu do filtrowania	initiator		email	Adres e-mail inicjatora pakietu do filtrowania
Nazwa pakietu do filtrowania	packageName		string	Nazwa pakietu do filtrowania
Odwołanie zewnętrzne do pakietów filtrów	externalReference		string	Odwołanie zewnętrzne do pakietów filtrów
Określ sposób sortowania wyniku, wartość domyślna to malejąco	sort		string	Określ sposób sortowania wyniku, wartość domyślna to malejąco

Zwraca

Nazwa	Ścieżka	Typ	Opis
Numer strony	PageNumber	integer	Bieżący numer strony
PageSize	PageSize	integer	Liczba elementów na stronę
TotalPages	TotalPages	integer	Łączna liczba stron
TotalItems	TotalItems	integer	Łączna liczba elementów
Przedmioty	Items	array of Response.Package.Get

Pobieranie wszystkich uczestników projektu pakietu

Identyfikator operacji:

Packages_GetStakeholders

Pobiera uczestników projektu pakietu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

response

array of Response.Stakeholder

Pobierz pakiet

Identyfikator operacji:

Packages_DownloadPackage

Służy do pobierania wszystkich dokumentów w określonym pakiecie jako pliku zip.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

response

binary

Pomiń osoby podpisające

Identyfikator operacji:

Packages_SkipSigners

To wywołanie pomija wszystkie osoby podpisujące, które jeszcze nie zostały zakończone, i ustawia ich stan na "Pominięto", co powoduje oznaczenie kompletnego pakietu jako "Zakończono".

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Tworzenie nowego pakietu (standardowego lub natychmiastowego)

Identyfikator operacji:

Packages_CreatePackage

Tworzy nowy pakiet. Domyślnie pakiet jest tworzony jako wersja robocza. Aby utworzyć pakiet błyskawiczny, który jest natychmiast gotowy do podpisania status , ustaw właściwość na Pending.

Nuta: Punkt POST /packages końcowy umożliwia tworzenie zarówno standardowych, jak i błyskawicznych pakietów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	Name	True	string	Nazwa pakietu
Initiator	Initiator	True	email	Adres poczty elektronicznej
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Status	Status		string	Stan utworzonego pakietu. Użyj "Draft" polecenia , aby utworzyć standardowy pakiet, który można zmodyfikować przed wysłaniem. Użyj "Pending" polecenia , aby utworzyć natychmiastowy pakiet, który jest natychmiast gotowy do podpisywania.
DocumentGroupCode	DocumentGroupCode		string	Kod grupy dokumentów dla pakietu
Data wygaśnięcia	ExpiryDate		date-time	Wartość daty/godziny w formacie ISO 8601
Name	Name	True	string	Nazwa dokumentu
IsOptional	IsOptional		boolean	Wskazuje, czy dokument powinien być opcjonalny do podpisywania
Język	Language	True	string	Dwuliterowy kod ISO kraju (ISO 639-1)
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
ProofCorrelationId	ProofCorrelationId		string	Unikatowy identyfikator globalny
TypDocelowy	TargetType		string	Będzie działać tylko wtedy, gdy serwer jest skonfigurowany do konwersji dokumentów.
Format docelowy	TargetFormat		string	Format docelowy określa, czy należy wykonać dodatkową konwersję.
PdfErrorHandling	PdfErrorHandling		string	Jak radzić sobie z plikami PDF zawierającymi drobne wady
Typ zawartości	ContentType	True	string	Typ MIME dokumentu
Base64Data	Base64Data	True	byte	Zawartość dokumentu zakodowana w formacie Base64
Typ	Type	True	string	Typ elementu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Typ	Type	True	string	Typ uczestnika projektu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Język	Language	True	string	Dwuliterowy kod ISO kraju (ISO 639-1)
Imię (pierwsze)	FirstName		string	Imię uczestnika projektu
Nazwisko	LastName	True	string	Nazwisko uczestnika projektu
Adres e-mail	EmailAddress	True	email	Adres poczty elektronicznej
Dataurodzenia	BirthDate		date
Numer Telefonu	PhoneNumber		string	Numer telefonu
AdditionalProperties	AdditionalProperties		object	Konfigurowalne dodatkowe właściwości uczestnika projektu
Typ	Type	True	string	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Pomijanienotyfikacji	SuppressNotifications		boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl		url	Adres URL przekierowania po zakończeniu akcji aktora
Typ przekierowania	RedirectType		string
BackButtonUrl	BackButtonUrl		url	Adres URL, do którego użytkownik jest wysyłany po zamknięciu sesji
ProcesKrok	ProcessStep		integer	Numer kroku procesu
DocumentIndex	DocumentIndex	True	integer	Indeks dokumentu w pakiecie (począwszy od 0) — dostępny tylko w punkcie końcowym Tworzenie pakietu
Typ	Type	True	string	Typ elementu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
SigningMethods	SigningMethods	True	array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Kod motywu	ThemeCode		string	Identyfikator motywu pakietu
CallBackUrl	CallBackUrl		url	Adres URL wywołania zwrotnego po wykonaniu akcji
NotificationCallBackUrl	NotificationCallBackUrl		url	Adres URL wywołania zwrotnego, gdy użytkownik żąda nowego adresu URL podpisywania
DefaultRedirectUrl	DefaultRedirectUrl		url	Adres URL przekierowania po zakończeniu akcji
F2fRedirectUrl	F2fRedirectUrl		url	Adres URL przekierowania po podpisaniu twarzy
IsUnsignedContentDownloadable	IsUnsignedContentDownloadable		boolean	Czy można pobrać niepodpisaną zawartość
IsReassignEnabled	IsReassignEnabled		boolean	Określa, czy ponowne przypisywanie jest włączone

Zwraca

Body

Response.Package.Get

Usuwanie kroku procesu i wszystkich jego aktorów

Identyfikator operacji:

Process_DeleteStep

Usuwa krok procesu i wszystkich jego aktorów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Indeks kroku procesu	stepIndex	True	integer	Indeks kroku procesu

Usuwanie pakietu według identyfikatora

Identyfikator operacji:

Packages_DeleteById

Usuwa pakiet według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Usuwanie uczestnika projektu według identyfikatora

Identyfikator operacji:

Stakeholder_DeleteById

Usuwa uczestnika projektu według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Unikatowy identyfikator uczestnika projektu	stakeholderId	True	string	Unikatowy identyfikator uczestnika projektu

Uzyskiwanie stanu pakietu

Identyfikator operacji:

Packages_GetStatus

Pobiera bieżący stan pakietu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zwraca

Body

Response.Package.Status

Wysyłanie przypomnień o pakiecie

Identyfikator operacji:

Packages_SendReminders

Zasady firmy mogą wymagać obsługi dokumentu w danym przednadaniu. Wyzwolenie wywołania "wyślij przypomnienia" spowoduje wyszukanie wszystkich osób, które nie podpisały się i wyśle do nich dodatkowe powiadomienie jako przypomnienie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu

Zastępowanie kroków procesu pakietu

Identyfikator operacji:

Process_Put

Zastępuje wszystkich aktorów w pakiecie przy użyciu tablicy 2D, w której każdy zestaw aktorów to akcje, które mogą być wykonywane równolegle.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Unikatowy identyfikator pakietu	packageId	True	string	Unikatowy identyfikator pakietu
Typ	Type	True	string	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Identyfikator uczestnika projektu	StakeholderId	True	string	Identyfikator uczestnika projektu w pakiecie
Pomijanienotyfikacji	SuppressNotifications		boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl		url	Adres URL przekierowania po zakończeniu akcji aktora
Id	Id		string	Identyfikator istniejącego elementu. W przypadku użycia wszystkie inne pola powinny być puste.
Typ	Type		string	Typ elementu
ExternalReference	ExternalReference		string	Dokumentacja zewnętrzna pakietu
Strona	Page		integer	Numer strony dokumentu
Do góry	Top		number	Położenie u góry w pikselach
Lewo	Left		number	Położenie w lewo w pikselach
Szerokość	Width		number	Szerokość elementu
Wysokość	Height		number	Wysokość elementu
Identyfikator dokumentu	DocumentId		string	Identyfikator dokumentu w pakiecie
SigningMethods	SigningMethods		array of string
Name	Name		string	Nazwa powiadomienia prawnego do dodania do pola podpisywania.
Content	Content		string	Niestandardowa zawartość powiadomienia prawnego.
Język	Language		string	Dwuliterowy kod ISO kraju (ISO 639-1)

Zwracanie wszystkich aktualnie skonfigurowanych metod podpisywania

Identyfikator operacji:

GetAllSigningMethods

Zwraca wszystkie metody podpisywania, które są obecnie skonfigurowane

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
zwraca tylko aktywne/nieaktywne metody podpisywania	isActive		boolean	zwraca tylko aktywne/nieaktywne metody podpisywania

Zwraca

response

array of ConfiguredSigningMethod

Definicje

ConfiguredSigningMethod

Skonfigurowana metoda podpisywania w usłudze eSignatures

Nazwa	Ścieżka	Typ	Opis
IsActive	IsActive	boolean	Czy podpisywanieMethod może służyć do tworzenia nowych pól podpisywania
Name	Name	string	Skonfigurowana nazwa metody podpisywania
DisplayNames	DisplayNames	object	Nazwa na język, który będzie wyświetlany użytkownikowi podpisującemu
DisplayNamesInitiator	DisplayNamesInitiator	object	Nazwa na język, który powinien być wyświetlany inicjatorowi podczas tworzenia pakietu.
Opisy	Descriptions	object	Opis metody podpisywania na język, aby uzyskać więcej informacji na temat metody podpisywania podczas tworzenia pakietu.
Wymaganewłaściwości	RequiredProperties	array of string	Wymagane właściwości do podpisywania z mandatem
KeyPairs	KeyPairs	array of KeyPair	dostępne keyPairs, których można użyć do podpisania za pomocą tej metody

KeyPair

reprezentacja pary kluczy podpisywania

Nazwa	Ścieżka	Typ	Opis
Name	Name	string	Nazwa pary kluczy
DisplayNames	DisplayNames	object	Nazwa na język, który będzie wyświetlany inicjatorowi

Common.Guid

Unikatowy identyfikator globalny

Unikatowy identyfikator globalny

string

Common.EmailAddress

Adres poczty elektronicznej

Adres poczty elektronicznej

email

Common.Language

Dwuliterowy kod ISO kraju (ISO 639-1)

Dwuliterowy kod ISO kraju (ISO 639-1)

string

Common.PhoneNumber

Numer telefonu

Numer telefonu

string

Common.ExternalReference

Dokumentacja zewnętrzna pakietu

Dokumentacja zewnętrzna pakietu

string

Common.AdditionalProperties

Konfigurowalne dodatkowe właściwości uczestnika projektu

Nazwa	Ścieżka	Typ	Opis
		object	Konfigurowalne dodatkowe właściwości uczestnika projektu

Common.DateTime

Wartość daty/godziny w formacie ISO 8601

Wartość daty/godziny w formacie ISO 8601

date-time

Package.Status

Stan pakietu

Stan pakietu

string

Package.Name

Nazwa pakietu

Nazwa pakietu

string

Document.Name

Nazwa dokumentu

Nazwa dokumentu

string

Document.Status

Stan dokumentu

Stan dokumentu

string

Document.DocumentOptions

Definiuje opcjonalne parametry dokumentu

Nazwa	Ścieżka	Typ	Opis
TypDocelowy	TargetType	string	Będzie działać tylko wtedy, gdy serwer jest skonfigurowany do konwersji dokumentów.
Format docelowy	PdfOptions.TargetFormat	string	Format docelowy określa, czy należy wykonać dodatkową konwersję.
PdfErrorHandling	PdfOptions.PdfErrorHandling	string	Jak radzić sobie z plikami PDF zawierającymi drobne wady

Uczestnik projektu.FirstName

Imię uczestnika projektu

Imię uczestnika projektu

string

Uczestnik projektu.LastName

Nazwisko uczestnika projektu

Nazwisko uczestnika projektu

string

Aktor.Type

Typ akcji, która będzie musiała zostać wykonana w pakiecie

Typ akcji, która będzie musiała zostać wykonana w pakiecie

string

Aktor.Status

Stan aktora

Stan aktora

string

Element.Type

Typ elementu

Typ elementu

string

Element.Status

Stan elementu

Stan elementu

string

Element.Location

Nazwa	Ścieżka	Typ	Opis
Strona	Page	integer	Numer strony dokumentu
Do góry	Top	number	Położenie u góry w pikselach
Lewo	Left	number	Położenie w lewo w pikselach

Element.Dimensions

Nazwa	Ścieżka	Typ	Opis
Szerokość	Width	number	Szerokość elementu
Wysokość	Height	number	Wysokość elementu

Response.Package.Get

Nazwa	Ścieżka	Typ	Opis
Id	Id	Common.Guid	Unikatowy identyfikator globalny
Name	Name	Package.Name	Nazwa pakietu
Initiator	Initiator	Common.EmailAddress	Adres poczty elektronicznej
ExternalReference	ExternalReference	Common.ExternalReference	Dokumentacja zewnętrzna pakietu
Data utworzenia	CreationDate	Common.DateTime	Wartość daty/godziny w formacie ISO 8601
Status	Status	Package.Status	Stan pakietu
Data wygaśnięcia	ExpiryDate	Common.DateTime	Wartość daty/godziny w formacie ISO 8601
Documents	Documents	array of Response.Document
Interesariusze	Stakeholders	array of Response.Stakeholder

Response.Document

Nazwa	Ścieżka	Typ	Opis
Id	Id	Common.Guid	Unikatowy identyfikator globalny
Status	Status	Document.Status	Stan dokumentu
DocumentOptions	DocumentOptions	Document.DocumentOptions	Definiuje opcjonalne parametry dokumentu
Name	Name	Document.Name	Nazwa dokumentu
Język	Language	Common.Language	Dwuliterowy kod ISO kraju (ISO 639-1)
ExternalReference	ExternalReference	Common.ExternalReference	Dokumentacja zewnętrzna pakietu
ProofCorrelationId	ProofCorrelationId	Common.Guid	Unikatowy identyfikator globalny

Response.Stakeholder

Nazwa	Ścieżka	Typ	Opis
Typ	Type	string	Typ uczestnika projektu
ExternalReference	ExternalReference	Common.ExternalReference	Dokumentacja zewnętrzna pakietu
Id	Id	Common.Guid	Unikatowy identyfikator globalny
Język	Language	Common.Language	Dwuliterowy kod ISO kraju (ISO 639-1)
Imię (pierwsze)	FirstName	Stakeholder.FirstName	Imię uczestnika projektu
Nazwisko	LastName	Stakeholder.LastName	Nazwisko uczestnika projektu
Adres e-mail	EmailAddress	Common.EmailAddress	Adres poczty elektronicznej
Dataurodzenia	BirthDate	date
Numer Telefonu	PhoneNumber	Common.PhoneNumber	Numer telefonu
AdditionalProperties	AdditionalProperties	Common.AdditionalProperties	Konfigurowalne dodatkowe właściwości uczestnika projektu
Actors	Actors	array of Response.Actor

Response.Actor

Nazwa	Ścieżka	Typ	Opis
Typ	Type	Actor.Type	Typ akcji, która będzie musiała zostać wykonana w pakiecie
Id	Id	Common.Guid	Unikatowy identyfikator globalny
Identyfikator uczestnika projektu	StakeholderId	Common.Guid	Unikatowy identyfikator globalny
Status	Status	Actor.Status	Stan aktora
Pomijanienotyfikacji	SuppressNotifications	boolean	Pomijanie powiadomień dla aktora
RedirectUrl	RedirectUrl	url	Adres URL przekierowania po zakończeniu akcji aktora
Elements	Elements	array of Response.Element

Response., element

Nazwa	Ścieżka	Typ	Opis
Typ	Type	Element.Type	Typ elementu
Id	Id	Common.Guid	Unikatowy identyfikator globalny
Identyfikator aktora	ActorId	Common.Guid	Unikatowy identyfikator globalny
Identyfikator dokumentu	DocumentId	integer	Identyfikator dokumentu w pakiecie
Status	Status	Element.Status	Stan elementu
ExternalReference	ExternalReference	Common.ExternalReference	Dokumentacja zewnętrzna pakietu
Lokalizacja	Location	Element.Location
Wymiary	Dimensions	Element.Dimensions
SigningMethods	SigningMethods	array of string
UsedSigningMethod	UsedSigningMethod	string	Użyta metoda podpisywania

Response.Package.Status

Nazwa	Ścieżka	Typ	Opis
Status	Status	Package.Status	Stan pakietu

binarny

Jest to podstawowy typ danych "binary".