OK dokument (Independent Publisher) (Vorschau)

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	Seyfor Slovensko a.s.
URL	https://www.seyfor.com
Email	tomas.szarka@seyfor.com

Connectormetadaten
Herausgeber	Seyfor Slovensko, a.s.
Webseite	https://okdokument.com/
Datenschutzrichtlinie	https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf
Kategorien	Produktivität

OK Dokument - elektronische Signatur

OK dokument bietet eine einfach zu verwendende und anpassbare elektronische Signatur und digitale Inhaltsverteilungsplattform, die nahtlos in Ihre vorhandenen Systeme integriert wird.

Herausgeber

Seyfor Slovensko, a.s.

Voraussetzungen

Sie müssen über ein Konto und https://app.okdokument.com einen gültigen API-Schlüssel verfügen, der vom OK-Dokumentdienst generiert wird.

Unterstützte Vorgänge

1. Dokumentupload

Aktion zum Hochladen einer PDF-Datei in den Dokumentsignaturdienst. Diese Aktion führt eine base64-Zeichenfolge aus und lädt sie auf die OK-Dokument-API-Plattform hoch.

Das Dokument übergibt mehrere Zustände während seiner Lebensdauer. Die OK-Dokument-API verwendet die folgenden Dokumentzustände:

• Tags – Zustand, der Texttags durchsucht und Signatur-Akrofields einfügt. Nach erfolgreicher Einfügung von Akrofeldern ändert sie automatisch den Zustand in "tosign".
• tostamp – Zustand, der digitale Stempel in das Dokument einfügt
• tosign – Dokument kann signiert werden
• signed – signed document (within given signatureRequestID)
• errorsendinfo – Fehler beim Aufrufen des Infodiensts
• abgebrochenes – abgebrochenes Dokument – Signierer hat die Schaltfläche "Abbrechen" im Dokument gedrückt.

Signatur-Akrofelder

Acrofield ist eine Art von aktivem Feld, das in PDF unterstützt wird. Ein Signatur-Akrofeld ist ein spezieller Typ von aktivem Feld, mit dem eine Signatur an einer festen Position in ein Dokument eingefügt werden kann. Acrofields können in PDF-Dateien mit spezialisierten PDF-Tools wie Adobe PRO oder mit Vorlagentools wie JasperReport eingefügt werden.

Stichwörter

Ein Tag stellt einen eindeutigen Textwert dar, den der API-Server überprüft. Wenn sie gefunden wird, fügt sie das Signatur-Akrofeld an seine Stelle ein. Die Tagsuche wird vom Dokumentstatus "tags" bereitgestellt, der festgelegt werden muss, wenn der JSON-/Dokumentdienst aufgerufen wird. Die OKdokument-API unterstützt die folgenden Tags für optionale Signatur:

_SO1_ _SO2_ _SO3_ _SO4_ _SO5_

Die OKdokument-API unterstützt die folgenden Tags für obligatorische Signatur: _SC1__SC2__SC3_ _SC4__SC5_

Wenn obligatorische Tags verwendet werden, müssen alle sichtbaren obligatorischen Signatur-Akrofelder vor dem Übermitteln des Dokuments signiert werden.

Falls es nicht möglich ist, Dokumente mit Signaturakrofeldern oder Tags beim Registrieren von signatureRequest vorzubereiten, ist es möglich, die Funktion "Überall signieren" zu aktivieren, wodurch der Benutzer das Dokument an einem beliebigen Ort signieren kann, ganz einfach, wo der Benutzer klickt/tippt.

Dokument in PDF konvertieren

Die OKdokument-API unterstützt die Konvertierung von .doc, .docx, .xls, .xlsx in das PDF-Dateiformat. Die Quelldatei kann auch Tags enthalten, die OKdokument-API führt zuerst die Dateikonvertierung aus und fügt dann automatisch Signatur-Akrofelder ein.

