Znak nitro (wersja zapoznawcza)

Interfejs API podpisywania nitro umożliwia bezpieczne, kompleksowe przepływy pracy eSignature, umożliwiając aplikacjom tworzenie i śledzenie procesów podpisywania cyfrowego oraz zarządzanie nimi. Zapewnia ona możliwości tworzenia kopert, przekazywania dokumentów, dodawania uczestników, definiowania zamówienia podpisywania i wysyłania dokumentów do podpisu za pomocą w pełni zautomatyzowanego podejścia opartego na interfejsie API.

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

Service	Class	Regiony
Copilot Studio	Premium	Wszystkie regiony 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: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów	Premium	Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt biznesowy
Name	Obsługa nitro
adres URL	https://www.gonitro.com/support
Email	prosupport@sfdc.gonitro.com

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

Łącznik z podpisem nitro

Przegląd

Łącznik Nitro Sign umożliwia bezpieczne, kompleksowe przepływy pracy eSignature bezpośrednio z Power Automate i Power Apps. Umożliwia ona aplikacjom tworzenie kopert podpisywania, przekazywanie i zmienianie kolejności dokumentów, dodawanie uczestników oraz definiowanie zamówień podpisywania, umieszczanie podpisów i pól danych, wysyłanie dokumentów do podpisu, śledzenie postępu oraz pobieranie oryginalnych, zapieczętowanych i dzienników inspekcji — wszystko za pomocą w pełni zautomatyzowanego podejścia opartego na interfejsie API.

Publisher: Nitro Software

Wymagania wstępne

Aby korzystać z logowania nitro za pośrednictwem tego łącznika, potrzebne są następujące elementy:

Konto Nitro z włączonym znakiem Nitro
https://developers.gonitro.com/
Plan Microsoft PowerApps lub Power Automate z funkcjami łącznika niestandardowego.

Authentication

Narzędzie Nitro Sign używa protokołu OAuth 2.0 do maszyny z przyznawaniem poświadczeń klienta w celu generowania tokenów dostępu dla żądań interfejsu API.

Jak to działa

Aplikację interfejsu API można utworzyć w portalu samoobsługowym Nitro i uzyskać skojarzony identyfikator klienta i klucz tajny klienta.
Łącznik jest uwierzytelniany przez wymianę tych poświadczeń dla tokenu dostępu elementu nośnego .
Token jest następnie używany do autoryzowania kolejnych wywołań interfejsu API podpisywania nitro.

Utwórz poświadczenia i przeczytaj szczegółowy przewodnik:
https://developers.gonitro.com/docs/authentication/credentials

Tworzenie połączenia w Power Automate/Power Apps

Podczas dodawania łącznika do przepływu lub aplikacji:

Kliknij pozycję Dodaj nowe połączenie.
Wprowadź identyfikator klienta i klucz tajny klienta (wystawiony w portalu deweloperów Nitro).
Wybierz region Nitro (Europa, Stany Zjednoczone lub APAC) — region skojarzony z kontem Nitro.
Zapisz połączenie — przy pierwszym użyciu łącznik wymienia identyfikator klienta i klucz tajny klienta dla krótkotrwałego tokenu dostępu przy użyciu przyznawania poświadczeń klienta OAuth 2.0, buforuje go i odnawia automatycznie. Poświadczenia są używane tylko do uzyskiwania tokenu; kolejne wywołania interfejsu API są uwierzytelniane przy użyciu tokenu elementu nośnego w Twoim imieniu.

Uwaga: nie jest wymagane żadne logowanie interakcyjne użytkownika; ten przepływ jest przeznaczony dla scenariuszy serwer-serwer/aplikacja-aplikacja.

Obsługiwane operacje

Łącznik grupuje swoje akcje wokół czterech zasobów przepływu pracy podpisywania — koperty, dokumenty, pola i uczestnicy — oraz zestaw akcji Pobierania na potrzeby pobierania gotowych plików.

1. Koperty

Koperta to kontener dokumentów, uczestników i pól w ramach pojedynczego żądania podpisania.

Listy kopert
Zwraca wszystkie koperty skojarzone z aplikacją na koncie. Wyniki są podzielone na strony: odpowiedź zawiera token kursora na następnej stronie , który można podać do opcjonalnego parametru Page After w celu pobrania następnej strony (lub Strony przed do tyłu). Oba parametry kursora znajdują się w obszarze Zaawansowane i są potrzebne tylko podczas przechodzenia przez duże zestawy wyników.
Tworzenie koperty
Tworzy nową kopertę z nazwą, komunikatem powiadomienia (temat + treść, ze zmiennymi dynamicznymi, takimi jak $(sender_name_or_email) i $(envelope_name)), i trybem podpisywania:
- parallel — wszyscy uczestnicy są powiadamiani w tym samym czasie i mogą podpisać niezależnie.
- sequential — uczestnicy są powiadamiani pojedynczo, w kolejności, w której zostali dodani.
Pobieranie koperty według identyfikatora
Pobiera szczegóły dla określonej koperty według identyfikatora UUID.
Aktualizuj kopertę
Aktualizuje nazwę koperty, ustawienia powiadomień i/lub tryb podpisywania. Wszystkie pola są opcjonalne.
Usuń kopertę według identyfikatora
Trwale usuwa kopertę i wszystkie skojarzone dokumenty, pola i uczestników. Nie można cofnąć tej możliwości.
Wysyłanie koperty do podpisywania
Wysyła kopertę do uczestników na potrzeby zbierania podpisów. Przed wysłaniem koperta powinna zwykle mieć dodane dokumenty, uczestników i pola podpisywania (za pomocą polecenia Utwórz dokument według identyfikatora koperty, utwórz uczestników według identyfikatora koperty i utwórz pola według identyfikatora dokumentu). Wszystkie dokumenty w kopercie muszą mieć stan przekazania przed wysłaniem koperty.
Wysyłanie przypomnień dla koperty
Wyzwala powiadomienia z przypomnieniami dla oczekujących uczestników. Jeśli nie podano żadnych ustawień powiadomień, zostanie użyty domyślny szablon powiadomienia skonfigurowany dla koperty.
Anuluj kopertę według identyfikatora
Anuluje żądanie podpisania. Można anulować tylko koperty, które zostały już wysłane do podpisania.

