Freigeben über

Nitro Sign Enterprise Verified (Vorschau)

Nitro Sign Enterprise Verified ist eine renommierte digitale Signaturlösung, die eine große Menge an Signaturmethoden und Compliance für die strengsten (inter)nationalen Vorschriften bietet. NSEV ermöglicht es Ihnen, jeden papierbasierten Prozess in einen end-to-end digitalen Fluss mit einer beispiellosen Benutzererfahrung umzuwandeln. Optimieren Sie den Signierungsprozess genau so, wie sie es soll, und verfolgen Sie alle Arten von Dokumenten direkt aus Ihren bevorzugten Geschäftsanwendungen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Nitro-Unterstützung
URL https://www.gonitro.com/support
Email service@gonitro.com
Connectormetadaten
Herausgeber Nitro Software Belgium NV
Webseite https://www.gonitro.com
Datenschutzrichtlinie https://www.gonitro.com/legal/privacy-policy
Kategorien IT-Vorgänge; Produktivität

Nitro Sign Enterprise Verified Connector

Nitro Software, ein Spezialist für Smart Document Solutions, hat den Nitro Sign Enterprise Verified Connector für Power Automate zur Verwendung zur Verfügung gestellt. Mit dem Connector können Unternehmen Dokumente weiterleiten, die eine digitale Signatur direkt von ihren bevorzugten Microsoft 365-Anwendungen erfordern – von Microsoft Teams an Word, SharePoint, Dynamics, OneDrive und viele andere. Nitro Sign Enterprise Verified - früher bekannt als Nitro Sign Premium und Connective eSignatures.

Voraussetzungen

Um mit der Nutzung des Connectors zu beginnen, ist ein vorhandenes Abonnement für Nitro Sign Enterprise Verified erforderlich. Wenden Sie sich an Ihren Kontakt bei Nitro Software, oder besuchen Sie unsere Hilfe- und Supportseite auf unserer Website, um die Anmeldeinformationen zu erhalten.

Dokumentation

Auf dieser Seite werden die verschiedenen verfügbaren Aktionen genauer beschrieben, sowie Einblicke in die verschiedenen Möglichkeiten zur Implementierung dieser Aktionen bereitgestellt.

Zögern Sie nicht, sich unsere Dokumentationswebsite anzusehen, um weitere Informationen zu erhalten, oder wenden Sie sich über unsere Hilfe- und Supportseite oder das Supportpostfach an das Supportteam: mailto:service@gonitro.com. Die API-Dokumentation ist auch im Postman-Format verfügbar.

Ein Glossar ist verfügbar, um die verschiedenen Begriffe zu erläutern, die in dieser Dokumentation verwendet werden.

Unterstützte Vorgänge

Der Nitro Sign Enterprise Verified Connector basiert auf API v4 von Nitro Sign Enterprise Verified. Die API ist eine REST-API, die es externen Anwendungen ermöglicht, in diese zu integrieren und die in diesem Dokument aufgeführten Features zum Erstellen und Verwalten von Signaturflüssen zu verwenden.

Die verfügbaren Aktionen können in verschiedene Gruppen gruppiert werden.

Bürgerinitiative Verfügbare Aktionen
Pakete Abrufen aller Pakete
Paket nach ID abrufen
Paketstatus abrufen
Erstellen eines neuen Pakets (Standard oder Sofort)
Löschen eines Pakets nach ID
Aktualisieren des Status eines Pakets
Abrufen des Ablaufdatums eines Pakets
Aktualisieren des Ablaufdatums eines Pakets
Signierer überspringen
Erinnerungen senden
Herunterladen eines Pakets
Herunterladen des Überwachungspfads eines Pakets
Dokumente Hinzufügen eines Dokuments zu einem Paket
Herunterladen eines signierten Dokuments aus einem Paket
Projektbeteiligte Löschen eines Stakeholders nach ID
Abrufen aller Projektbeteiligten eines Pakets
Hinzufügen eines Stakeholders zu einem Paket
Prozess Abrufen aller Prozessschritte eines Pakets
Prozess Hinzufügen eines Schritts im Prozess des Pakets
Prozess Überschreiben von Prozessschritten eines Pakets
Prozess Abrufen aller Aktionen eines Prozessschritts
Prozess Löschen eines Prozessschritts und aller akteure
Prozess Hinzufügen eines Akteurs zu einem Prozessschritt
Prozess Abrufen aller Aktionen im aktuellen Prozessschritt
Other Abrufen aller in der Anwendung aktivierten Sprachen
Abrufen aller Designs, die einem Paket zugewiesen werden können
Abrufen aller Dokumentgruppen, denen ein Paket zugewiesen werden kann
Abrufen aller konfigurierten Signaturmethoden

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Nitro Sign-Host Schnur Host und Pfad zu Ihrer Nitro Sign-Umgebung, z. B. contoso.sign.gonitro.com/esig Richtig
API-Benutzername securestring API-Benutzername für den Zugriff auf die API Richtig
API-Kennwort securestring API-Kennwort für den Zugriff auf die API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen aller Aktionen eines Prozessschritts

