Penneo Sign Sandbox (Vorschau)

Penneo wandelt komplexe Prozesse in eine nahtlose, menschlich ausgerichtete Erfahrung um. Durch die Integration digitaler Signaturen in automatisierte Workflows kann unsere Plattform mühelos überprüfen, wer welche Daten und wann genehmigt hat, wodurch verwaltungstechnische Belastungen reduziert und gleichzeitig die volle Compliance und Sicherheit sichergestellt werden. Mit diesem Connector können Sie Dokumente zum Signieren senden.

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

Service Class Regions
Copilot Studio Premium Alle Power Automate Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Standard 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:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Penneo-Support
URL https://www.support.penneo.com
Connectormetadaten
Herausgeber Penneo-Integration
source Swagger
Website https://penneo.com
Datenschutzrichtlinie https://penneo.com/privacy-policy
Kategorien Produktivität

Penneo Sign Sandbox

Penneo wandelt komplexe Prozesse in eine nahtlose, menschlich ausgerichtete Erfahrung um. Durch die Integration digitaler Signaturen in automatisierte Workflows kann unsere Plattform mühelos überprüfen, wer welche Daten und wann genehmigt hat, wodurch verwaltungstechnische Belastungen reduziert und gleichzeitig die volle Compliance und Sicherheit sichergestellt werden.

Voraussetzungen

Um diesen Connector zu verwenden, benötigen Sie ein aktives Penneo Sandbox-Konto.

Unterstützte Aktionen

Erstellen einer neuen Falldatei

Erstellt eine neue Falldatei in Penneo mit den angegebenen Dokumenten und Signierern. Die Falldatei wird in Penneo erstellt, und eine UUID und ein PayloadHash werden zurückgegeben, die verwendet werden können, um den Erstellungsstatus über den Warteschlangenstatusendpunkt zu überprüfen.

Auftragsstatus überprüfen

Ruft den aktuellen Status einer Falldatei ab, indem der Auftrag UUID und payloadHash bereitgestellt werden. Dieser Endpunkt wird verwendet, um den Auftragsabschlussstatus nach der Übermittlung einer Anforderung zur Erstellung einer Falldatei abzufragen. Der Endpunkt ist auf 20 Anforderungen pro Minute pro uuid-payloadHash-Kombination beschränkt.

Abrufen von Falldateidetails

Ruft die Details einer bestimmten Falldatei von Penneo basierend auf der Falldatei-ID ab. Dazu gehören die Signierer, Dokumente und der aktuelle Status.

Dokument herunterladen

Lädt den Inhalt eines Dokuments aus dem Penneo als base64-codierte Zeichenfolge herunter. Standardmäßig wird die signierte Version des Dokuments zurückgegeben. verwenden Sie den signed Parameter, um stattdessen die nicht signierte Version abzurufen. Wenn Ihre Falldatei weitere Dokumente enthält, stellen Sie sicher, dass sie über jedes Dokument durchlaufen werden.

Abrufen von Anmeldeinformationen

Der Connector wurde für die Verwendung von OAuth mit Autorisierungscodeerteilung konfiguriert. Benutzer müssen sich mit ihren regulären Anmeldeinformationen anmelden, wenn sie den Connector verwenden.

Getting Started

Erstellen einer Falldatei

  1. Bereiten Sie Ihre Dokumente vor:

    • Konvertieren von PDF-Dokumenten in base64-Codierung
    • Sicherstellen, dass Dokumente gültige PDF-Dateien sind
  2. Signierer konfigurieren:

    • Geben Sie den Namen und die E-Mail-Adresse des Signierers an (erforderlich)
    • Optional Rolle, Sprache, Signierreihenfolge usw. bereitstellen.
    • Konfigurieren von E-Mail-Benachrichtigungen und benutzerdefinierten E-Mail-Vorlagen bei Bedarf
  3. Erstellen Sie die Falldatei:

    • Verwenden der Aktion "Neue Falldatei erstellen"
    • Geben Sie die Details der Falldatei ein:
      • Title
      • Dokumente (base64-codierte PDF-Dateien)
      • Signierer (mit Namen und optionalen Details)
      • Optionale Einstellungen (Ablauf, Sprache, Sichtbarkeit usw.)
  4. Status der CaseFile-Erstellung überprüfen:

    • Nach dem Erstellen einer Falldatei erhalten Sie eine UUID und payloadHash
    • Verwenden der Aktion "Auftragsstatus überprüfen" zum Abrufen des Auftragsabschlusses
    • Beachten Sie die Rategrenze von 20 Anforderungen pro Minute pro uuid-Hash-Kombination