2. Dokumenty

Dokumenty to pliki dołączone do koperty i podpisane przez uczestników.

Wyświetlanie listy dokumentów według identyfikatora koperty
Pobiera wszystkie dokumenty skojarzone z kopertą.
Tworzenie dokumentu według identyfikatora koperty
Przekazuje dokument do istniejącej koperty. Podaj plik oraz proste, wpisane pola — bez ręcznie napisanego kodu JSON:
- Plik dokumentu — plik do przekazania.
- Nazwa dokumentu — nazwa do przechowywania dokumentu.
- Typ zawartości(zaawansowany, opcjonalny) — typ MIME pliku; wartość domyślna to application/pdf. Po pominięciu akceptowane są tylko pliki PDF.
Pobieranie dokumentu według identyfikatora
Pobiera szczegóły określonego dokumentu w kopercie.
Aktualizowanie dokumentu według identyfikatora
Aktualizuje metadane dokumentu. Obecnie można zmienić tylko nazwę dokumentu.
Usuwanie dokumentu według identyfikatora
Trwale usuwa dokument z koperty.
Zmienianie kolejności dokumentów według identyfikatora koperty
Zmienia kolejność dokumentów w kopercie na podstawie podanej listy identyfikatorów dokumentów.

3. Pola

Pola to elementy interakcyjne (podpis, inicjały, data itp.) umieszczone w dokumencie i przypisane do uczestnika.

Pola listy według identyfikatora dokumentu
Pobiera wszystkie pola skojarzone z określonym dokumentem.
Tworzenie pól według identyfikatora dokumentu
Tworzy co najmniej jedno pole w dokumencie i przypisuje je uczestnikom. Podaj jeden element dla jednego pola lub wiele elementów dla żądania zbiorczego. Każde pole określa:
- participantID — uczestnik przypisany do pola.
- type— jeden z signature, initials, namedatecompanytitle, , . customcheckbox
- page — numer strony (indeksowanie oparte na 1).
- Pozycja X, Położenie Y, Szerokość, Wysokość — położenie i rozmiar pola, z których każda została wprowadzona jako oddzielna liczba punktów (X/Y są mierzone od lewej/górnej krawędzi strony). Zastępują one poprzednią pojedynczą boundingBox tablicę, więc każda wartość jest polem wpisanym w interfejsie użytkownika, a nie ręcznie utworzoną listą.
- Opcjonalnie: required (wartość domyślna true) i — w obszarze Zaawansowane — format (np. MM/DD/YYYY dla pól daty) i modifiable.
Aktualizowanie pola według identyfikatora
Aktualizuje właściwości istniejącego pola. Pole type musi być podane i musi być zgodne z istniejącym typem pola — służy do identyfikowania schematu pola i nie zmienia typu pola.
Usuń pole według identyfikatora
Trwale usuwa pole z dokumentu.

4. Uczestnicy

Uczestnicy są osobami, które otrzymują kopertę — aby ją podpisać lub być na bieżąco.

Wyświetlanie listy uczestników według identyfikatora koperty
Pobiera wszystkich uczestników skojarzonych z kopertą.
Tworzenie uczestników według identyfikatora koperty
Dodaje co najmniej jednego uczestnika do koperty. Podaj jeden element dla jednego uczestnika lub wiele elementów dla żądania zbiorczego. Każdy uczestnik określa:
- email — adres e-mail uczestnika.
- role — signer (może mieć przypisane pola do podpisywania) lub cc (dostęp tylko do odczytu).
- authentication (zaawansowane, opcjonalne) — obecnie kod dostępu: statyczny kod dostępu, który uczestnik musi podać przed podpisaniem. Otwórz tę sekcję tylko wtedy, gdy uczestnik powinien uwierzytelnić się przed podpisaniem.
Aktualizowanie uczestnika według identyfikatora
Aktualizuje ustawienia uwierzytelniania uczestnika. Nie można zmienić wiadomości e-mail uczestnika.
Usuń uczestnika według identyfikatora
Trwale usuwa uczestnika z koperty.

5. Pliki do pobrania

Pobierz gotowe pliki po podpisaniu i zapieczętowaniu dokumentów.

Pobierz oryginalną kopertę
Pobiera oryginalne niepodpisane dokumenty z koperty jako archiwum ZIP .
Pobierz zapieczętowaną kopertę
Pobiera zapieczętowane dokumenty wraz z dziennikiem inspekcji jako archiwum ZIP .
Pobieranie zapieczętowanego dokumentu według identyfikatora
Pobiera pojedynczy zapieczętowany podpisany dokument jako plik PDF .
Pobierz dziennik inspekcji koperty
Pobiera pełny dziennik inspekcji dla koperty jako plik PDF .

Akcje pobierania uwidaczniają natywną nazwę pliku i tokeny zawartości pliku (oraz typ zawartości pliku). Upuść zawartość pliku bezpośrednio do danych wejściowych pliku podrzędnego — np. OneDrive / SharePoint Utwórz plik — i nazwa pliku do danych wejściowych nazwy pliku. Nie body('Action_Name') jest wymagana żadna nazwa pliku lub nazwa pliku typu ręcznie; łącznik opakowuje pobrany plik ZIP lub PDF w kopertę JSON, aby Power Automate powierzchnie te jako zwykłe tokeny zawartości dynamicznej.