Ruft einen bestimmten Satz von Aktionen ab, die parallel vom Prozess abgeschlossen werden können.
Abrufen aller Aktionen im aktuellen Prozessschritt

Ruft den aktuellen Satz von Aktionen ab, die parallel abgeschlossen werden können.
Abrufen aller Designs, die einem Paket zugewiesen werden können

Ruft alle Designs ab, die einem Paket zugewiesen werden können. Möglich, um das Ergebnis durch Angabe einer Maximalen Menge und eines Fortsetzungstokens zu überblättern
Abrufen aller Dokumentgruppen, denen Pakete zugewiesen werden können

Ruft alle Dokumentgruppen ab, denen Pakete zugewiesen werden können
Abrufen aller Pakete

Ruft alle Pakete ab, diese werden nach creationDate sortiert.
Abrufen aller Projektbeteiligten eines Pakets

Ruft die Projektbeteiligten des Pakets ab.
Abrufen aller Prozessschritte

Ruft alle Aktionen ab, die für das Paket ausgeführt werden müssen.
Abrufen aller Sprachen, die in der Anwendung aktiviert sind

Ruft alle Sprachen ab, die in der Anwendung aktiviert sind.
Abrufen des Ablaufdatums eines Pakets

Abrufen des Ablaufdatums eines Pakets
Aktualisieren des Ablaufdatums eines Pakets

Aktualisieren des Ablaufdatums eines Pakets
Dokument aus Paket herunterladen

Laden Sie ein signiertes Dokument aus einem Paket herunter. Jedes Dokument wird als PDF- oder XML-Datei heruntergeladen.
Erstellen eines neuen Pakets (Standard oder Sofort)

Erstellt ein neues Paket. Standardmäßig wird das Paket als Entwurf erstellt. Um ein Sofortpaket zu erstellen, das sofort zum Signieren bereit ist, legen Sie die status Eigenschaft auf Pending.

Anmerkung: Der POST /packages Endpunkt ermöglicht Ihnen das Erstellen von Standard- und Sofortpaketen.
Herunterladen des Überwachungspfads des Pakets

Laden Sie einen signierten Überwachungspfad über die Lebensdauer eines Pakets herunter.
Hinzufügen eines Akteurs zu einem Prozessschritt

Fügt einem Prozessschritt einen Akteur hinzu.
Hinzufügen eines Dokuments zu einem Paket

Fügt einem vorhandenen Paket ein Dokument hinzu.
Hinzufügen eines Schritts im Prozess des Pakets

Fügt dem Prozess des Pakets eine Reihe von Aktionen hinzu.
Hinzufügen eines Stakeholders zu einem Paket

Fügt dem Paket einen Projektbeteiligten hinzu.
Löschen eines Prozessschritts und aller akteure

Löscht einen Prozessschritt und alle akteure.
Paket herunterladen

Wird zum Herunterladen aller Dokumente in einem bestimmten Paket als ZIP-Datei verwendet.
Paket nach ID abrufen

Ruft ein Paket anhand seiner ID ab.
Paket nach ID löschen

Löscht ein Paket anhand seiner ID.
Paketerinnerungen senden

Die Unternehmensrichtlinie kann erfordern, dass ein Dokument innerhalb eines bestimmten Zeitraums behandelt wird. Durch Auslösen des Anrufs "Erinnerungen senden" werden alle Personen nachschlagen, die nicht signiert wurden, und sie als Erinnerung eine zusätzliche Benachrichtigung senden.
Paketstatus abrufen

Ruft den aktuellen Status des Pakets ab.
Paketstatus aktualisieren

Aktualisiert den Status eines Pakets.
Projektbeteiligte nach ID löschen

Löscht einen Projektbeteiligten anhand seiner ID.
Signierer überspringen

Dieser Aufruf überspringt alle Signierer, die noch nicht abgeschlossen sind, und legt ihren Status auf "Übersprungen" fest, wodurch das vollständige Paket als "Abgeschlossen" gekennzeichnet wird.
Zurückgeben aller derzeit konfigurierten Signaturmethoden