Um die Datei in PDF zu konvertieren, müssen Sie den Namen des Dokuments ausfüllen. Dieser Parameter ist obligatorisch, wenn Sie die Dateikonvertierung in das PDF-Format durchführen möchten. Für die Konvertierung muss das Dateipostfix folgendes sein:

• contract.doc
• contract.docx
• contract.xls
• contract.xlsx

Speichern und Löschen von Dokumenten

DIE OK dokument-API dient nicht der Rolle eines permanenten Archivs signierter Dokumente. Es werden folgende Regeln angewendet:

1. Signiertes Dokument wird 10 Tage nach dem Signieren automatisch gelöscht.
2. Nicht signiertes Dokument wird nach 30 Tagen nach dem Hochladen automatisch gelöscht.

2. Signaturanforderung

Diese Aktion wird zum Generieren der Signaturanforderungs-ID verwendet. In dieser Aktion müssen Sie die Dokument-ID verwenden. Die Dokument-ID ist ein Ergebnis der Aktion "Dokumentupload".
In dieser Aktion können Sie Ihren Signaturprozess in einen mehrstufigen Signaturprozess umwandeln. Durch das Hinzufügen zusätzlicher Parameter "Signaturfelder" können Sie verwalten, was in jeder Signaturanforderung verfügbar sein soll. Sie können Akrofelder mit internen Namen verwenden.

_SO1_ _SO2_ _SO3_ _SO4_ _SO5_

ODER

_SC1_ _SC2_ _SC3_ _SC4_ _SC5_

Diese Aktion kann mehrmals in Ihrem Prozess verwendet werden. Die Signaturanforderungsaktion wird im OK-Dokumentdienst als "Signaturanforderung" generiert, und diese ID ist für jede "Sign"-Aktion eindeutig.

Zum Senden einer Anforderung für die Dokumentsignatur verwenden Sie die Antwort-Attribut-URL und verwenden sie in E-Mails, Pushbenachrichtigungen oder MS Teams, um eine Person zum Signieren bestimmter Dokumente zu bitten.

Nachdem das Dokument signiert wurde, können Sie "Signaturanforderung" verwenden, um den Dokumentstatus in "tosign" zu ändern und neue signatureRequestId zu erstellen und das Dokument für die nächste Signatur vorzubereiten. Als der Prozess wiederholt die Schritte 3 – 5.

Beispiel für signaturanforderung mit einem obligatorischen Akrofeld

_SC1_

Beispiel für die Signaturanforderung mit einem obligatorischen Akrofeld und einem optionalen Akrofeld in einer Signaturanforderung_SC1_;_SO2_

Zusätzliche Regeln in signaturanforderung

Zusätzliche Regeln können verwendet werden, um:

• Deaktivieren oder Aktivieren der Funktion "Überall signieren"
• Vordefinierter Wert für den Namen des Signierers
• Aktivieren der Eingabe für den Namen des Signierers
• Aktivieren des Sendens von Signaturanforderung aus OK Dokument
• E-Mail-Erinnerung aktivieren
• OTP-Konfiguration (einmaliges Kennwort) per E-Mail oder SMS
• Dokument mit OTP signieren
• Signieren mit der Maus deaktivieren