Typowy przepływ pracy podpisywania

Kompletny przepływ podpisywania zawiera powyższe akcje w kolejności. Typowy przepływ Power Automate wygląda następująco:

Utwórz kopertę — ustaw nazwę, temat/treść powiadomienia i tryb podpisywania (parallel lub sequential). Zapisz zwrócony identyfikator koperty.
Utwórz dokument według identyfikatora koperty — przekaż co najmniej jeden plik do koperty (przy użyciu identyfikatora koperty z kroku 1). Zapisz każdy zwrócony identyfikator dokumentu.
(Opcjonalnie)Zmień kolejność dokumentów według identyfikatora koperty — ustaw kolejność dokumentów.
Utwórz uczestników według identyfikatora koperty — dodaj osoby podpisujących i adresatów CC przy użyciu uwierzytelniania kodu dostępu. Zapisz każdy zwrócony identyfikator uczestnika.
Utwórz pola według identyfikatora dokumentu — umieść podpis/datę/itp. pola dla każdego dokumentu i przypisz je uczestnikom (przy użyciu identyfikatora dokumentu z kroku 2 i identyfikatora uczestnika z kroku 3).
Wyślij kopertę do podpisania — wyślij kopertę. Wszystkie dokumenty muszą najpierw znajdować się w stanie przekazanym.
(Oczekując)Wyślij przypomnienia dotyczące koperty , aby nachylić uczestników lub anuluj kopertę według identyfikatora , aby zatrzymać żądanie.
(Po zakończeniu)Pobierz zapieczętowany dokument pobierz zapieczętowany / dokument według identyfikatora / Pobierz dziennik inspekcji koperty , aby pobrać gotowe pliki.

Porada: Identyfikator koperty, Identyfikator dokumentu i Identyfikator uczestnika zwrócony przez akcje tworzenia naturalnie do późniejszych akcji za pośrednictwem selektora zawartości dynamicznej Power Automate — wybierz token identyfikatora z akcji nadrzędnej, a nie wpisując go.

Błędy i ograniczanie przepustowości

Interfejs API podpisywania Nitro może zwrócić następujące błędy:

400 — Nieprawidłowe żądanie
401 — Brak autoryzacji
404 — Nie znaleziono
409 — Konflikt (np. działanie na kopercie w stanie, który nie zezwala na operację)
413 — Zawartość jest za duża
415 — nieobsługiwany typ nośnika
422 — Nieprocesowa jednostka
500 — Wewnętrzny błąd serwera

Ograniczanie prędkości

Wywołania interfejsu API na połączenie: 100 na 60 sekund.

Limity platformy

Rozmiar pliku

Maksymalna: 25 MB na żądanie
Dotyczy zarówno operacji z jednym plikiem, jak i z wieloma plikami.

Liczba stron

Maksymalna: 250 stron na pojedynczy dokument
Łączna liczba połączonych stron w wielu dokumentach może przekroczyć 250.

Czas przechowywania

Pliki wejściowe i wyjściowe są usuwane ok. 15 minut po zakończeniu operacji.

Notes

Akcje zarządzania kopertami, dokumentami, polami i uczestnikami zwracają kod JSON.
Akcje pobierania zwracają plik (ZIP lub PDF) opakowany w kopertę JSON uwidaczniającej nazwę pliku, typ zawartości pliku i zawartość pliku jako tokeny natywne selektora, dzięki czemu wyniki można połączyć w akcję pliku podrzędnego bez wyrażeń.
Tryb podpisywania (parallel vs sequential) jest ustawiany po utworzeniu koperty i można go zmienić za pomocą koperty aktualizacji przed wysłaniem koperty.
Uwierzytelnianie uczestnika obecnie obsługuje tylko kod dostępu .

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:


Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Required
Identyfikator klienta Nitro	securestring	Identyfikator klienta aplikacji Nitro	True
Klucz tajny klienta Nitro	securestring	Klucz tajny klienta aplikacji Nitro	True
Nitro Region	ciąg	Wybierz region interfejsu API Nitro dla swojego konta.	True

Akcje

