CIB doXisign technischer Leitfaden

3. Serverseitige REST-Schnittstelle

3.2. Signatur-Session starten

Innerhalb des erzeugten Prozesses kann für jedes Signaturfeld eine Signatur-Session zum Unterschreiben gestartet werden.

Post

<baseUrl>/rest/ process/{processId}/prepare

Signaturfeld-Name

Der Name des zu unterschreibenden Signaturfeldes.

Signatur-Token (optional)

Ein maximal 32 Zeichen langes Text-Token, welches an CIB doXisign zum Einmischen einer Unterschrift mitgegeben wird und zusätzlich zu dem Bild der Signatur im Dokument erscheinen wird. Falls ein userName vorhanden ist wird dieser verwendet.

userId (optional)

Der Eindeutige Identifier des Unterzeichners sofern dieser bekannt ist. Wenn die userId gesetzt wurde wird auch die Unterschrift zusammen mit weiteren Daten (z. B. Authentifizierungsdaten) gespeichert und kann wiederverwendet werden.

skipDialog (optional)

Boolischer Wert der angibt ob das Unterschriftfenster übersprungen werden soll. Funktioniert nur mit einer userId. Sollte der Benutzer noch keine Unterschrift gespeichert haben oder benötigte Authentifizierungen fehlen wird das Unterschriftenfenster trotzdem angezeigt.

userName (optional)

Der Name des Unterzeichners (siehe Signatur Token). Kann nur in Verbindung mit der userId verwendet werden.

userMail (optional)

Die Authentifizierte E-Mail-Adresse des Unterzeichners, kann nur in Verbindung mit der userId verwendet werden.

userMailAuthenticatedBy (optional)

Von welchem Service die E-Mail-Adresse (siehe userMail) verifiziert wurde.

userPhone (optional)

Die Authentifizierte Handynummer des Unterzeichners, kann nur in Verbindung mit der userId verwendet werden.

userPhoneAuthenticatedBy (optional)

Von welchem Service die Handynummer (siehe userPhone) verifiziert wurde.

certificate (optional)

Ein persönliches Zertifikat des Unterzeichners das mit der Unterschrift verknüpft werden soll. Aktuell werden nur PKCS #12 Zertifikate (.p12 / .pfx) unterstützt. Kann nur in Verbindung mit der userId verwendet werden.

certPassword (optional)

Das Passwort für das Zertifikat (siehe certificate).

return

JSON mit der URL zum Unterschriftenfenster. Dies URL sollte i. d. R. per IFrame eingebunden werden.