Connective eSignatures
Connective eSignatures ist eine renommierte digitale Signaturlösung, die eine große Menge an Signaturmethoden und Compliance für die strengsten (inter)nationalen Vorschriften bietet. eSignatures ermöglicht es Ihnen, jeden papierbasierten Prozess in einen end-to-End Digital Flow 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. Treten Sie mehr als 500 zufriedenen Kunden bei.
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 | Connective Support |
| URL | https://connective.eu/contact-support/ |
| service@connective.eu |
| Connectormetadaten | |
|---|---|
| Herausgeber | Konnektiv |
| Webseite | https://www.connective.eu |
| Datenschutzrichtlinie | https://connective.eu/privacy-policy/ |
| Kategorien | IT-Vorgänge; Produktivität |
Connective, ein Spezialist für digitale Signaturen, Identitätsdienste und Smart Document-Generierung, hat den Connective eSignatures 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.
So beginnen Sie mit der Verwendung des Connectors
Um mit der Nutzung des Connectors zu beginnen, wenden Sie sich bei Connective an Ihren Beziehungsmanager, oder wechseln Sie zu unserer Kontaktseite auf unserer Website, um die Anmeldeinformationen zu erhalten.
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, auf unserer Dokumentationswebsite weitere Informationen zu erhalten oder sich über das Support-Kontaktformular oder Supportpostfach an das Supportteam zu wenden: service@connective.eu
Ein Glossar ist verfügbar, um die verschiedenen Begriffe zu erläutern, die in dieser Dokumentation verwendet werden.
Aktionen
Der Connective eSignatures-Connector basiert auf DER API v3 von eSignatures. Die eSignatures-API ist eine REST-API, mit der externe Anwendungen in dieses Dokument integriert und die in diesem Dokument aufgeführten Features zum Erstellen und Verwalten von Signaturflüssen verwendet werden können.
Die verfügbaren Aktionen können in verschiedene Gruppen gruppiert werden.
| Bürgerinitiative | Verfügbare Aktionen |
|---|---|
| Hochladen von Dokumenten | Paket erstellen |
| Dokument zum Paket hinzufügen | |
| Signierungsspeicherorte abrufen | |
| Festlegen von Prozessinformationen | |
| Paketstatus festlegen | |
| Sofortpaket erstellen | |
| Abrufen des Status eines Dokuments | Paketstatus abrufen |
| Paketliste abrufen | |
| Verschiedene Aktionen | Signierer überspringen |
| Paket herunterladen | |
| Paketablauferweiterung | |
| Paketerinnerung senden | |
| Paket löschen | |
| Abrufen des Überwachungsnachweises | Abrufen von Paketüberwachungsnachweisen |
| Dokumentüberwachungsnachweise abrufen | |
| Abrufen von Paketüberwachungsnachweisen mit Korrelations-ID | |
| Abrufen von Dokumentüberwachungsnachweisen mit Korrelations-ID | |
| Hinzufügen eines Nachweises aus einer externen Quelle |
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 |
|---|---|---|---|
| Url der Connective eSignatures-Umgebung | Schnur | URL zu Ihrer Connective eSignatures-Umgebung, z. B. esignatures.connective.eu | 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
| Ablaufzeitstempel |
Ein Paket hat möglicherweise den Status "Abgelaufen", wenn ein Paket einen Wert für den Parameter "ExpiryTimestamp" im Create Package-Aufruf übergeben hat. Ein solches Paket kann nicht mehr signiert werden. |
| Dokument aus externer Quelle hinzufügen |
Mit diesem Aufruf können API-Benutzer zusätzliche Nachweise aus einer externen Quelle zu einem Speicherort in einem Dokument hinzufügen. |
| Dokument aus Paket herunterladen |
Die angemeldeten Dokumente in einem Paket können mithilfe dieses Aufrufs von einem externen System einzeln heruntergeladen werden. Jedes Dokument wird als PDF oder als XML-Dateistream heruntergeladen, je nach Wert des DocumentType-Parameters. |
| Dokument zum Paket hinzufügen |
Mit diesem Aufruf wird einem vorhandenen Paket ein Dokument hinzugefügt. |
| Download des Paketkorrelationsüberwachungsnachweises |
Korrelations-IDs werden verwendet, um Pakete oder Dokumente über mehrere Durchläufe der eSignatures-Anwendung nachzuverfolgen. |
| Festlegen von Prozessinformationen |
Diese Webservice-Methode aktualisiert die am Prozess beteiligten Personen (Projektbeteiligte) und weist ihnen Schritte zu, die ausgeführt werden müssen. |
| Herunterladen des Dokumentkorrelationsüberwachungsnachweises |
Korrelations-IDs werden verwendet, um Pakete oder Dokumente über mehrere Durchläufe der eSignatures-Anwendung nachzuverfolgen. |
| Paket erstellen |
Dieser Aufruf erstellt ein leeres Paket, sodass Dokumente hinzugefügt werden können. |
| Paket herunterladen |
Das Paket mit den signierten Dokumenten kann mithilfe dieses Aufrufs von einem externen System heruntergeladen werden. |
| Paket löschen |
eSignatures löscht pakete nicht automatisch aus der Datenbank, sobald sie einen endgültigen Zustand erreicht haben. Sie werden unbegrenzt gespeichert. Um Pakete aus der Datenbank zu löschen, können Benutzer den Delete Package-Aufruf verwenden. |
| 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. |
| Paketliste |
Abrufen einer Liste von Paketen mit ihrem aktuellen Status |
| Paketstatus abrufen |
Ruft den aktuellen Status des Pakets und der zugehörigen Dokumente ab. |
| Paketstatus festlegen |
Mithilfe des Anrufs "Paketstatus festlegen" können Sie den Status eines Pakets ändern. |
| Paketüberwachungsnachweis |
Die XML-Überprüfungsnachweise eines Pakets können abgerufen werden, wenn das Paket vollständig signiert ist. Das gleiche gilt für ein Dokument: Es funktioniert nur, wenn das enthaltende Paket vollständig signiert ist. |
| Paketüberwachungsnachweis mit Dokument-ID |
Die XML-Überprüfungsnachweise eines Pakets können abgerufen werden, wenn das Paket vollständig signiert ist. Das gleiche gilt für ein Dokument: Es funktioniert nur, wenn das enthaltende Paket vollständig signiert ist. |
| Signierer überspringen |
Dieser Aufruf überspringt alle Signierer, die noch nicht signiert wurden, und legt ihren Status auf "Übersprungen" fest, was dazu führt, dass das vollständige Paket als "Fertig gestellt" gekennzeichnet wird. |
| Signierungsspeicherorte abrufen |
Dieser Aufruf bietet eine Übersicht über alle Signaturspeicherorte innerhalb der Dokumente innerhalb eines Pakets. |
| Sofortpaket erstellen |
Dieser Aufruf erstellt ein Paket mit einem einzelnen Dokument darin und bereitet es sofort auf die Signierung vor. |
Ablaufzeitstempel
Ein Paket hat möglicherweise den Status "Abgelaufen", wenn ein Paket einen Wert für den Parameter "ExpiryTimestamp" im Create Package-Aufruf übergeben hat. Ein solches Paket kann nicht mehr signiert werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
id | True | string |
Eindeutige ID des Pakets |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Dokument aus externer Quelle hinzufügen
Mit diesem Aufruf können API-Benutzer zusätzliche Nachweise aus einer externen Quelle zu einem Speicherort in einem Dokument hinzufügen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die eindeutige ID des Pakets
|
packageId | True | string |
Die eindeutige ID des Pakets |
|
Content
|
Content | string |
Der tatsächliche Inhalt des Nachweises. |
|
|
LocationId
|
LocationId | string |
Speicherort der Signatur, für die der Dokumentinhalt generiert wurde. |
|
|
Name
|
Name | string |
Name des Nachweises. |
|
|
Typ
|
Type | string |
Ein maschinenlesbarer "Typ"-Schlüssel. Kann frei gewählt werden. |
|
|
Description
|
Description | string |
Kurze, menschlich lesbare Beschreibung des Nachweises. |
|
|
IP-Adresse
|
IpAddress | string |
IP-Adresse des Endbenutzers der externen Quelle, für die der Nachweis hinzugefügt wurde. |
Dokument aus Paket herunterladen
Die angemeldeten Dokumente in einem Paket können mithilfe dieses Aufrufs von einem externen System einzeln heruntergeladen werden. Jedes Dokument wird als PDF oder als XML-Dateistream heruntergeladen, je nach Wert des DocumentType-Parameters.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID für das Signaturpaket
|
id | True | string |
Eindeutige ID für das Signaturpaket |
|
Eindeutige ID des Dokuments, das im Paket enthalten ist
|
documentId | True | string |
Eindeutige ID des Dokuments, das im Paket enthalten ist |
Gibt zurück
- response
- binary
Dokument zum Paket hinzufügen
Mit diesem Aufruf wird einem vorhandenen Paket ein Dokument hinzugefügt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der Paketbezeichner.
|
PackageId | True | string |
Eindeutige Paket-ID |
|
Dokument
|
Document | string |
Angefügtes Dokument im base64-codierten Format. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Sprache, die in Signaturtexten verwendet werden soll. |
|
|
Dokumentenname
|
DocumentName | string |
Der Name des Dokuments, das im eSignatures-Portal angezeigt werden soll. |
|
|
PageNumber
|
PageNumber | integer |
Nummer der Seite, auf der ein Signaturspeicherort hinzugefügt werden soll |
|
|
Breite
|
Width | string |
Breite |
|
|
Höhe
|
Height | string |
Höhe |
|
|
Links
|
Left | string |
Position von links auf der Seite |
|
|
Nach oben
|
Top | string |
Position von oben auf der Seite |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Eindeutiger Verweis auf ein Signaturfeld, eine Textmarkierung oder ein Textfeld. |
|
|
CorrelationId
|
CorrelationId | string |
ID, die angibt, welche Dokumente innerhalb dieses Pakets mit Dokumenten korreliert werden, die in der Vergangenheit in anderen Paketen angemeldet wurden. |
|
|
DocumentType
|
DocumentType | string |
Dokumenttyp, der signiert wird. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referenz, die von der aufrufenden Anwendung angegeben wird. |
|
|
ErrorCode
|
ErrorCode | string |
Fehlercode mit Variableninformationen. |
|
|
Nachricht
|
Message | string |
Detailtext der Fehlermeldung, nicht lokalisiert |
|
|
Vertretung
|
Representation | string |
Angefügtes Darstellungsdokument im Base64-Format. Dies muss PDF-Daten sein. |
|
|
RepresentationType
|
RepresentationType | string |
Typ des Darstellungsdokuments. |
|
|
Zieltyp
|
TargetType | string |
Der TargetType definiert, ob vor dem Signieren eine zusätzliche Konvertierung in PDF/A erfolgen muss. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
DokumentID
|
DocumentId | string |
Eindeutige ID für das Dokument |
|
CreationTimestamp
|
CreationTimestamp | string |
Datum und Uhrzeit der Erstellung des Flusses. Format: JJJJ-MM-DDThh:mm:ss+zz:zz |
|
Standorte
|
Locations | array of object |
Stellt einen möglichen Speicherort für eine Signatur dar. |
|
Id
|
Locations.Id | string |
Eindeutige ID für diesen Speicherort |
|
Etikett
|
Locations.Label | string |
Erkannte oder angegebene Bezeichnung |
|
PageNumber
|
Locations.PageNumber | integer |
Die Seite, auf der der Speicherort gefunden wurde. |
Download des Paketkorrelationsüberwachungsnachweises
Korrelations-IDs werden verwendet, um Pakete oder Dokumente über mehrere Durchläufe der eSignatures-Anwendung nachzuverfolgen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der Korrelationsbezeichner.
|
correlationId | True | string |
Der Korrelationsbezeichner. |
Gibt zurück
- Body
- Content
Festlegen von Prozessinformationen
Diese Webservice-Methode aktualisiert die am Prozess beteiligten Personen (Projektbeteiligte) und weist ihnen Schritte zu, die ausgeführt werden müssen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
id | True | string |
Eindeutige ID des Pakets |
|
Typ
|
Type | string |
Typ |
|
|
OrderIndex
|
OrderIndex | string |
Diese Zahl gibt an, in welcher Reihenfolge Akteure ihre Aktion ausführen müssen. |
|
|
LocationIds
|
LocationIds | array of string |
Die Speicherort-IDs, bei denen eine Signatur von dieser Person platziert werden muss. |
|
|
SigningType
|
SigningType | string |
Der in der Sitzung dieses Akteurs verwendete Signaturtyp. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Mindestens eine OIDs mit Verpflichtungstypen. Kann nur übergeben werden, wenn signaturrichtlinie verwendet wird. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Typ der Überprüfung, die während der eID einer anderen Smartcard oder der zugehörigen Signatursitzung ausgeführt werden soll. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Definiert, welche eID oder andere Smartcards während dieser Sitzung signieren dürfen. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Signaturrichtliniendetails für die Signatur. |
|
|
Telefonnummer
|
Phonenumber | string |
Telefonnummer, um eine SMS OTP zu empfangen. |
|
|
RedirectURL
|
RedirectURL | string |
Url, zu der der Endbenutzer nach der Signatur umgeleitet wird oder abgelehnt wird. Die Umleitung erfolgt unmittelbar nach dem Signieren oder Ablehnen. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures können E-Mails an die Akteure senden, deren Aktion erforderlich ist, z. B. signieren |
|
|
UserRoles
|
UserRoles | array of string |
Die Speicherort-IDs, bei denen eine Signatur von dieser Person platziert werden muss. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Die drei Werte verweisen auf die in die Anwendung integrierten drei rechtlichen Hinweise. Diese können im Konfigurationsindex geändert werden. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Benutzerdefinierter Rechtshinweistext für den Fall, dass keine der drei vordefinierten rechtlichen Hinweise gilt |
|
|
E-Mail-Adresse
|
EmailAddress | string |
E-Mail-Adresse |
|
|
Vorname
|
FirstName | string |
Vorname |
|
|
Language
|
Language | string |
Ui-Sprache dieses Stakeholders. Derzeit unterstützt: en, nl, de, fr, es. |
|
|
Nachname
|
LastName | string |
Nachname |
|
|
BirthDate
|
BirthDate | string |
Geburtsdatum im Format: JJJJ-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Referenz, die von der aufrufenden Anwendung angegeben wird. Dieser Parameter wird nicht vom eSignatures-Portal verwendet. |
Herunterladen des Dokumentkorrelationsüberwachungsnachweises
Korrelations-IDs werden verwendet, um Pakete oder Dokumente über mehrere Durchläufe der eSignatures-Anwendung nachzuverfolgen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der Korrelationsbezeichner.
|
correlationId | True | string |
Der Korrelationsbezeichner. |
Gibt zurück
- Body
- Content
Paket erstellen
Dieser Aufruf erstellt ein leeres Paket, sodass Dokumente hinzugefügt werden können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Initiator
|
Initiator | string |
E-Mail-Adresse eines registrierten Benutzers. |
|
|
PackageName
|
PackageName | string |
Der Paketname, der im eSignatures-Portal und beim Herunterladen als ZIP-Datei angezeigt wird. |
|
|
CallBackUrl
|
CallBackUrl | string |
REST-API-URL, die jedes Mal aufgerufen wird, wenn eine Aktion für dieses Paket abgeschlossen wurde. |
|
|
CorrelationId
|
CorrelationId | string |
ID, die angibt, welche Pakete korreliert sind. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Der "Code", der eine Dokumentgruppe identifiziert, in der das Paket angezeigt werden soll. |
|
|
ThemeCode
|
ThemeCode | string |
Design, das auf das Paket angewendet werden muss |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Dieser Parameter bestimmt, ob Pakete vor dem Signieren aus dem WYSIWYS heruntergeladen werden können. |
|
|
Neu zuweisenEnabled
|
ReassignEnabled | boolean |
Dieser Parameter bestimmt, ob Pakete vom WYSIWYS zu einem anderen Genehmigenden/Signierer neu zugewiesen werden können. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Dieser Parameter bestimmt, wie viele Tage die Aktions-URLs ablaufen müssen, wenn sie nicht verwendet werden. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Das Datum und die Uhrzeit, zu dem dieses Paket abläuft und nicht mehr signiert werden kann. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referenz, die von der aufrufenden Anwendung angegeben wird. Dieser Parameter wird nicht vom eSignatures-Portal verwendet. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Dieses Feld ist für die zukünftige Verwendung reserviert. Sie kann für kundenspezifische Erweiterungen verwendet werden, um sie in Drittanbieterdienste zu integrieren, z. B. die Debitkartensignierung. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
DIE URL, zu der der Endbenutzer umgeleitet wird, nachdem alle Felder mit "Face to Face"-Signatur signiert wurden oder wenn alle Felder abgelehnt wurden. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST-API-URL, die aufgerufen wird, wenn ein Endbenutzer eine Benachrichtigung anfordert. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Eindeutiger Bezeichner des Pakets. |
|
CreationTimestamp
|
CreationTimestamp | string |
Datum und Uhrzeit der Erstellung des Pakets entsprechend dem Server. |
Paket herunterladen
Das Paket mit den signierten Dokumenten kann mithilfe dieses Aufrufs von einem externen System heruntergeladen werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
id | True | string |
Eindeutige ID des Pakets |
Gibt zurück
- response
- binary
Paket löschen
eSignatures löscht pakete nicht automatisch aus der Datenbank, sobald sie einen endgültigen Zustand erreicht haben. Sie werden unbegrenzt gespeichert. Um Pakete aus der Datenbank zu löschen, können Benutzer den Delete Package-Aufruf verwenden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
id | True | string |
Eindeutige ID des Pakets |
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.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
PackageId | True | string |
Eindeutige ID des Pakets |
Paketliste
Abrufen einer Liste von Paketen mit ihrem aktuellen Status
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Das Fortsetzungstoken/die GUID, um zu wissen, welche Seite zurückgegeben werden soll.
|
ContinuationToken | string |
Das Fortsetzungstoken/die GUID, um zu wissen, welche Seite zurückgegeben werden soll. MUSS LEER oder das token sein, das von einem PREVIOUS-Aufruf zurückgegeben wird. |
|
|
Ruft die maximale Menge ab oder legt sie fest.
|
MaxQuantity | integer |
Ruft die maximale Menge ab oder legt sie fest. |
|
|
Ruft ab oder legt das Sortierfeld fest.
|
SortField | string |
Ruft ab oder legt das Sortierfeld fest. |
|
|
Ruft ab oder legt das Sortierfeld fest.
|
SortOrder | string |
Ruft ab oder legt das Sortierfeld fest. |
|
|
Dient zum Abrufen oder Festlegen des erstellten Vordatums.
|
CreatedBeforeDate | string |
Dient zum Abrufen oder Festlegen des erstellten Vordatums. |
|
|
Ruft den Status ab oder legt den Status fest.
|
Status | string |
Ruft den Status ab oder legt den Status fest. |
|
|
Dient zum Abrufen oder Festlegen des erstellten Nachdatums.
|
createdAfterDate | string |
Dient zum Abrufen oder Festlegen des erstellten Nachdatums. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ContinuationToken
|
ContinuationToken | string |
ContinuationToken |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Gegenstände
|
Items | array of Package |
Paketstatus abrufen
Ruft den aktuellen Status des Pakets und der zugehörigen Dokumente ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID für das Signaturpaket
|
Id | True | string |
Eindeutige ID für das Signaturpaket |
Gibt zurück
Beschreibung für das Paket, das dem eSignatures Portal-Benutzer als Dateinamen angezeigt wird.
- Body
- PackageStatus
Paketstatus festlegen
Mithilfe des Anrufs "Paketstatus festlegen" können Sie den Status eines Pakets ändern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID für das Signaturpaket
|
Id | True | string |
Eindeutige ID für das Signaturpaket |
|
Der Status
|
Status | string |
Ausstehend/ widerrufen |
Gibt zurück
Beschreibung für das Paket, das dem eSignatures Portal-Benutzer als Dateinamen angezeigt wird.
- Body
- PackageStatus
Paketüberwachungsnachweis
Die XML-Überprüfungsnachweise eines Pakets können abgerufen werden, wenn das Paket vollständig signiert ist. Das gleiche gilt für ein Dokument: Es funktioniert nur, wenn das enthaltende Paket vollständig signiert ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
packageId | True | string |
Eindeutige ID des Pakets |
Gibt zurück
- Body
- Content
Paketüberwachungsnachweis mit Dokument-ID
Die XML-Überprüfungsnachweise eines Pakets können abgerufen werden, wenn das Paket vollständig signiert ist. Das gleiche gilt für ein Dokument: Es funktioniert nur, wenn das enthaltende Paket vollständig signiert ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
packageId | True | string |
Eindeutige ID des Pakets |
|
Eindeutige ID des Dokuments
|
documentId | True | string |
Eindeutige ID des Dokuments |
Gibt zurück
- Body
- Content
Signierer überspringen
Dieser Aufruf überspringt alle Signierer, die noch nicht signiert wurden, und legt ihren Status auf "Übersprungen" fest, was dazu führt, dass das vollständige Paket als "Fertig gestellt" gekennzeichnet wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eindeutige ID des Pakets
|
PackageId | True | string |
Eindeutige ID des Pakets |
Signierungsspeicherorte abrufen
Dieser Aufruf bietet eine Übersicht über alle Signaturspeicherorte innerhalb der Dokumente innerhalb eines Pakets.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Signaturfelds
|
Id | True | string |
ID des Signaturfelds |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumente
|
Documents | array of object | |
|
DokumentID
|
Documents.DocumentId | string |
Eindeutige ID für das Dokument |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Externe Referenz zur Identifizierung. Stellen Sie sicher, dass Sie einen eindeutigen Wert verwenden. |
|
Standorte
|
Documents.Locations | array of object |
Stellt einen möglichen Speicherort für eine Signatur dar. |
|
Id
|
Documents.Locations.Id | string |
Eindeutige ID für diesen Speicherort. |
|
Etikett
|
Documents.Locations.Label | string |
Wert, den Sie als Anforderungsparameter eingegeben haben. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
Die Nummer der Seite, auf der die Signatur gefunden werden kann. |
Sofortpaket erstellen
Dieser Aufruf erstellt ein Paket mit einem einzelnen Dokument darin und bereitet es sofort auf die Signierung vor.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument
|
Document | byte |
Angefügtes Dokument im base64-codierten Format. Erforderlich, es sei denn, es wird ein mehrteiliges Format verwendet. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Sprache, die in Signaturtexten verwendet werden soll. Derzeit unterstützt: en, nl, de, fr, es. |
|
|
Dokumentenname
|
DocumentName | string |
Der Name des Dokuments und des Pakets, das im eSignatures-Portal angezeigt werden soll. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
E-Mail-Adresse eines registrierten Benutzers |
|
|
Typ
|
Type | string |
Signierer/Empfänger |
|
|
OrderIndex
|
OrderIndex | integer |
Diese Zahl gibt an, in welcher Reihenfolge Akteure ihre Aktion ausführen müssen. |
|
|
PageNumber
|
PageNumber | integer |
Nummer der Seite, auf der ein Signaturspeicherort hinzugefügt werden soll |
|
|
Breite
|
Width | string |
Breite |
|
|
Höhe
|
Height | string |
Höhe |
|
|
Links
|
Left | string |
Position von links auf der Seite |
|
|
Nach oben
|
Top | string |
Position von oben auf der Seite |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Eindeutiger Verweis auf ein Signaturfeld, eine Textmarkierung oder ein Textfeld. |
|
|
SigningType
|
SigningType | string |
Der in der Sitzung dieses Akteurs verwendete Signaturtyp. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Mindestens eine OIDs mit Verpflichtungstypen. Kann nur übergeben werden, wenn signaturrichtlinie verwendet wird. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Typ der Überprüfung, die während der eID einer anderen Smartcard oder der zugehörigen Signatursitzung ausgeführt werden soll. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Definiert, welche eID oder andere Smartcards während dieser Sitzung signieren dürfen. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Signaturrichtliniendetails für die Signatur. |
|
|
Telefonnummer
|
Phonenumber | string |
Telefonnummer, um eine SMS OTP zu empfangen. |
|
|
RedirectUrl
|
RedirectUrl | string |
Url, zu der der Endbenutzer nach der Signatur umgeleitet wird. |
|
|
SendNotifications
|
SendNotifications | boolean |
ESignaturen können E-Mails an alle Personen senden, die sich anmelden dürfen. |
|
|
UserRoles
|
UserRoles | array of string |
Rolle oder Funktion des Signierers. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Rechtlicher Hinweis |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Benutzerdefinierter Rechtshinweistext für den Fall, dass keine der drei vordefinierten rechtlichen Hinweise gilt. |
|
|
E-Mail-Adresse
|
EmailAddress | string |
E-Mail-Adresse |
|
|
Vorname
|
FirstName | string |
Vorname |
|
|
Nachname
|
LastName | string |
Nachname |
|
|
BirthDate
|
BirthDate | string |
BirthDate |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
REST-API-URL, die jedes Mal aufgerufen wird, wenn eine Aktion für dieses Paket abgeschlossen wurde |
|
|
CorrelationId
|
CorrelationId | string |
ID, die angibt, welche Pakete oder Dokumente korreliert sind |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Der "Code", der eine Dokumentgruppe identifiziert, in der das Dokument angezeigt werden soll |
|
|
ThemeCode
|
ThemeCode | string |
Design, das auf das Paket angewendet werden muss |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Dieser Parameter bestimmt, ob Pakete vor dem Signieren aus dem WYSIWYS heruntergeladen werden können. |
|
|
Neu zuweisenEnabled
|
ReassignEnabled | boolean |
Dieser Parameter bestimmt, ob Pakete vom WYSIWYS zu einem anderen Genehmigenden/Signierer neu zugewiesen werden können. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Dieser Parameter bestimmt, wie viele Tage die Aktions-URLs ablaufen müssen, wenn sie nicht verwendet werden. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Referenz, die von der aufrufenden Anwendung angegeben wird. Dieser Parameter wird nicht vom eSignatures Portal verwendet. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Verweis auf die aufrufende Anwendung, dieser Parameter wird nicht vom eSignatures Portal verwendet. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Verweis auf die aufrufende Anwendung, dieser Parameter wird nicht vom eSignatures Portal verwendet. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Die URL, zu der der Endbenutzer umgeleitet wird, nachdem alle Felder mit "Face to Face"-Signatur signiert wurden oder wenn alle Felder abgelehnt wurden. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST-API-URL, die aufgerufen wird, wenn ein Endbenutzer eine Benachrichtigung anfordert. Wenn keine URL angegeben wird, wird kein Rückruf ausgeführt. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
So behandeln Sie PDFs, die kleinere Fehler enthalten |
|
|
Vertretung
|
Representation | string |
Angefügtes Darstellungsdokument im Base64-Format |
|
|
RepresentationType
|
RepresentationType | string |
Der Typ des Darstellungsdokuments muss vorhanden sein, wenn die Darstellung ausgefüllt ist. Es wird nur "application/pdf" unterstützt. |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
Die im Portal konfigurierte Vorlage stellt alle erforderlichen Informationen bereit. |
|
|
Zieltyp
|
TargetType | string |
Der TargetType definiert, ob vor dem Signieren eine zusätzliche Konvertierung in PDF/A erfolgen muss. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Eindeutiger Bezeichner des Pakets. |
|
CreationTimestamp
|
CreationTimestamp | string |
Datum und Uhrzeit der Erstellung des Pakets entsprechend dem Server. |
Definitionen
Package
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Details zu den einzelnen Dokumenten im Paket
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
DokumentID
|
DocumentId | string |
Eindeutige ID des Dokuments |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Gibt den externen Verweis dieses Dokuments zurück, während es über das Add-Dokument übergeben wurde, um den Paketaufruf zu verpacken. |
|
Dokumentenname
|
DocumentName | string |
Name des Dokuments |
|
DocumentType
|
DocumentType | string |
Typ des Dokuments innerhalb des Pakets. |
PackageStatus
Beschreibung für das Paket, das dem eSignatures Portal-Benutzer als Dateinamen angezeigt wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Beschreibung für das Paket, das dem eSignatures Portal-Benutzer als Dateinamen angezeigt wird. |
|
CreationTimestamp
|
CreationTimestamp | string |
Datum und Uhrzeit der Erstellung des Pakets entsprechend dem Server. |
|
Initiator
|
Initiator | string |
Initiatorfeld des Pakets, während es zur Erstellungszeit übergeben wurde. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
UTC-formatierte Uhrzeit, zu der das Dokument abläuft. Kann null sein. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Gibt die externe Referenz-ID des Pakets zurück, während es zur Erstellungszeit übergeben wurde. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Link zum Paket, mit dem alle Signiersitzungen gleichzeitig ausgewählt werden können. |
|
PackageStatus
|
PackageStatus | string |
Status des Pakets als Ganzes: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Details zu den einzelnen Dokumenten im Paket. |
|
Projektbeteiligte
|
Stakeholders | array of object |
Details zu den einzelnen Personen, die mit dem Paket interagieren. |
|
Typ
|
Stakeholders.Type | string |
Typ der Projektbeteiligten: Person, PersonGroup oder ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Name der Personengruppe. Wird nur zurückgegeben, wenn "Type" in der Anforderung auf "PersonGroup" festgelegt wurde. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Code der Kontaktgruppe. Wird nur zurückgegeben, wenn "Type" in der Anforderung auf "ContactGroup" festgelegt wurde. |
|
E-Mail-Adresse
|
Stakeholders.EmailAddress | string |
E-Mail-Adresse des Signierers. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Externer Verweis, der diese Person im externen System identifiziert. |
|
StakeholderId
|
Stakeholders.StakeholderId | string |
Eindeutige ID. |
|
Actors
|
Stakeholders.Actors | array of object |
Details zu allen auszuführenden Schritten. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
Eindeutige ID für diese Kombination aus Aktion, Projektbeteiligten und Dokument. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL, die diese Person für die Interaktion mit dem Paket öffnen kann. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Array von URLs, die die verschiedenen Personen der PersonGroup oder ContactGroup öffnen können, um mit dem Paket zu interagieren. |
|
E-Mail-Adresse
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
E-Mail-Adresse der Person. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
URL, die diese Person für die Interaktion mit dem Paket öffnen kann. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Entwurf (Paket hat Statusentwurf) |
|
Typ
|
Stakeholders.Actors.Type | string |
Signierer/Empfänger |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Der Name des Endbenutzers, der die Aktion abgeschlossen hat. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Zeitstempel des Moments, zu dem diese Aktion abgeschlossen wurde. |
|
Ursache
|
Stakeholders.Actors.Reason | string |
Gibt den von der Person eingegebenen Text zurück, der den Status eines Pakets in einen endgültigen Zustand geändert hat (z. B. eine Ablehnung). |
|
Standorte
|
Stakeholders.Actors.Locations | array of object |
Stellt einen möglichen Speicherort für eine Signatur dar. |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
Eindeutige ID für diesen Speicherort |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Gibt den Signaturtyp zurück, der zum Signieren des Dokuments verwendet wurde. |
Content
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Uploads
|
uploads | array of object | |
|
hochladen
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
Ende
|
uploads.upload.end | date-time | |
|
Signaturen
|
uploads.upload.signatures | array of object | |
|
Beweise
|
uploads.upload.signatures.proofs | array of object | |
|
name
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
Indizes
|
uploads.indexes | array of object | |
|
identifier
|
uploads.indexes.index.identifier | boolean | |
|
Inhalt
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
Paket-ID
|
uploads.packageId | string |
binär
Dies ist der grundlegende Datentyp "binary".