Gibt alle Derzeit konfigurierten Signaturmethoden zurück.
Überschreiben von Prozessschritten eines Pakets

Überschreibt alle Akteure in einem Paket mithilfe eines 2D-Arrays, in dem jede Gruppe von Akteuren Aktionen sind, die parallel ausgeführt werden können.

Abrufen aller Aktionen eines Prozessschritts

Vorgangs-ID:
Process_GetStep

Ruft einen bestimmten Satz von Aktionen ab, die parallel vom Prozess abgeschlossen werden können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Der Index des Prozessschritts
 stepIndex True integer

Der Index des Prozessschritts

Gibt zurück

Name Pfad Typ Beschreibung
Gegenstände
 Items array of Response.Actor

Abrufen aller Aktionen im aktuellen Prozessschritt

Vorgangs-ID:
Process_GetCurrentStep

Ruft den aktuellen Satz von Aktionen ab, die parallel abgeschlossen werden können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Gibt zurück

Name Pfad Typ Beschreibung
Gegenstände
 Items array of Response.Actor

Abrufen aller Designs, die einem Paket zugewiesen werden können

Vorgangs-ID:
GetAllThemes

Ruft alle Designs ab, die einem Paket zugewiesen werden können. Möglich, um das Ergebnis durch Angabe einer Maximalen Menge und eines Fortsetzungstokens zu überblättern

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token zum Abrufen des nächsten Resultsets
 continuationToken string

Token zum Abrufen des nächsten Resultsets
Maximale Anzahl von Ergebnissen, die zurückgegeben werden sollen
 maxQuantity integer

Maximale Anzahl von Ergebnissen, die zurückgegeben werden sollen
Die Reihenfolge, in der die Ergebnisse sortiert werden sollen
 sortOrder string

Die Reihenfolge, in der die Ergebnisse sortiert werden sollen
angeben, nach welchem Feld sortiert werden soll
 sortField string

angeben, nach welchem Feld sortiert werden soll

Gibt zurück

Name Pfad Typ Beschreibung
ContinuationToken
 ContinuationToken string

Token zum Abrufen der nächsten Seite mit Ergebnissen
Gegenstände
 Items array of object

Die Liste mit den Designs
Code
 Items.Code string

Der Code des Designs
Name
 Items.Name string

Der Name des Designs
MaxQuantity
 MaxQuantity integer

Die maximale Anzahl von Ergebnissen, die pro Anforderung zurückgegeben werden
Total
 Total integer

Die Gesamtanzahl der Ergebnisse.

Abrufen aller Dokumentgruppen, denen Pakete zugewiesen werden können

Vorgangs-ID:
GetDocumentGroups

Ruft alle Dokumentgruppen ab, denen Pakete zugewiesen werden können

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Der Name der Dokumentgruppe (oder des Teils), nach dem gesucht werden soll
 name string

Der Name der Dokumentgruppe (oder des Teils), nach dem gesucht werden soll

Gibt zurück

Name Pfad Typ Beschreibung
DocumentGroups
 DocumentGroups array of object

Die Liste der Dokumentgruppen
Code
 DocumentGroups.Code string

Der Code der Dokumentgruppe
Name
 DocumentGroups.Name string

Der Name der Dokumentgruppe

Abrufen aller Pakete

Vorgangs-ID:
Packages_Get

Ruft alle Pakete ab, diese werden nach creationDate sortiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Die abzurufende Seitenzahl
 pageNumber integer

Die abzurufende Seitenzahl
Anzahl der Elemente pro Seite
 pageSize integer

Anzahl der Elemente pro Seite
Vor diesem Datum erstellte Rückgabepakete
 createdBefore date-time

Vor diesem Datum erstellte Rückgabepakete
Pakete zurückgeben, die nach diesem Datum erstellt wurden
 createdAfter date-time

Pakete zurückgeben, die nach diesem Datum erstellt wurden
Status der zu filternden Pakete
 status string

Status der zu filternden Pakete
Dokumentgruppencode zum Filtern von Paketen
 documentGroupCode string

Dokumentgruppencode zum Filtern von Paketen
E-Mail des Paketinitiators zum Filtern
 initiator email

E-Mail des Paketinitiators zum Filtern
Name des zu filternden Pakets
 packageName string

Name des zu filternden Pakets
Externer Verweis auf Filterpakete
 externalReference string

Externer Verweis auf Filterpakete
Angeben, wie das Ergebnis sortiert wird, Standard absteigend
 sort string

Angeben, wie das Ergebnis sortiert wird, Standard absteigend

Gibt zurück

Name Pfad Typ Beschreibung
PageNumber
 PageNumber integer