Aktualizowanie dokumentu według identyfikatora	Aktualizuje metadane istniejącego dokumentu w kopercie znaku Nitro. Obecnie można zaktualizować tylko nazwę dokumentu.
Aktualizowanie pola według identyfikatora	Aktualizuje właściwości istniejącego pola w dokumencie z podpisem nitro. Typ pola musi być podany i musi być zgodny z istniejącym typem pola; Jest on używany przez interfejs API do identyfikowania schematu pola i nie zmienia typu pola.
Aktualizowanie uczestnika według identyfikatora	Aktualizuje ustawienia uwierzytelniania uczestnika w kopercie z podpisem Nitro. Nie można zaktualizować wiadomości e-mail uczestnika.
Aktualizuj kopertę	Aktualizuje istniejącą kopertę z podpisem nitro. Możesz zmodyfikować nazwę koperty, ustawienia powiadomień, tryb podpisywania lub dowolną kombinację tych pól.
Anuluj kopertę według identyfikatora	Anuluje żądanie podpisania koperty Nitro Sign. Można anulować tylko koperty, które zostały wysłane do podpisania.
Listy kopert	Punkt końcowy List Envelopes zwraca wszystkie koperty skojarzone z aplikacją na koncie.
Pobieranie dokumentu według identyfikatora	Pobiera szczegóły określonego dokumentu w kopercie z znakiem nitro.
Pobieranie koperty według identyfikatora	Pobiera szczegóły dla określonej koperty z podpisem Nitro przy użyciu jego unikatowego identyfikatora koperty.
Pobieranie zapieczętowanego dokumentu według identyfikatora	Pobiera pojedynczy zapieczętowany podpisany dokument z koperty Nitro Sign jako plik PDF.
Pobierz dziennik inspekcji koperty	Pobiera plik PDF zawierający pełny dziennik inspekcji dla wybranej koperty z podpisem Nitro.
Pobierz oryginalną kopertę	Pobiera oryginalne niepodpisane dokumenty z koperty Nitro Sign jako archiwum ZIP.
Pobierz zapieczętowaną kopertę	Pobiera zapieczętowane podpisane dokumenty z koperty Nitro Sign wraz z dziennikiem inspekcji jako archiwum ZIP.
Pola listy według identyfikatora dokumentu	Pobiera wszystkie pola skojarzone z określonym dokumentem w kopercie Nitro Sign.
Tworzenie dokumentu według identyfikatora koperty	Przekazuje dokument do istniejącej koperty z podpisem Nitro. Dokument może być później używany w przepływie pracy podpisywania.
Tworzenie koperty	Tworzy nową kopertę z podpisem Nitro, która może zostać później wypełniona dokumentami, uczestnikami, polami i wysłanymi do podpisania.
Tworzenie pól według identyfikatora dokumentu	Tworzy co najmniej jedno pole w dokumencie i przypisuje je uczestnikom. Aby utworzyć jedno pole, podaj jeden element w tablicy Pola. Aby utworzyć wiele pól, podaj wiele elementów.
Tworzenie uczestników według identyfikatora koperty	Dodaje co najmniej jednego uczestnika do koperty Nitro Sign. Aby dodać jednego uczestnika, podaj jeden element w tablicy Uczestnicy. Aby dodać wielu uczestników, podaj wiele elementów.
Usuwanie dokumentu według identyfikatora	Trwale usuwa dokument z koperty z znaku Nitro.
Usuń kopertę według identyfikatora	Trwale usuwa kopertę z znakiem nitro. Nie można cofnąć tej operacji, a wszystkie skojarzone dokumenty, pola i uczestnicy również zostaną usunięte.
Usuń pole według identyfikatora	Trwale usuwa pole z dokumentu w kopercie Nitro Sign.
Usuń uczestnika według identyfikatora	Trwale usuwa uczestnika z koperty Nitro Sign.
Wysyłanie koperty do podpisywania	Wysyła kopertę Nitro Sign do uczestników na potrzeby zbierania podpisów. Przed użyciem tej akcji koperta powinna zwykle zawierać dokumenty, uczestników i pola podpisywania dodane przy użyciu polecenia Utwórz dokument według identyfikatora koperty, tworzenia uczestników według identyfikatora koperty i tworzenia pól według identyfikatora dokumentu. Wszystkie dokumenty w kopercie muszą mieć stan przekazania przed wysłaniem koperty.
Wysyłanie przypomnień dla koperty	Wyzwala powiadomienia z przypomnieniami do oczekujących uczestników określonej koperty znaku Nitro. Jeśli nie podano żadnych ustawień powiadomień, zostanie użyty domyślny szablon powiadomienia skonfigurowany dla koperty.
Wyświetlanie listy dokumentów według identyfikatora koperty	Pobiera wszystkie dokumenty skojarzone z konkretną kopertą z znakiem nitro.
Wyświetlanie listy uczestników według identyfikatora koperty	Pobiera wszystkich uczestników skojarzonych z konkretną kopertą z znakiem Nitro.
Zmienianie kolejności dokumentów według identyfikatora koperty	Zmienia kolejność dokumentów skojarzonych z konkretną kopertą pod znakiem Nitro na podstawie podanej listy identyfikatorów dokumentów.

Aktualizowanie dokumentu według identyfikatora

Identyfikator operacji:: UpdateDocumentByID

Aktualizuje metadane istniejącego dokumentu w kopercie znaku Nitro. Obecnie można zaktualizować tylko nazwę dokumentu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument do aktualizacji.
Nazwa dokumentu	name	True	string	Nowa nazwa dokumentu.

Zwraca

Szczegóły dokumentu z podpisem nitro.

Body: DocumentResponse

Aktualizowanie pola według identyfikatora

Identyfikator operacji:: UpdateFieldByID

Aktualizuje właściwości istniejącego pola w dokumencie z podpisem nitro. Typ pola musi być podany i musi być zgodny z istniejącym typem pola; Jest on używany przez interfejs API do identyfikowania schematu pola i nie zmienia typu pola.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument zawierający pole.
Identyfikator pola	fieldID	True	uuid	Unikatowy identyfikator UUID identyfikujący pole do zaktualizowania.
Typ pola	type	True	string	Bieżący typ aktualizowanego pola. Ta wartość jest wymagana przez interfejs API i musi być zgodna z istniejącym typem pola; nie zmienia typu pola.
Identyfikator uczestnika	participantID		uuid	Unikatowy identyfikator uczestnika przypisanego do pola.
Strona	page		integer	Numer strony, na której jest wyświetlane pole. Strony używają indeksowania opartego na 1.
Położenie X	x		float	Optional. Położenie w poziomie pola mierzone od lewej krawędzi strony w punktach.
Położenie Y	y		float	Optional. Pozycja pionowa pola mierzona od górnej krawędzi strony w punktach.
Szerokość	width		float	Optional. Szerokość pola w punktach.
Wysokość	height		float	Optional. Wysokość pola w punktach.
Required	required		boolean	Wskazuje, czy uczestnik musi ukończyć to pole.
Format	format		string	Format pola, jeśli ma to zastosowanie. Na przykład pola daty mogą używać formatu, takiego jak MM/DD/RRRR.
Można modyfikować	modifiable		boolean	Wskazuje, czy wartość pola jest modyfikowalna, jeśli ma to zastosowanie.