Hinweis: Sie können überprüfen, was jedes Feld bewirkt https://penneo.readme.io/reference/createcasefile.

Abrufen einer Falldatei und der zugehörigen Dokumente

  1. Abrufen der Falldateidetails:

    • Verwenden Sie die Aktion "Falldateidetails abrufen" mit der Falldatei-ID.
    • Die Antwort enthält den Status der Falldatei, Die Signierer und die Liste der Dokumente (mit ihren Dokument-IDs)
  2. Herunterladen eines Dokuments:

    • Verwenden Sie die Aktion "Dokument herunterladen" mit der Dokument-ID, die aus den Details der Falldatei abgerufen wurde.
    • Die Antwort enthält den Dokumentinhalt als base64-codierte Zeichenfolge, die Sie decodieren können, um die PDF-Datei abzurufen.

Bekannte Probleme und Einschränkungen

  1. RateLimiting: Der Endpunkt "Auftragsstatus überprüfen" ist auf 20 Anforderungen pro Minute pro uuid-Hash-Kombination beschränkt. Implementieren Sie geeignete Wiederholungslogik mit exponentiellem Backoff.

  2. Asynchrone Verarbeitung: Die Erstellung von Falldateien ist asynchron. Sie müssen den Auftragsstatusendpunkt verwenden, um den Abschluss zu überprüfen, anstatt sofortige Ergebnisse zu erwarten.

  3. Base64-Codierung: Dokumente müssen base64-codiert sein. Stellen Sie sicher, dass die richtige Codierung erforderlich ist, um Anforderungsfehler zu vermeiden(Sie können base64-Zeichenfolgenfunktion in der Power Platform verwenden, um die binären PDF-Dateien zu codieren).

  4. Sandkastenumgebung: Dieser Connector ist für die Penneo-Sandkastenumgebung (sandbox.penneo.com) konfiguriert.

  5. Dokumentgröße: Große Dokumente können länger dauern, bis sie verarbeitet werden. Berücksichtigen Sie Grenzwerte für die Dokumentgröße bei der Codierung auf Base64.

Bereitstellungsanweisungen

Führen Sie die folgenden Befehle aus, und folgen Sie den Eingabeaufforderungen:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx

Drosselungsgrenzwerte

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

Aktionen

Abrufen von Falldateidetails

Ruft die Details einer bestimmten Falldatei von Penneo ab, einschließlich der Signierer, Dokumente und des aktuellen Status. Status der Falldatei: 0=neu, 1=ausstehend, 2=abgelehnt, 3=gelöscht, 4=signiert, 5=abgeschlossen, 6=fehlgeschlagen, 7=abgelaufen, 8=anonymisiert. Verwenden Sie status 5 (abgeschlossen) als Trigger zum Herunterladen der signierten Dokumente.

Auftragsstatus überprüfen

Ruft den aktuellen Status eines asynchronen Auftrags ab, indem der Auftrag UUID und payloadHash bereitgestellt werden. Dieser Endpunkt wird verwendet, um den Auftragsabschlussstatus nach der Übermittlung einer Anforderung zur Erstellung einer Falldatei abzufragen. Die Aktion ist auf 20 Anforderungen pro Minute pro uuid-payloadHash-Kombination beschränkt.

Dokument herunterladen

Lädt den Inhalt eines Dokuments aus Penneo als base64-codierte Zeichenfolge herunter. Standardmäßig wird die signierte Version des Dokuments zurückgegeben.

Erstellen einer neuen Falldatei

Erstellt eine neue Falldatei in Penneo mit den angegebenen Dokumenten und Signierern. Die Falldatei wird asynchron erstellt, und eine Auftrags-UUID und ein PayloadHash-Element werden zurückgegeben, das verwendet werden kann, um den Erstellungsstatus über die Aktion "Auftragsstatus überprüfen" zu überprüfen. Sie können Signierer, Dokumente, Signierreihenfolge, E-Mail-Benachrichtigungen, Zugriffssteuerung und verschiedene andere Falldateieinstellungen konfigurieren.

Abrufen von Falldateidetails

Ruft die Details einer bestimmten Falldatei von Penneo ab, einschließlich der Signierer, Dokumente und des aktuellen Status. Status der Falldatei: 0=neu, 1=ausstehend, 2=abgelehnt, 3=gelöscht, 4=signiert, 5=abgeschlossen, 6=fehlgeschlagen, 7=abgelaufen, 8=anonymisiert. Verwenden Sie status 5 (abgeschlossen) als Trigger zum Herunterladen der signierten Dokumente.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Falldatei-ID
caseFileId True integer