Regelname	Parameter	Description
signAnywhereEnabled	true/false	Parameter zum Deaktivieren der Signierfunktion "Anywhere"
guiRequestSignerName	true/false	Parameter zum Aktivieren der Eingabe für den Namen des Signierers
guiSignerName	Signierername	vordefinierter Wert für den Namen des Signierers, max. 40 Zeichen. Wenn guiRequestSignerName aktiviert ist, kann der Anmeldename durch den Signierer geändert werden.
signAnywhereEnabled	true/false	Parameter zum Deaktivieren der Signierfunktion "Anywhere"
emailTo	E-Mail-Adresse des Signierers	Signierer-E-Mail, an welche Signaturanforderungs-URL gesendet wird
geliefert werden.
emailFrom	Absender-E-Mail	Absender-E-Mail. Obligatorisch, wenn emailTo-Regel verwendet wird
nameFrom	Absendername	Name der Absender, der in den E-Mail-Vorlagen verwendet wird
E-Mail-Benachrichtigung		Regel, die E-Mail-Erinnerungen aktiviert. E-Mail-Erinnerung sendet E-Mails jeden Morgen um 7:00 Uhr für Signaturanforderungen, die nicht signiert sind. Die E-Mail wird an emailTo und emailFrom – entsprechend – signatureRequest-Konfiguration gesendet.
emailFinal	E-Mail-Adresse des Signierers	E-Mail, um das signierte Dokument zu übermitteln. Wenn emailFinal ohne Parameter ist, wird das signierte Dokument an emailTo gesendet.
openOtpPhone	Signiertelefon	Die Telefonnummer der Signierer, an die das einmalige Kennwort für den Zugriff auf das Dokument übermittelt wird. Um SMS OTP zu verwenden, müssen Sie ein Signaturanforderungspaket mit SMS kaufen.
openOtpEmail	E-Mail-Adresse des Signierers	Signierer-E-Mails, an die das einmalige Kennwort für den Zugriff auf das Dokument übermittelt wird.
signOtpPhone	Signiertelefon	Die Telefonnummer der Signierer, an die das einmalige Kennwort zum Signieren des Dokuments übermittelt wird. FÜR DIE OTP-Signatur ist ein Akrofeld für die Signatur erforderlich.
signOtpEmail	E-Mail-Adresse des Signierers	Signierer-E-Mails, an die das einmalige Kennwort zum Signieren des Dokuments übermittelt wird. FÜR DIE OTP-Signatur ist ein Akrofeld für die Signatur erforderlich.
Dauer	sk, cs, en, ro, uk, pl, pt, hu	Sprache der E-Mail- und SMS-Vorlage, Wenn die Regel nicht festgelegt ist, wird Slowakisch als Standardsprache verwendet.
mouseSignature	Falsch	Regel zum Deaktivieren der Signatur mit der Maus.

Syntaxt zum Schreiben von Signaturanforderungsregeln
RuleName-Value

Syntaxt zum Schreiben mehrerer Signaturanforderungsregeln
RuleName1-Value_RuleName2-Value_RuleName3-Value

Beispiel für signaturanforderung mit aktivierter Sign Anywhere-Anforderung
signAnywhereEnabled-true

Beispiel für signaturanforderung mit deaktivierter Sign Anywhere und aktivierter Signierername mit vorgefüllten Wert
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false

Beispiel für signaturanforderung mit deaktivierter Sign Anywhere, aktivierter Signierername mit vorgefüllten Wert, definierte OTP-E-Mail zum Öffnen der Signaturanforderung, E-Mail, an die Signaturanforderung gesendet wird, E-Mail-Vorlagensprache, Absender-E-Mail-Adresse der Signaturanforderung
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false

Ablaufzeit

Der Standardwert für den Ablauf der Signaturanforderung beträgt 24 Stunden. Sie können diesen Zeitraum bis zu 10 Tage mit diesem Parameter expirationTime verlängern. Ablaufzeit der Signaturanforderungs-ID. Zeit in Millisekunden seit dem 1. Januar 1970 00:00:00 UTC

Email

Mit der OKdokument-API können Sie signatureRequest-URL per E-Mail freigeben. Zum Senden von E-Mails müssen Sie Regeln verwenden:

• emailTo – E-Mail des Signierers
• emailFrom – E-Mail des Absenders
• nameFrom – Name des Absenders

E-Mails werden übermittelt okdokument@okdokument.sk, aber wenn der Signierer auf die Schaltfläche "Antworten/Antworten" klickt, wird die Antwort direkt an den Absender (emailFrom) gesendet. Es wird empfohlen, auch die folgenden Regeln für zusätzliche Einrichtung im Signierungsprozess zu verwenden:

• emailFinal – E-Mail zum Senden des signierten Dokuments. Standardmäßig wird emailTo verwendet, kann aber geändert werden. Verwenden Sie bei multirunden Signierungen diese Regel in der letzten Signaturrunde, und füllen Sie alle E-Mail-Adressen aller Sänger aus. Beispiel: emailFinalemail@address.com|email2@address.com
• emailNotification – E-Mail zum Senden einer Erinnerung, dass das Dokument auf die Signatur wartet.
• sprache – Sprache der E-Mail-Vorlage
• Dateiname – Dokumentname, der in der E-Mail-Vorlage verwendet wird. Wenn der Dateiname nicht ausgefüllt ist, wird die id des technischen Dokuments als Dokumentname verwendet.

3. Auf Signatur warten

Die Triggeraktion "Auf Signatur warten" kann in Ihrem Prozess verwendet werden. Die Aktion "Auf Signatur warten" wartet, bis die Dokumentsignatur im OK-Dokumentdienst bestätigt wird, indem Sie auf die Schaltfläche "Absenden" klicken. Sobald die Signatur übermittelt wurde, wird diese Triggeraktion abgeschlossen. Sie können diese Aktion verwenden, wenn Sie auf die Bestätigung der Dokumentsignatur in Ihrem Prozess warten müssen.

4. Signiertes Dokument herunterladen

Mit dieser Aktion können Sie signiertes Dokument herunterladen und das Dokument in zusätzlichen Schritten in Ihrem System verarbeiten oder in SharePoint oder einem anderen Dokumentspeichersystem speichern.

5. Dokument löschen

Nachdem Ihr Dokument signiert wurde, können Sie das Dokument mithilfe der manuellen Löschaktion aus dem OK-Dokumentdienst löschen. Alle hochgeladenen Dokumente werden nach 60 Tagen automatisch gelöscht, und signierte Dokumente werden nach 10 Tagen gelöscht.

Abrufen von Anmeldeinformationen

Sie können den API-Schlüssel abrufen, der für die Verwendung des OK-Dokumentdiensts erforderlich ist, indem Sie sich abonnieren.https://okdokument.com/en/about/api/

Bekannte Probleme und Einschränkungen

Derzeit gibt es Einschränkungen bei der Verwendung von Akrofeldern und Tags. Die einzige mögliche Verwendung von Tags oder Akrofeldern ist vordefiniertes Zeichenfolgenformat in Ihrem Prozess: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ oder _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .

Benutzerdefinierte interne Akrofeldnamen werden derzeit verwendet:

Kontrollkästchen	Akrofeld
Optionales Kontrollkästchen	Kohlenmonoxid
Obligatorisches Kontrollkästchen	CR

Textfeld	Akrofeld
Optionales TextField	TO
Pflichttextfeld	TC

Optionsfeldgruppe	Akrofeld
Optionale Optionsfeldgruppe	RO
Obligatorische Optionsfeldgruppe	RC

Kombinationsfeld	Akrofeld
Optionales Kombinationsfeld	CBO
Obligatorisches Kombinationsfeld	CBC

Bereitstellungsanweisungen

Verwenden Sie die hier aufgeführten Anweisungen, um diesen Connector als benutzerdefinierter Connector in Microsoft Power Automate, Power Apps oder Azure LogicApps bereitzustellen.

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
OK dokument-API-Schlüssel	securestring	Der von Anasoft ausgestellte App-/Abonnement-API-Schlüssel	Richtig

Drosselungsgrenzwerte

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

Aktionen

Dokument löschen	Dokument löschen
Dokumentupload	Dokumentupload
Signaturanforderung	Signaturanforderung
Signiertes Dokument herunterladen	Signiertes Dokument herunterladen

Dokument löschen

Dokumentupload

Signaturanforderung

Signiertes Dokument herunterladen

Auslöser

Auf Dokumentsignatur warten

Auf Dokumentsignatur warten

Auf Dokumentsignatur warten

Definitionen

binär