Zwraca

Szczegóły pola Znak nitro.

Body: FieldResponse

Aktualizowanie uczestnika według identyfikatora

Identyfikator operacji:: UpdateParticipantByID

Aktualizuje ustawienia uwierzytelniania uczestnika w kopercie z podpisem Nitro. Nie można zaktualizować wiadomości e-mail uczestnika.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą uczestnika.
Identyfikator uczestnika	participantID	True	uuid	Unikatowy identyfikator UUID identyfikujący uczestnika do aktualizacji.
Typ uwierzytelniania	type		string	Optional. Wybierz metodę uwierzytelniania dla uczestnika. Jeśli zostanie określony, należy również podać kod dostępu.
Kod dostępu	accessCode		string	Wymagane tylko wtedy, gdy określono typ uwierzytelniania. Pozostaw wartość pustą, jeśli uwierzytelnianie uczestnika nie jest wymagane.

Zwraca

Szczegóły uczestnika funkcji Nitro Sign.

Body: ParticipantResponse

Aktualizuj kopertę

Identyfikator operacji:: UpdateEnvelope

Aktualizuje istniejącą kopertę z podpisem nitro. Możesz zmodyfikować nazwę koperty, ustawienia powiadomień, tryb podpisywania lub dowolną kombinację tych pól.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę do aktualizacji.
Nazwa koperty	name		string	Zaktualizowana nazwa koperty. Nie musi być unikatowa.
Temat powiadomienia	subject		string	Wiersz tematu powiadomienia e-mail wysłanego do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: $(sender_name_or_email) żąda podpisu.
Treść notyfikacji	body		string	Treść wiadomości e-mail wysłana do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: Witaj,\nProszę podpisać $(envelope_name)\nDziękuję,\n$(sender_name_or_email).
Tryb podpisywania	mode		string	Definiuje kolejność podpisywania. Użyj funkcji równoległej, aby powiadomić wszystkich uczestników w tym samym czasie lub sekwencyjne, aby powiadomić uczestników o jednej o jednej w kolejności, w której zostali dodani.

Zwraca

Odpowiedź zwrócona po zażądaniu lub utworzeniu koperty znaku nitro.

Body: EnvelopeResponse

Anuluj kopertę według identyfikatora

Identyfikator operacji:: CancelEnvelopeByID

Anuluje żądanie podpisania koperty Nitro Sign. Można anulować tylko koperty, które zostały wysłane do podpisania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę do anulowania.

Zwraca

Odpowiedź zwrócona po zażądaniu lub utworzeniu koperty znaku nitro.

Body: EnvelopeResponse

Listy kopert

Identyfikator operacji:: ListEnvelopes

Punkt końcowy List Envelopes zwraca wszystkie koperty skojarzone z aplikacją na koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Strona po	pageAfter		string	Opcjonalny token kursora używany do pobierania następnej strony kopert. Użyj wartości nextPage zwróconej przez poprzednią odpowiedź.
Strona przed	pageBefore		string	Opcjonalny token kursora używany do pobierania poprzedniej strony kopert. Nie używaj razem ze stroną po.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Koperty	items	array of EnvelopeSummaryResponse	Lista kopert.
Następna strona	nextPage	string	Token kursora, który może być używany jako Strona po, aby pobrać następną stronę kopert.

Pobieranie dokumentu według identyfikatora

Identyfikator operacji:: GetDocumentByID

Pobiera szczegóły określonego dokumentu w kopercie z znakiem nitro.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument do pobrania.

Zwraca

Szczegóły dokumentu z podpisem nitro.

Body: DocumentResponse

Pobieranie koperty według identyfikatora

Identyfikator operacji:: GetEnvelopeByID

Pobiera szczegóły dla określonej koperty z podpisem Nitro przy użyciu jego unikatowego identyfikatora koperty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę do pobrania.

Zwraca

Odpowiedź zwrócona po zażądaniu lub utworzeniu koperty znaku nitro.

Body: EnvelopeResponse

Pobieranie zapieczętowanego dokumentu według identyfikatora

Identyfikator operacji:: DownloadSealedDocumentByID

Pobiera pojedynczy zapieczętowany podpisany dokument z koperty Nitro Sign jako plik PDF.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą zapieczętowany dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący zapieczętowany dokument do pobrania.

Zwraca

Pobrany plik opakowany jako koperta JSON.

Body: FileDownloadResponse

Pobierz dziennik inspekcji koperty

Identyfikator operacji:: DownloadAuditTrailOfEnvelope

Pobiera plik PDF zawierający pełny dziennik inspekcji dla wybranej koperty z podpisem Nitro.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której dziennik inspekcji należy pobrać.

Zwraca

Pobrany plik opakowany jako koperta JSON.

Body: FileDownloadResponse

Pobierz oryginalną kopertę

Identyfikator operacji:: DownloadOriginalEnvelope

Pobiera oryginalne niepodpisane dokumenty z koperty Nitro Sign jako archiwum ZIP.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której oryginalne dokumenty należy pobrać.

Zwraca

Pobrany plik opakowany jako koperta JSON.

Body: FileDownloadResponse

Pobierz zapieczętowaną kopertę

Identyfikator operacji:: DownloadSealedEnvelope