Die ID der abzurufenden Falldatei. Rufen Sie die Falldatei-ID mit der Aktion "Auftragsstatus überprüfen" ab.

Gibt zurück

Details zu einer Falldatei, die aus dem sicheren Archiv von Penneo abgerufen wurde.

Auftragsstatus überprüfen

Ruft den aktuellen Status eines asynchronen Auftrags ab, indem der Auftrag UUID und payloadHash bereitgestellt werden. Dieser Endpunkt wird verwendet, um den Auftragsabschlussstatus nach der Übermittlung einer Anforderung zur Erstellung einer Falldatei abzufragen. Die Aktion ist auf 20 Anforderungen pro Minute pro uuid-payloadHash-Kombination beschränkt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
uuid
uuid True uuid

Die UUID des zu überprüfenden Auftrags. Dies wird zurückgegeben, wenn der Auftrag erstellt wird.

payloadHash
payloadHash True string

Der SHA-256-Hash der Nutzlast. Dies wird zurückgegeben, wenn der Auftrag erstellt wird und verwendet wird, um die Echtheit der Anforderung zu überprüfen.

Gibt zurück

Body
QueueJob

Dokument herunterladen

Lädt den Inhalt eines Dokuments aus Penneo als base64-codierte Zeichenfolge herunter. Standardmäßig wird die signierte Version des Dokuments zurückgegeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
documentId True integer

Die ID des herunterzuladenden Dokuments. Rufen Sie die documentIds mit der Aktion "Falldateidetails abrufen" ab.

Signiert
signed boolean

Rufen Sie das signierte oder nicht signierte Dokument ab. Standardmäßig wird das signierte Dokument zurückgegeben, wenn das Dokument signiert wurde.

Gibt zurück

Erstellen einer neuen Falldatei

Erstellt eine neue Falldatei in Penneo mit den angegebenen Dokumenten und Signierern. Die Falldatei wird asynchron erstellt, und eine Auftrags-UUID und ein PayloadHash-Element werden zurückgegeben, das verwendet werden kann, um den Erstellungsstatus über die Aktion "Auftragsstatus überprüfen" zu überprüfen. Sie können Signierer, Dokumente, Signierreihenfolge, E-Mail-Benachrichtigungen, Zugriffssteuerung und verschiedene andere Falldateieinstellungen konfigurieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
title
title True string

Der Titel der Falldatei.

sendAt
sendAt integer

Zeitstempel, wenn falldatei gesendet werden soll. Null = sofort

name
name True string

Name des Signierers

Rolle
role string

Rolle für den Signierer. Zulässig: Buchstaben, Zahlen, Leerzeichen, Komma, Unterstrich, Bindestrich. Muss mit einem Buchstaben/einer Zahl beginnen und darf nicht mit einem Leerzeichen enden.

email
email email

E-Mail-Adresse des Signierers. Penneo wird alle Kommunikationen verarbeiten

failUrl
failUrl uri

Umleitungs-URL nach Einem Fehler

language
language string

Signiersprache

emailText
emailText string

Benutzerdefinierter Text für die E-Mail-Adresse der Signaturanforderung. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

signOrder
signOrder integer

Die Signierreihenfolge. 0 bedeutet keine erzwungene Bestellung.

successUrl
successUrl uri

Umleitungs-URL nach Erfolg

Emailsubject
emailSubject string

Betreff der E-Mail-Adresse der Signaturanforderung. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

reminderInterval
reminderInterval integer

Tage vor dem Senden einer Erinnerung

reminderEmailText
reminderEmailText string

Benutzerdefinierter Text für die Erinnerungs-E-Mail. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

completedEmailText
completedEmailText string

Benutzerdefinierter Text für die abgeschlossene E-Mail. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

reminderEmailSubject
reminderEmailSubject string

Betreff der Erinnerungs-E-Mail. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

completedEmailSubject
completedEmailSubject string

Betreff der abgeschlossenen E-Mail. Wenn dies nicht angegeben ist, wird standardmäßig die Unternehmensvorlage verwendet.

enableInsecureSigning
enableInsecureSigning boolean

Wenn wahr, kann der Signierer Touchsignaturen verwenden (Zeichnen, Text, Bildupload)

insecureSigningMethods
insecureSigningMethods array of string

Zulässige unsichere Signaturmethoden. Standardmäßig wird die Unternehmenseinstellung festgelegt, wenn sie leer ist.

secureSigningMethods
secureSigningMethods array of string