Aktuelle Seitenzahl
PageSize
 PageSize integer

Anzahl der Elemente pro Seite
TotalPages
 TotalPages integer

Gesamtzahl der Seiten
TotalItems
 TotalItems integer

Gesamtanzahl der Elemente
Gegenstände
 Items array of Response.Package.Get

Abrufen aller Projektbeteiligten eines Pakets

Vorgangs-ID:
Packages_GetStakeholders

Ruft die Projektbeteiligten des Pakets ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner für das Paket
 packageId True string

Eindeutiger Bezeichner für das Paket

Gibt zurück

response
array of Response.Stakeholder

Abrufen aller Prozessschritte

Vorgangs-ID:
Process_Get

Ruft alle Aktionen ab, die für das Paket ausgeführt werden müssen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Gibt zurück

Name Pfad Typ Beschreibung
array of array
items
 array of Response.Actor

Eine Reihe von Akteuren in einem Prozessschritt.

Abrufen aller Sprachen, die in der Anwendung aktiviert sind

Vorgangs-ID:
GetAllEnabledLanguages

Ruft alle Sprachen ab, die in der Anwendung aktiviert sind.

Gibt zurück

Name Pfad Typ Beschreibung
EnabledLanguages
 EnabledLanguages array of object

Die Liste der aktivierten Sprachen
Anzeigename
 EnabledLanguages.DisplayName string

Der Anzeigename der Sprache
NativeName
 EnabledLanguages.NativeName string

Der native Name der Sprache
IsoCultureCode
 EnabledLanguages.IsoCultureCode string

Der 2 Buchstaben ISO-Code (ISO 639-1) der Sprache

Abrufen des Ablaufdatums eines Pakets

Vorgangs-ID:
Packages_GetExpiryDate

Abrufen des Ablaufdatums eines Pakets

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Gibt zurück

Ein Datum-Uhrzeit-Wert im ISO 8601-Format

response
Common.DateTime

Aktualisieren des Ablaufdatums eines Pakets

Vorgangs-ID:
Packages_PutExpiryDate

Aktualisieren des Ablaufdatums eines Pakets

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
ExpiryTimestamp
 ExpiryTimestamp date-time

Ein Datum-Uhrzeit-Wert im ISO 8601-Format

Dokument aus Paket herunterladen

Vorgangs-ID:
Documents_DownloadDocumentFromPackage

Laden Sie ein signiertes Dokument aus einem Paket herunter. Jedes Dokument wird als PDF- oder XML-Datei heruntergeladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Eindeutiger Bezeichner des Dokuments, das im Paket enthalten ist
 documentId True string

Eindeutiger Bezeichner des Dokuments, das im Paket enthalten ist

Gibt zurück

response
binary

Erstellen eines neuen Pakets (Standard oder Sofort)

Vorgangs-ID:
Packages_CreatePackage

Erstellt ein neues Paket. Standardmäßig wird das Paket als Entwurf erstellt. Um ein Sofortpaket zu erstellen, das sofort zum Signieren bereit ist, legen Sie die status Eigenschaft auf Pending.

Anmerkung: Der POST /packages Endpunkt ermöglicht Ihnen das Erstellen von Standard- und Sofortpaketen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
 Name True string

Name des Pakets
Initiator
 Initiator True email

Eine E-Mail-Adresse
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Der Status
 Status string

Der Status des erstellten Pakets.

  • Dient "Draft" zum Erstellen eines Standardpakets, das vor dem Senden geändert werden kann.
  • Dient "Pending" zum Erstellen eines Sofortpakets, das sofort zum Signieren bereit ist.
DocumentGroupCode
 DocumentGroupCode string

Dokumentgruppencode für das Paket
Ablaufdatum
 ExpiryDate date-time

Ein Datum-Uhrzeit-Wert im ISO 8601-Format
Name
 Name True string

Name des Dokuments
IsOptional
 IsOptional boolean

Gibt an, ob das Dokument optional zum Signieren sein soll.
Language
 Language True string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
ProofCorrelationId
 ProofCorrelationId string

Ein global eindeutiger Bezeichner
Zieltyp
 TargetType string

Funktioniert nur, wenn der Server für Dokumentkonvertierungen konfiguriert ist.
TargetFormat
 TargetFormat string

Das Zielformat definiert, ob eine zusätzliche Konvertierung erfolgen muss.
PdfErrorHandling
 PdfErrorHandling string

So behandeln Sie PDFs, die kleinere Fehler enthalten
Inhaltstyp
 ContentType True string

MIME-Typ des Dokuments
Base64Data
 Base64Data True byte