Pobiera zapieczętowane podpisane dokumenty z koperty Nitro Sign wraz z dziennikiem inspekcji jako archiwum ZIP.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której zapieczętowane dokumenty należy pobrać.

Zwraca

Pobrany plik opakowany jako koperta JSON.

Body: FileDownloadResponse

Pola listy według identyfikatora dokumentu

Identyfikator operacji:: ListFieldsByDocumentID

Pobiera wszystkie pola skojarzone z określonym dokumentem w kopercie Nitro Sign.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument, którego pola należy pobrać.

Zwraca

Odpowiedź zwrócona po utworzeniu co najmniej jednego pola.

Body: FieldsResponse

Tworzenie dokumentu według identyfikatora koperty

Identyfikator operacji:: CreateDocumentByEnvelopeID

Przekazuje dokument do istniejącej koperty z podpisem Nitro. Dokument może być później używany w przepływie pracy podpisywania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, w której zostanie przekazany dokument.
Nazwa dokumentu	documentName	True	string	Nazwa dokumentu do przekazania. Ta wartość zostanie użyta do skompilowania metadanych dokumentu wysyłanych do nitro.
Typ zawartości	contentType		string	Typ zawartości przekazanego dokumentu. W przypadku plików PDF użyj pliku application/pdf. Po pominięciu z metadanych akceptowane są tylko pliki PDF.
Plik dokumentu	payload	True	file	Plik dokumentu do przekazania do koperty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Identyfikator dokumentu	ID	uuid	Unikatowy identyfikator UUID identyfikujący przekazany dokument.
Nazwa dokumentu	name	string	Nazwa przekazanego dokumentu.
Data utworzenia	createdAt	string	Sygnatura czasowa wskazująca, kiedy dokument został utworzony.
Stan dokumentu	status	string	Stan przetwarzania przekazanego dokumentu.

Tworzenie koperty

Identyfikator operacji:: CreateEnvelope

Tworzy nową kopertę z podpisem Nitro, która może zostać później wypełniona dokumentami, uczestnikami, polami i wysłanymi do podpisania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa koperty	name	True	string	Nazwa koperty. Nie musi być unikatowa.
Tryb podpisywania	mode	True	string	Definiuje kolejność podpisywania. Użyj funkcji równoległej, aby powiadomić wszystkich uczestników w tym samym czasie lub sekwencyjne, aby powiadomić uczestników o jednej o jednej w kolejności, w której zostali dodani.
Temat powiadomienia	subject	True	string	Wiersz tematu powiadomienia e-mail wysłanego do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: $(sender_name_or_email) żąda podpisu.
Treść notyfikacji	body	True	string	Treść wiadomości e-mail wysłana do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: Witaj,\nProszę podpisać $(envelope_name)\nDziękuję,\n$(sender_name_or_email).

Zwraca

Odpowiedź zwrócona po zażądaniu lub utworzeniu koperty znaku nitro.

Body: EnvelopeResponse

Tworzenie pól według identyfikatora dokumentu

Identyfikator operacji:: CreateFieldsByDocumentID

Tworzy co najmniej jedno pole w dokumencie i przypisuje je uczestnikom. Aby utworzyć jedno pole, podaj jeden element w tablicy Pola. Aby utworzyć wiele pól, podaj wiele elementów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument, w którym należy tworzyć pola.
Identyfikator uczestnika	participantID	True	uuid	Unikatowy identyfikator uczestnika przypisanego do pola.
Strona	page	True	integer	Numer strony, w którym należy umieścić pole. Strony używają indeksowania opartego na 1, więc pierwsza strona to 1.
Typ pola	type	True	string	Typ pola do utworzenia.
Położenie X	x	True	float	Położenie w poziomie pola mierzone od lewej krawędzi strony w punktach.
Położenie Y	y	True	float	Pozycja pionowa pola mierzona od górnej krawędzi strony w punktach.
Szerokość	width	True	float	Szerokość pola w punktach.
Wysokość	height	True	float	Wysokość pola w punktach.
Required	required		boolean	Wskazuje, czy uczestnik musi ukończyć to pole.
Format	format		string	Opcjonalny format dla typów pól, które obsługują formatowanie, na przykład pola daty. Przykład: MM/DD/RRRR.
Można modyfikować	modifiable		boolean	Wskazuje, czy wartość pola może zostać zmodyfikowana przez uczestnika, gdzie jest obsługiwana przez typ pola.

Zwraca

Odpowiedź zwrócona po utworzeniu co najmniej jednego pola.

Body: FieldsResponse

Tworzenie uczestników według identyfikatora koperty

Identyfikator operacji:: CreateParticipantsByEnvelopeID

Dodaje co najmniej jednego uczestnika do koperty Nitro Sign. Aby dodać jednego uczestnika, podaj jeden element w tablicy Uczestnicy. Aby dodać wielu uczestników, podaj wiele elementów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, w której należy dodać uczestników.
Email	email	True	email	Adres e-mail uczestnika.
Role	role	True	string	Rola uczestnika. Podpisujący może mieć pola przypisane do podpisywania. Uczestnik cc ma dostęp tylko do odczytu.
Typ uwierzytelniania	type		string	Optional. Wybierz metodę uwierzytelniania dla uczestnika. Jeśli zostanie określony, należy również podać kod dostępu.
Kod dostępu	accessCode		string	Wymagane tylko wtedy, gdy określono typ uwierzytelniania. Pozostaw wartość pustą, jeśli uwierzytelnianie uczestnika nie jest wymagane.

Zwraca

Odpowiedź została zwrócona po utworzeniu co najmniej jednego uczestnika.

Body: ParticipantsResponse