Die zulässigen sicheren elektronischen Signaturmethoden. Setzt Falldatei und Kundeneinstellungen außer Kraft, wenn sie festgelegt sind.

vatin
vatin string

Umsatzsteuer-Identifikationsnummer des Signierers

ssnType
ssnType string

SSN/Mobile-Typ. Beispiel 'dk:cpr', 'se:pin', 'no:nin', 'be:nrn', 'fi:pic' oder 'sms'. Standardmäßig wird 'Legacy' verwendet.

activeAt
activeAt integer

Aktivierungszeitstempel

expireAt
expireAt integer

Ablaufzeitstempel

accessControl
accessControl boolean

Wenn diese Option aktiviert ist, wird SSN/VATIN/Phone vor dem Zugriff überprüft.

emailFormat
emailFormat string

Definiert das E-Mail-Format

onBehalfOf
onBehalfOf string

Das Unternehmen/die Organisation, das dieser Signierer im Namen von

storeAsContact
storeAsContact boolean

Wenn wahr, wird der Signierer als Kontakt in Penneo gespeichert.

socialSecurityNumberPlain
socialSecurityNumberPlain string

SSN oder Telefonnummer des Signierers (E.164-Format empfohlen)

expireAt
expireAt integer

Zeitstempel, wenn die Falldatei abläuft. Wenn nicht angegeben, gelten Die Standardwerte

language
language string

Die Falldateisprache wird für jeden Signierer angewendet, für den kein Sprachsatz festgelegt ist.

Pdf
pdf True string

Base64-codierte PDF-Datei

Signierbare
signable boolean

True erstellt ein signierbares Dokument. False, das Dokument wird als Anlage hinzugefügt und ist nicht signierbar.

roles
roles array of string

Signierrollen dürfen dieses Dokument signieren. Standardmäßig werden alle Signierer angezeigt, wenn sie leer sind.

title
title True string

Der Dokumenttitel

documentOrder
documentOrder integer

Die Signierreihenfolge des Dokuments. Standardeinstellung für die angegebene Bestellung.

Metadaten
metaData string

Metadaten des Dokuments, durchsuchbar in Penneo

sensitiveData
sensitiveData boolean

Wenn wahr, müssen Signierer ihre Identität überprüfen, bevor sie auf Dokumente zugreifen. Deaktiviert E-Mail-Anlagen für signierte Dokumente.

signOnMeeting
signOnMeeting boolean

Gibt an, ob Dokumente während einer Besprechung signiert werden sollen.

visibilityMode
visibilityMode integer

0 = Signierer sehen alle Dokumente. 1 = Signierer sehen nur Dokumente, die sie signieren müssen.

disableEmailAttachments
disableEmailAttachments boolean

Deaktiviert E-Mail-Anlagen für signierte Dokumente in Abschluss-E-Mails. Überschreiben, wenn sensitiveData wahr ist.

disableNotificationsOwner
disableNotificationsOwner boolean

Wenn der Besitzer der Falldatei keine Benachrichtigungen für die Falldatei erhält.

folderId
folderId integer

Die Ordner-ID, in der Sie Ihre Falldatei platzieren möchten

Metadaten
metaData string

Metadaten der Falldatei, durchsuchbar in Penneo

Referenz
reference string

Der Verweis auf die Falldatei wird in der Penneo-Webanwendung angezeigt.

name
name True string

Name des Empfängers

email
email True email

E-Mail des Empfängers

Gibt zurück

Definitionen

JobResponse

Name Pfad Typ Beschreibung
jobs
jobs array of Job

Array von erstellten Aufträgen (enthält in der Regel einen Auftrag)

status
status string

Status der Auftragserstellungsanforderung

Nachricht
message string

Lesbare Nachricht über die Schaffung von Arbeitsplätzen

Job

Name Pfad Typ Beschreibung
uuid
uuid uuid

Eindeutiger Bezeichner für den Auftrag, der zum Überprüfen des Status verwendet werden kann

uuid
payload.uuid uuid

UUID der erstellten Falldatei

bundleUuid
payload.bundleUuid uuid

UUID des Bundles, das die Falldatei enthält

etlVersionUuid
payload.etlVersionUuid uuid

UUID der zur Verarbeitung verwendeten ETL-Version

organizationUuid
payload.organizationUuid uuid

UUID der Organisation, die diese Falldatei besitzt

customData
payload.customData object

Zusätzliche Metadaten und Kontext für den Auftrag

createdAt
createdAt date-time

ISO 8601-Zeitstempel beim Erstellen des Auftrags

payloadHash
payloadHash string