Base64-codierter Dokumentinhalt
Typ
 Type True string

Der Typ des Elements
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Typ
 Type True string

Der Typ der Projektbeteiligten
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Language
 Language True string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
Vorname
 FirstName string

Vorname des Stakeholders
Nachname
 LastName True string

Nachname des Stakeholders
E-Mail-Adresse
 EmailAddress True email

Eine E-Mail-Adresse
BirthDate
 BirthDate date
Telefonnummer
 PhoneNumber string

Eine Telefonnummer
AdditionalProperties
 AdditionalProperties object

Die konfigurierbaren zusätzlichen Eigenschaften des Stakeholders
Typ
 Type True string

Aktionstyp, der für ein Paket ausgeführt werden muss
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Umleitungstyp
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL, an die der Benutzer nach dem Schließen der Sitzung gesendet wird
ProcessStep
 ProcessStep integer

Die Prozessschrittnummer
DocumentIndex
 DocumentIndex True integer

Index des Dokuments im Paket (ab 0) – nur im Endpunkt "Paket erstellen" verfügbar
Typ
 Type True string

Der Typ des Elements
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
SigningMethods
 SigningMethods True array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
ThemeCode
 ThemeCode string

Bezeichner des Designs für das Paket
CallBackUrl
 CallBackUrl url

URL für Rückrufe, nachdem Aktionen ausgeführt wurden
NotificationCallBackUrl
 NotificationCallBackUrl url

URL für Rückrufe, wenn ein Signierer eine neue Signatur-URL anfordert
DefaultRedirectUrl
 DefaultRedirectUrl url

Umleitungs-URL nach Abschluss der Aktion
F2fRedirectUrl
 F2fRedirectUrl url

Umleitungs-URL nach der Face-to-Face-Signatur
IsUnsignedContentDownloadable
 IsUnsignedContentDownloadable boolean

Gibt an, ob nicht signierte Inhalte heruntergeladen werden können.
IsReassignEnabled
 IsReassignEnabled boolean

Gibt an, ob die Neuzuweisung aktiviert ist.

Gibt zurück

Body
Response.Package.Get

Herunterladen des Überwachungspfads des Pakets

Vorgangs-ID:
Packages_DownloadAuditTrail

Laden Sie einen signierten Überwachungspfad über die Lebensdauer eines Pakets herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
ISO-Code in Sprache 2 Buchstaben (ISO 639-1)
 culture True string

ISO-Code in Sprache 2 Buchstaben (ISO 639-1)

Gibt zurück

response
binary

Hinzufügen eines Akteurs zu einem Prozessschritt

Vorgangs-ID:
Process_StepPost

Fügt einem Prozessschritt einen Akteur hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Der Index des Prozessschritts
 stepIndex True integer

Der Index des Prozessschritts
Typ
 Type True string

Aktionstyp, der für ein Paket ausgeführt werden muss
StakeholderId
 StakeholderId True string

Bezeichner eines Projektbeteiligten im Paket
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Id
 Id string

Bezeichner eines vorhandenen Elements. Bei Verwendung sollten alle anderen Felder leer sein.
Typ
 Type string

Der Typ des Elements
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
DokumentID
 DocumentId string

Bezeichner des Dokuments im Paket
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Language
 Language string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Gibt zurück

Body
Response.Actor

Hinzufügen eines Dokuments zu einem Paket

Vorgangs-ID:
Documents_AddToPackage

Fügt einem vorhandenen Paket ein Dokument hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Paketbezeichner
 packageId True string

Eindeutiger Paketbezeichner
Name
 Name True string

Name des Dokuments
IsOptional
 IsOptional boolean

Gibt an, ob das Dokument optional zum Signieren sein soll.
Language
 Language True string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
ProofCorrelationId
 ProofCorrelationId string

Ein global eindeutiger Bezeichner
Zieltyp
 TargetType string

Funktioniert nur, wenn der Server für Dokumentkonvertierungen konfiguriert ist.
TargetFormat
 TargetFormat string

Das Zielformat definiert, ob eine zusätzliche Konvertierung erfolgen muss.
PdfErrorHandling
 PdfErrorHandling string

So behandeln Sie PDFs, die kleinere Fehler enthalten
Inhaltstyp
 ContentType True string

MIME-Typ des Dokuments
Base64Data
 Base64Data True byte

Base64-codierter Dokumentinhalt
Typ
 Type True string

Der Typ des Elements
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Language
 Language string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Gibt zurück

Body
Response.Document

Hinzufügen eines Schritts im Prozess des Pakets

Vorgangs-ID:
Process_PostStep