Usuwanie dokumentu według identyfikatora

Identyfikator operacji:: DeleteDocumentByID

Trwale usuwa dokument z koperty z znaku Nitro.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument do usunięcia.

Usuń kopertę według identyfikatora

Identyfikator operacji:: DeleteEnvelopeByID

Trwale usuwa kopertę z znakiem nitro. Nie można cofnąć tej operacji, a wszystkie skojarzone dokumenty, pola i uczestnicy również zostaną usunięte.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę do usunięcia.

Usuń pole według identyfikatora

Identyfikator operacji:: DeleteFieldByID

Trwale usuwa pole z dokumentu w kopercie Nitro Sign.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą dokument.
Identyfikator dokumentu	documentID	True	uuid	Unikatowy identyfikator UUID identyfikujący dokument zawierający pole.
Identyfikator pola	fieldID	True	uuid	Unikatowy identyfikator UUID identyfikujący pole do usunięcia.

Usuń uczestnika według identyfikatora

Identyfikator operacji:: DeleteParticipantByID

Trwale usuwa uczestnika z koperty Nitro Sign.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę zawierającą uczestnika.
Identyfikator uczestnika	participantID	True	uuid	Unikatowy identyfikator UUID identyfikujący uczestnika do usunięcia.

Wysyłanie koperty do podpisywania

Identyfikator operacji:: SendEnvelopeForSigning

Wysyła kopertę Nitro Sign do uczestników na potrzeby zbierania podpisów. Przed użyciem tej akcji koperta powinna zwykle zawierać dokumenty, uczestników i pola podpisywania dodane przy użyciu polecenia Utwórz dokument według identyfikatora koperty, tworzenia uczestników według identyfikatora koperty i tworzenia pól według identyfikatora dokumentu. Wszystkie dokumenty w kopercie muszą mieć stan przekazania przed wysłaniem koperty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę do wysłania do podpisania.

Zwraca

Podsumowanie informacji na temat koperty z znakiem nitro.

Body: EnvelopeSummaryResponse

Wysyłanie przypomnień dla koperty

Identyfikator operacji:: SendRemindersForEnvelope

Wyzwala powiadomienia z przypomnieniami do oczekujących uczestników określonej koperty znaku Nitro. Jeśli nie podano żadnych ustawień powiadomień, zostanie użyty domyślny szablon powiadomienia skonfigurowany dla koperty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, dla której powinny być wysyłane powiadomienia z przypomnieniami.
Temat powiadomienia	subject		string	Wiersz tematu powiadomienia e-mail wysłanego do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: $(sender_name_or_email) żąda podpisu.
Treść notyfikacji	body		string	Treść wiadomości e-mail wysłana do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: Witaj,\nProszę podpisać $(envelope_name)\nDziękuję,\n$(sender_name_or_email).

Wyświetlanie listy dokumentów według identyfikatora koperty

Identyfikator operacji:: ListDocumentsByEnvelopeID

Pobiera wszystkie dokumenty skojarzone z konkretną kopertą z znakiem nitro.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której dokumenty należy pobrać.

Zwraca

Odpowiedź zwrócona podczas wyświetlania listy dokumentów skojarzonych z kopertą znaku Nitro.

Body: ListDocumentsByEnvelopeIDResponse

Wyświetlanie listy uczestników według identyfikatora koperty

Identyfikator operacji:: ListParticipantsByEnvelopeID

Pobiera wszystkich uczestników skojarzonych z konkretną kopertą z znakiem Nitro.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której uczestnicy powinni zostać pobrani.

Zwraca

Odpowiedź zwrócona podczas wyświetlania listy uczestników skojarzonych z kopertą Nitro Sign.

Body: ParticipantsListResponse

Zmienianie kolejności dokumentów według identyfikatora koperty

Identyfikator operacji:: ReorderDocumentsByEnvelopeID

Zmienia kolejność dokumentów skojarzonych z konkretną kopertą pod znakiem Nitro na podstawie podanej listy identyfikatorów dokumentów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	envelopeID	True	uuid	Unikatowy identyfikator UUID identyfikujący kopertę, której dokumenty powinny być zmieniane.
Identyfikatory dokumentów	order	True	array of uuid	Tablica identyfikatorów dokumentów reprezentujących nową kolejność dokumentów w kopercie.

Zwraca

Odpowiedź zwrócona podczas wyświetlania listy dokumentów skojarzonych z kopertą znaku Nitro.

Body: ListDocumentsByEnvelopeIDResponse

Definicje

KopertaNotyfikacja

Ustawienia wiadomości e-mail z powiadomieniem dla koperty z podpisem Nitro.

Nazwa	Ścieżka	Typ	Opis
Temat powiadomienia	subject	string	Wiersz tematu powiadomienia e-mail wysłanego do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: $(sender_name_or_email) żąda podpisu.
Treść notyfikacji	body	string	Treść wiadomości e-mail wysłana do uczestników podpisywania. Zmienne dynamiczne są obsługiwane, na przykład: Witaj,\nProszę podpisać $(envelope_name)\nDziękuję,\n$(sender_name_or_email).

KopertySummaryResponse

Podsumowanie informacji na temat koperty z znakiem nitro.

Nazwa	Ścieżka	Typ	Opis
Identyfikator koperty	ID	uuid	Unikatowy identyfikator UUID identyfikujący kopertę.
Data utworzenia	createdAt	date-time	Sygnatura czasowa UTC wskazująca, kiedy została utworzona koperta.
Ostatnia modyfikacja:	lastModifiedAt	date-time	Sygnatura czasowa UTC wskazująca, kiedy koperta została ostatnio zmodyfikowana.
Nazwa koperty	name	string	Nazwa koperty.
Stan koperty	status	string	Stan wewnętrzny koperty.