SHA-256-Hash der Nutzlast, der zur Überprüfung beim Überprüfen des Auftragsstatus verwendet wird

QueueJob

Name Pfad Typ Beschreibung
type
type string

Der Typ des Warteschlangenauftrags (z. B. "casefile_creation").

uuid
uuid uuid

Eindeutiger Bezeichner für den Auftrag

result
result object

Das Ergebnis der Ausführung des Warteschlangenauftrags, zurückgegeben als JSON, wenn der Auftrag abgeschlossen ist. Enthält das Ergebnis und alle relevanten Daten.

jobStatus
jobStatus string

Aktueller Status des Auftrags. Mögliche Werte "ausstehend" (warten auf verarbeitung), "Verarbeitung" (derzeit ausgeführt), "abgeschlossen" (erfolgreich abgeschlossen), "fehlgeschlagen" (Ausführung fehlgeschlagen), "aborted_duplicated" (aufgrund der Duplizierung abgebrochen)

payload
payload object

Die ursprüngliche Nutzlast, die mit dem Auftrag übermittelt wurde, gespeichert als JSON. Enthält die Falldateidaten und -metadaten.

Wiederholungen
retries integer

Die Anzahl der Wiederholungsversuche des Auftrags nach einem Fehler

createdAt
createdAt date-time

Datum und Uhrzeit der Erstellung des Warteschlangenauftrags

updatedAt
updatedAt date-time

Datum und Uhrzeit der letzten Aktualisierung des Warteschlangenauftrags

maxRetries
maxRetries integer

Die maximale Anzahl von Wiederholungsversuchen, die für diesen Auftrag zulässig sind, bevor sie als fehlgeschlagen markiert wird

payloadHash
payloadHash string

SHA-256-Hash der Nutzlast, verwendet für Überprüfungs- und Sicherheitszwecke

errorMessage
errorMessage string

Fehlermeldung, die beschreibt, warum der Auftrag fehlgeschlagen ist, falls zutreffend. Nur vorhanden, wenn jobStatus 'failed' ist.

CcRecipient

Name Pfad Typ Beschreibung
name
name string

Name des Empfängers

email
email email

E-Mail des Empfängers

CaseFileDetails

Details zu einer Falldatei, die aus dem sicheren Archiv von Penneo abgerufen wurde.

Name Pfad Typ Beschreibung
userId
userId integer

ID des Benutzers, der die Falldatei besitzt.

customerId
customerId integer

Die ID des Kunden, zu dem die Falldatei gehört.

Unterzeichner
signers array of SignerDetails

Liste der Signierer in der Falldatei.

id
id integer

Die Falldatei-ID.

title
title string

Der Titel der Falldatei.

status
status integer

Der Status der Falldatei.

Dokumente
documents array of DocumentDetails

Liste der Dokumente in der Falldatei.

expireAt
expireAt integer

UNIX-Zeitstempel, wenn die Falldatei abläuft.

ccRecipients
ccRecipients array of CcRecipient

Liste der CC-Empfänger, die eine Kopie der signierten Dokumente erhalten.

erstellt
created integer

UNIX-Zeitstempel, als die Falldatei erstellt wurde.

aktiviert
activated integer

UNIX-Zeitstempel, als die Falldatei aktiviert wurde.

aktualisierte
updated integer

UNIX-Zeitstempel, als die Falldatei zuletzt aktualisiert wurde.

abgeschlossen
completed integer

UNIX-Zeitstempel, als die Falldatei abgeschlossen wurde.

SignerDetails

Ein Signierer in einer Falldatei.

Name Pfad Typ Beschreibung
name
name string

Name des Signierers.

id
id integer

Die Signierer-ID.

signingRequest
signingRequest SigningRequestDetails

Die mit einem Signierer verknüpfte Signaturanforderung.

SigningRequestDetails

Die mit einem Signierer verknüpfte Signaturanforderung.

Name Pfad Typ Beschreibung
id
id integer

Die Signaturanforderungs-ID.

email
email string

E-Mail-Adresse des Signierers.

status
status integer

Der Status der Signaturanforderung.

DocumentDetails

Ein Dokument in einer Falldatei.

Name Pfad Typ Beschreibung
id
id integer

Die Dokument-ID. Laden Sie das Dokument mit der Aktion "Dokument herunterladen" herunter.

status
status integer

Der Dokumentstatus.

Signierbare
signable boolean

True, wenn das Dokument signierbar ist.

DocumentContent

Name Pfad Typ Beschreibung
Dokumentinhalt
content byte

Base64-codierter Inhalt des Dokuments.