Fügt dem Prozess des Pakets eine Reihe von Aktionen hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Typ
 Type True string

Aktionstyp, der für ein Paket ausgeführt werden muss
StakeholderId
 StakeholderId True string

Bezeichner eines Projektbeteiligten im Paket
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Id
 Id string

Bezeichner eines vorhandenen Elements. Bei Verwendung sollten alle anderen Felder leer sein.
Typ
 Type string

Der Typ des Elements
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
DokumentID
 DocumentId string

Bezeichner des Dokuments im Paket
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Language
 Language string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Gibt zurück

Eine Reihe von Akteuren in einem Prozessschritt.

response
array of Response.Actor

Hinzufügen eines Stakeholders zu einem Paket

Vorgangs-ID:
Packages_AddStakeholder

Fügt dem Paket einen Projektbeteiligten hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner für das Paket
 packageId True string

Eindeutiger Bezeichner für das Paket
Typ
 Type True string

Der Typ der Projektbeteiligten
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Language
 Language True string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
Vorname
 FirstName string

Vorname des Stakeholders
Nachname
 LastName True string

Nachname des Stakeholders
E-Mail-Adresse
 EmailAddress True email

Eine E-Mail-Adresse
BirthDate
 BirthDate date
Telefonnummer
 PhoneNumber string

Eine Telefonnummer
AdditionalProperties
 AdditionalProperties object

Die konfigurierbaren zusätzlichen Eigenschaften des Stakeholders
Typ
 Type True string

Aktionstyp, der für ein Paket ausgeführt werden muss
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Umleitungstyp
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL, an die der Benutzer nach dem Schließen der Sitzung gesendet wird
Id
 Id string

Bezeichner eines vorhandenen Elements. Bei Verwendung sollten alle anderen Felder leer sein.
Typ
 Type string

Der Typ des Elements
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
DokumentID
 DocumentId string

Bezeichner des Dokuments im Paket
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Language
 Language string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Gibt zurück

Body
Response.Stakeholder

Löschen eines Prozessschritts und aller akteure

Vorgangs-ID:
Process_DeleteStep

Löscht einen Prozessschritt und alle akteure.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Der Index des Prozessschritts
 stepIndex True integer

Der Index des Prozessschritts

Paket herunterladen

Vorgangs-ID:
Packages_DownloadPackage

Wird zum Herunterladen aller Dokumente in einem bestimmten Paket als ZIP-Datei verwendet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Gibt zurück

response
binary

Paket nach ID abrufen

Vorgangs-ID:
Packages_GetPackage

Ruft ein Paket anhand seiner ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Gibt zurück

Body
Response.Package.Get

Paket nach ID löschen

Vorgangs-ID:
Packages_DeleteById

Löscht ein Paket anhand seiner ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Paketerinnerungen senden

Vorgangs-ID:
Packages_SendReminders

Die Unternehmensrichtlinie kann erfordern, dass ein Dokument innerhalb eines bestimmten Zeitraums behandelt wird. Durch Auslösen des Anrufs "Erinnerungen senden" werden alle Personen nachschlagen, die nicht signiert wurden, und sie als Erinnerung eine zusätzliche Benachrichtigung senden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Paketstatus abrufen

Vorgangs-ID:
Packages_GetStatus

Ruft den aktuellen Status des Pakets ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner für das Paket
 packageId True string

Eindeutiger Bezeichner für das Paket

Gibt zurück

Body
Response.Package.Status

Paketstatus aktualisieren

Vorgangs-ID:
Packages_UpdateStatus

Aktualisiert den Status eines Pakets.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner für das Paket
 packageId True string

Eindeutiger Bezeichner für das Paket
body
 body True string

Projektbeteiligte nach ID löschen

Vorgangs-ID:
Stakeholder_DeleteById

Löscht einen Projektbeteiligten anhand seiner ID.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Eindeutiger Bezeichner des Stakeholders
 stakeholderId True string

Eindeutiger Bezeichner des Stakeholders

Signierer überspringen

Vorgangs-ID:
Packages_SkipSigners

Dieser Aufruf überspringt alle Signierer, die noch nicht abgeschlossen sind, und legt ihren Status auf "Übersprungen" fest, wodurch das vollständige Paket als "Abgeschlossen" gekennzeichnet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets

Zurückgeben aller derzeit konfigurierten Signaturmethoden

Vorgangs-ID:
GetAllSigningMethods

Gibt alle Derzeit konfigurierten Signaturmethoden zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
nur aktive/inaktive Signaturmethoden zurückgeben
 isActive boolean

nur aktive/inaktive Signaturmethoden zurückgeben