KopertaResponse

Odpowiedź zwrócona po zażądaniu lub utworzeniu koperty znaku nitro.

Nazwa	Ścieżka	Typ	Opis
Identyfikator koperty	ID	uuid	Unikatowy identyfikator UUID identyfikujący kopertę.
Data utworzenia	createdAt	date-time	Sygnatura czasowa UTC wskazująca, kiedy została utworzona koperta.
Ostatnia modyfikacja:	lastModifiedAt	date-time	Sygnatura czasowa UTC wskazująca, kiedy koperta została ostatnio zmodyfikowana.
Nazwa koperty	name	string	Nazwa koperty.
Stan koperty	status	string	Stan wewnętrzny koperty.
Tryb podpisywania	mode	string	Tryb podpisywania skonfigurowany dla koperty.
powiadomienie	notification	EnvelopeNotification	Ustawienia wiadomości e-mail z powiadomieniem dla koperty z podpisem Nitro.

ListDocumentsByEnvelopeIDResponse

Odpowiedź zwrócona podczas wyświetlania listy dokumentów skojarzonych z kopertą znaku Nitro.

Nazwa	Ścieżka	Typ	Opis
Documents	items	array of DocumentResponse	Lista dokumentów skojarzonych z kopertą.

DocumentResponse

Szczegóły dokumentu z podpisem nitro.

Nazwa	Ścieżka	Typ	Opis
Identyfikator dokumentu	ID	uuid	Unikatowy identyfikator UUID identyfikujący dokument.
Nazwa dokumentu	name	string	Nazwa dokumentu.
Data utworzenia	createdAt	date-time	Sygnatura czasowa UTC wskazująca, kiedy dokument został utworzony.
Rozmiar w bajtach	sizeBytes	integer	Rozmiar dokumentu w bajtach.
Liczba stron	numPages	integer	Liczba stron w dokumencie.
Stan dokumentu	status	string	Bieżący stan dokumentu.

PolaResponse

Odpowiedź zwrócona po utworzeniu co najmniej jednego pola.

Nazwa	Ścieżka	Typ	Opis
Fields	items	array of FieldResponse	Pola utworzone w tym żądaniu.

FieldResponse

Szczegóły pola Znak nitro.

Nazwa	Ścieżka	Typ	Opis
Identyfikator pola	ID	uuid	Unikatowy identyfikator UUID identyfikujący pole.
Identyfikator uczestnika	participantID	uuid	Unikatowy identyfikator uczestnika przypisanego do pola.
Identyfikator dokumentu	documentID	uuid	Unikatowy identyfikator dokumentu, do którego należy pole.
Strona	page	integer	Numer strony, na której jest wyświetlane pole.
Ramka ograniczająca	boundingBox	array of float	Tablica czterech liczb w formacie [x, y, width, height], mierzona w punktach.
Required	required	boolean	Wskazuje, czy uczestnik musi ukończyć to pole.
Typ pola	type	string	Typ pola.
Format	format	string	Format pola, jeśli ma to zastosowanie.
Można modyfikować	modifiable	boolean	Wskazuje, czy wartość pola jest modyfikowalna, jeśli ma to zastosowanie.

UczestnicyResponse

Odpowiedź została zwrócona po utworzeniu co najmniej jednego uczestnika.

Nazwa	Ścieżka	Typ	Opis
Uczestnicy	items	array of ParticipantResponse	Uczestnicy utworzone w tym żądaniu.

UczestnicyListResponse

Odpowiedź zwrócona podczas wyświetlania listy uczestników skojarzonych z kopertą Nitro Sign.

Nazwa	Ścieżka	Typ	Opis
Uczestnicy	items	array of ParticipantResponse	Uczestnicy związani z kopertą.
Łączna liczba uczestników	total	integer	Całkowita liczba uczestników dostępnych w kolekcji.

UczestnikResponse

Szczegóły uczestnika funkcji Nitro Sign.

Nazwa	Ścieżka	Typ	Opis
Identyfikator uczestnika	ID	uuid	Unikatowy identyfikator UUID identyfikujący uczestnika.
Email	email	email	Adres e-mail uczestnika.
Role	role	string	Rola uczestnika.
uwierzytelnianie	authentication	ParticipantAuthenticationResponse	Ustawienia uwierzytelniania zwrócone dla uczestnika.

UczestnikAuthenticationResponse

Ustawienia uwierzytelniania zwrócone dla uczestnika.

Nazwa	Ścieżka	Typ	Opis
Typ uwierzytelniania	type	string	Typ uwierzytelniania uczestnika.
Kod dostępu	accessCode	string	Kod dostępu skonfigurowany dla uczestnika.

FileDownloadResponse

Pobrany plik opakowany jako koperta JSON.

Nazwa	Ścieżka	Typ	Opis
Nazwa pliku	fileName	string	Nazwa pobranego pliku pochodzącego z nagłówka Content-Disposition odpowiedzi (na przykład result.zip lub result.pdf). Upuść ten token bezpośrednio do danych wejściowych Nazwa pliku akcji podrzędnej, takiej jak OneDrive lub SharePoint Utwórz plik.
Typ zawartości pliku	fileContentType	string	Typ MIME pobranego pliku, na przykład application/zip lub application/pdf.
Zawartość pliku	fileContent	byte	Zawartość pliku zakodowana w formacie base64. Upuść ten token bezpośrednio do danych wejściowych zawartości pliku akcji podrzędnej (na przykład OneDrive lub SharePoint utwórz plik lub inną akcję Nitro) — nie jest wymagane wyrażenie.