Gibt zurück

response
array of ConfiguredSigningMethod

Überschreiben von Prozessschritten eines Pakets

Vorgangs-ID:
Process_Put

Überschreibt alle Akteure in einem Paket mithilfe eines 2D-Arrays, in dem jede Gruppe von Akteuren Aktionen sind, die parallel ausgeführt werden können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Eindeutiger Bezeichner des Pakets
 packageId True string

Eindeutiger Bezeichner des Pakets
Typ
 Type True string

Aktionstyp, der für ein Paket ausgeführt werden muss
StakeholderId
 StakeholderId True string

Bezeichner eines Projektbeteiligten im Paket
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Id
 Id string

Bezeichner eines vorhandenen Elements. Bei Verwendung sollten alle anderen Felder leer sein.
Typ
 Type string

Der Typ des Elements
ExternalReference
 ExternalReference string

Externer Verweis für das Paket
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements
DokumentID
 DocumentId string

Bezeichner des Dokuments im Paket
SigningMethods
 SigningMethods array of string
Name
 Name string

Der Name des rechtlichen Hinweises, der dem Signaturfeld hinzugefügt werden soll.
Content
 Content string

Inhalt benutzerdefinierter rechtlicher Hinweise.
Language
 Language string

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Definitionen

ConfiguredSigningMethod

Eine konfigurierte Signaturmethode in eSignatures

Name Pfad Typ Beschreibung
IsActive
 IsActive boolean

Gibt an, ob signMethod zum Erstellen neuer Signaturfelder verwendet werden kann.
Name
 Name string

Der konfigurierte Name der Signaturmethode
DisplayNames
 DisplayNames object

Der Name pro Sprache, der einem Signierer angezeigt wird
DisplayNamesInitiator
 DisplayNamesInitiator object

Der Name pro Sprache, der dem Initiator beim Erstellen des Pakets angezeigt werden soll.
Beschreibungen
 Descriptions object

Beschreibung der Signaturmethode pro Sprache, um weitere Informationen zur Signaturmethode während der Paketerstellung bereitzustellen.
RequiredProperties
 RequiredProperties array of string

Die erforderlichen Eigenschaften für die mandatierte Signatur
KeyPairs
 KeyPairs array of KeyPair

verfügbare KeyPairs, die zum Signieren mit dieser Methode verwendet werden können

KeyPair

Darstellung eines Signaturschlüsselpaars

Name Pfad Typ Beschreibung
Name
 Name string

Name des Schlüsselpaars
DisplayNames
 DisplayNames object

Der Name pro Sprache, der einem Initiator angezeigt wird

Common.Guid

Ein global eindeutiger Bezeichner

Ein global eindeutiger Bezeichner

string

Common.EmailAddress

Eine E-Mail-Adresse

Eine E-Mail-Adresse

email

Common.Language

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)

string

Common.PhoneNumber

Eine Telefonnummer

Eine Telefonnummer

string

Common.ExternalReference

Externer Verweis für das Paket

Externer Verweis für das Paket

string

Common.AdditionalProperties

Die konfigurierbaren zusätzlichen Eigenschaften des Stakeholders

Name Pfad Typ Beschreibung
object

Die konfigurierbaren zusätzlichen Eigenschaften des Stakeholders

Common.DateTime

Ein Datum-Uhrzeit-Wert im ISO 8601-Format

Ein Datum-Uhrzeit-Wert im ISO 8601-Format

date-time

Package.Status

Der Status des Pakets

Der Status des Pakets

string

Package.Name

Name des Pakets

Name des Pakets

string

Document.Name

Name des Dokuments

Name des Dokuments

string

Document.Status

Der Status eines Dokuments

Der Status eines Dokuments

string

Document.DocumentOptions

Definiert optionale Dokumentparameter

Name Pfad Typ Beschreibung
Zieltyp
 TargetType string

Funktioniert nur, wenn der Server für Dokumentkonvertierungen konfiguriert ist.
TargetFormat
 PdfOptions.TargetFormat string

Das Zielformat definiert, ob eine zusätzliche Konvertierung erfolgen muss.
PdfErrorHandling
 PdfOptions.PdfErrorHandling string

So behandeln Sie PDFs, die kleinere Fehler enthalten

Stakeholder.FirstName

Vorname des Stakeholders

Vorname des Stakeholders

string

Stakeholder.LastName

Nachname des Stakeholders

Nachname des Stakeholders

string

Actor.Type

Aktionstyp, der für ein Paket ausgeführt werden muss

Aktionstyp, der für ein Paket ausgeführt werden muss

string

Actor.Status

Der Status eines Akteurs

Der Status eines Akteurs

string

Element.Type

Der Typ des Elements

Der Typ des Elements

string

Element.Status

Der Status eines Elements

Der Status eines Elements

string

Element.Location

Name Pfad Typ Beschreibung
Seite
 Page integer

Seitenzahl des Dokuments
Nach oben
 Top number

Obere Position in Pixeln
Links
 Left number

Linke Position in Pixeln

Element.Dimensions

Name Pfad Typ Beschreibung
Breite
 Width number

Breite des Elements
Höhe
 Height number

Höhe des Elements

Response.Package.Get

Name Pfad Typ Beschreibung
Id
 Id Common.Guid

Ein global eindeutiger Bezeichner
Name
 Name Package.Name

Name des Pakets
Initiator
 Initiator Common.EmailAddress

Eine E-Mail-Adresse
ExternalReference
 ExternalReference Common.ExternalReference

Externer Verweis für das Paket
CreationDate
 CreationDate Common.DateTime

Ein Datum-Uhrzeit-Wert im ISO 8601-Format
Der Status
 Status Package.Status

Der Status des Pakets
Ablaufdatum
 ExpiryDate Common.DateTime

Ein Datum-Uhrzeit-Wert im ISO 8601-Format
Dokumente
 Documents array of Response.Document
Projektbeteiligte
 Stakeholders array of Response.Stakeholder

Response.Document

Name Pfad Typ Beschreibung
Id
 Id Common.Guid

Ein global eindeutiger Bezeichner
Der Status
 Status Document.Status

Der Status eines Dokuments
DocumentOptions
 DocumentOptions Document.DocumentOptions

Definiert optionale Dokumentparameter
Name
 Name Document.Name

Name des Dokuments
Language
 Language Common.Language

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
ExternalReference
 ExternalReference Common.ExternalReference

Externer Verweis für das Paket
ProofCorrelationId
 ProofCorrelationId Common.Guid

Ein global eindeutiger Bezeichner

Response.Stakeholder

Name Pfad Typ Beschreibung
Typ
 Type string

Der Typ der Projektbeteiligten
ExternalReference
 ExternalReference Common.ExternalReference

Externer Verweis für das Paket
Id
 Id Common.Guid

Ein global eindeutiger Bezeichner
Language
 Language Common.Language

Iso-Code eines Landes mit 2 Buchstaben (ISO 639-1)
Vorname
 FirstName Stakeholder.FirstName

Vorname des Stakeholders
Nachname
 LastName Stakeholder.LastName

Nachname des Stakeholders
E-Mail-Adresse
 EmailAddress Common.EmailAddress

Eine E-Mail-Adresse
BirthDate
 BirthDate date
Telefonnummer
 PhoneNumber Common.PhoneNumber

Eine Telefonnummer
AdditionalProperties
 AdditionalProperties Common.AdditionalProperties

Die konfigurierbaren zusätzlichen Eigenschaften des Stakeholders
Actors
 Actors array of Response.Actor

Response.Actor

Name Pfad Typ Beschreibung
Typ
 Type Actor.Type

Aktionstyp, der für ein Paket ausgeführt werden muss
Id
 Id Common.Guid

Ein global eindeutiger Bezeichner
StakeholderId
 StakeholderId Common.Guid

Ein global eindeutiger Bezeichner
Der Status
 Status Actor.Status

Der Status eines Akteurs
SuppressNotifications
 SuppressNotifications boolean

Unterdrücken von Benachrichtigungen für den Akteur
RedirectUrl
 RedirectUrl url

Umleitungs-URL nach Abschluss der Aktion des Akteurs
Elemente
 Elements array of Response.Element

Response.Element

Name Pfad Typ Beschreibung
Typ
 Type Element.Type

Der Typ des Elements
Id
 Id Common.Guid

Ein global eindeutiger Bezeichner
ActorId
 ActorId Common.Guid

Ein global eindeutiger Bezeichner
DokumentID
 DocumentId integer

Bezeichner des Dokuments im Paket
Der Status
 Status Element.Status

Der Status eines Elements
ExternalReference
 ExternalReference Common.ExternalReference

Externer Verweis für das Paket
Standort
 Location Element.Location
Maße
 Dimensions Element.Dimensions
SigningMethods
 SigningMethods array of string
UsedSigningMethod
 UsedSigningMethod string

Die verwendete Signaturmethode

Response.Package.Status

Name Pfad Typ Beschreibung
Der Status
 Status Package.Status

Der Status des Pakets

binär

Dies ist der grundlegende Datentyp "binary".