Signature Parameter

Mit dem Webservice "Signature" können Dokumente digital signiert werden.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<signature>
  <add appendSignature="true"
        certificationLevel="noChanges"
        contact="Softvision Development GmbH"
        fieldName="Signature1"
        keyName=""
        keyPassword=""
        reason="sample"
        location="Fulda">
    <appearance page="1" identifier="" name="">
      <identifierElements
              showCommonName="true"
              showCountry="true"
              showDate="true"
              showLocal="true"
              showMail="true"
              showName="true"
              showOrganisationName="true"
              showOrganisationUnit="true"
              showSignedBy="true"
              showState="true"
      />
      <image position="center" opacity="50">
        <data>iVBOR...S7xAAAAABJRU5ErkJggg==</data>
      </imge>
      <position
              x="0"
              y="0"
              width="0"
              height="0"
              coordinates="user"
              metrics="mm"/>
    </appearance>
  </add>
</signature>
</operation>

{
"signature": {
  "add": {
    "appendSignature": true,
    "certificationLevel": "noChanges",
    "contact": "Softvision Development GmbH",
    "fieldName": "Signature1",
    "keyName": "",
    "keyPassword": "",
    "reason": "sample",
    "location": "Fulda",
    "appearance": {
      "page": 1,
      "identifier": "",
      "name": "",
      "identifierElements": {
        "showCommonName": true,
        "showCountry": true,
        "showDate": true,
        "showLocal": true,
        "showName": true,
        "showOrganisationName": true,
        "showOrganisationUnit": true,
        "showSignedBy": true,
        "showState": true
       },
      "image": {
        "position": "center",
        "opacity": 50,
        "data": {
          "value": "iVBOR...S7xAAAAABJRU5ErkJggg=="
         }
       },
      "position": {
        "x": 0,
        "y": 0,
        "width": 0,
        "height": 0,
        "coordinates": "user",
        "metrics": "mm"
       }
     }
   }
 }
}

 

 

add-Element

 

Fügt eine neue Signatur dem PDF-Dokument hinzu.

 

<add appendSignature="true"
    certificationLevel="noChanges"
    contact="Softvision Development GmbH

    fieldName="Signature1"
    keyName=""
    keyPassword=""
    reason="sample"
    location="Fulda">
    ...
</add>

"add": {
"appendSignature": true,
"certificationLevel": "noChanges",
"contact": "Softvision Development GmbH",
"fieldName": "Signature1",
"keyName": "",
"keyPassword": "",
"reason": "sample",
"location": "Fulda",
     ...
 }

 

appendSignature (Default: true)

Wenn der Wert auf "true" steht, dann wird die neue Unterschrift angehangen, wenn bereits eine Unterschrift im Dokument vorhanden ist. Ist der Wert auf "false" gesetzt und das Dokument enthält bereits eine Unterschrift, dann wird eine Exception ausgelöst.

 

certificationLevel (Default: "noChanges")

Über diesen Parameter wird die Stufe der Unterschrift bestimmt.

none = Unterschreiben, aber nicht zertifizieren, des Dokuments - d. h. weitere Unterschriften bzw. Änderungen sind möglich.

noChanges = Dokument zertifizieren, und keine weiteren Änderungen mehr zulassen.

formFillingAndSignatures = Dokument zertifizieren, aber das Ausfüllen von Feldern erlauben.

formFillingAndSignaturesAndAnnotations = Dokument zertifizieren, aber das Ausfüllen von Feldern und das Anbringen von Anmerkungen erlauben.

 

contact (Default: "")

Gibt den Namen des Unterzeichners an.

 

fieldName (Default: "Signature1")

Definiert den Namen des Feldes im Dokument, in dem die Unterschrift gespeichert wird. Wird hier ein bereits vorhandener Feldname angegeben, dann wird automatisch ein eindeutiger Name berechnet.

 

keyName (Default: "")

Definiert den Namen des Schlüssel (Alias), der bei der Unterzeichnung des Dokuments verwendet werden soll. Diese Einstellung überschreibt die Konfigurationseinstellung des Servers. Weitere Information finden Sie im Kapitel "Keystore".

 

keyPassword (Default: "")

Definiert das Passwort, das für den Zugriff auf den privaten Schlüssel von "keyName" benötigt wird. Diese Einstellung überschreibt die Konfigurationseinstellung des Servers. Weitere Informationen finden Sie im Kapitel "Keystore".

 

reason (Default: "")

Gibt den Grund für die Unterzeichnung des Dokuments an.

 

location (Default: "")

Gibt den Ort der Unterzeichnung an.

 

 

appearance-Element

 

Definiert das visuelle Erscheinungsbild der Signatur.

 

<appearance page="1" identifier="" name="">
      ...
</appearance>
 

"appearance": {
  "page": 1,
  "identifier": "",
  "name": "",
       ...
 }

 

page (Default: 1)

Legt fest, auf welcher Seite die Unterschrift angezeigt wird.

 

identifier (Default: "" )

Text, der im rechten Textfeld der Signatur angezeigt werden soll. Wird kein Wert angegeben, dann stehen dort der Name des Unterschreibers und die Namensbestandteile des Zertifikats (siehe "<identifierElements>" weiter unten).

 

name (Default: "")

Name der im linken Bereich der Signatur angezeigt wird. Wird kein Wert angegeben, dann steht dort der Name des Unterschreibers (Name aus dem Zertifikat).

 

 

identifierElements-Element

 

Legt die Elemente fest, die Bestandteil der visuellen Signatur sind.

 

<identifierElements
        showCommonName="true"
        showCountry="true"
        showDate="true"
        showLocal="true"
        showMail="true"
        showName="true"
        showOrganisationName="true"
        showOrganisationUnit="true"
        showSignedBy="true"
        showState="true"/>      

"identifierElements": {
  "showCommonName": true,
  "showCountry": true,
  "showDate": true,
  "showLocal": true,
  "showName": true,
  "showOrganisationName": true,
  "showOrganisationUnit": true,
  "showSignedBy": true,
  "showState": true
},      

 

Mit den nachfolgenden Optionen können die Namensbestandteile des Zertifikats anzeigt oder versteckt werden. Setzen sie den entsprechenden Wert auf "true" zur Anzeige oder auf "false" zur Ausblendung.

 

showCommonName (Default: true)

showCountry (Default: true)

showDate (Default: true)

showLocal (Default: true)

showMail (Default: true)

showName (Default: true)

showOrganisationName (Default: true)

showOrganisationUnit (Default: true)

showSignedBy (Default: true)

showState (Default: true)

 

 

image-Element

 

Legt eine Grafik für die visuelle Signatur fest, die in den Hintergrund der Signatur gezeichnet wird. Die Grafik selbst wird über das "<data>" übergeben.

 

<image position="center" opacity="50">
  <data>iVBOR...S7xAAAAABJRU5ErkJggg==</data>
</image>

"image": {
    "position": "center",
    "opacity": 50,
    "data": {
      "value": "iVBOR...S7xAAAAABJRU5ErkJggg=="
    }
},

 

position (Default: "center")

Position der Grafik innerhalb des Signatur-Feldes:

center = zentriert

left = links

right = rechts

 

opacity (Default: 50)

Deckkraft der Grafik als prozentualer Wert zwischen 0 und 100.

 

 

data-Element

Eine Grafik, die in den Hintergrund des Feldes gelegt wird. Die Daten werden als BASE64 übergeben. Zur optimalen Anzeige sollte es sich um eine transparente Grafik (z.B. PNG) handeln.

 

 

position-Element

 

Legt die Position der visuellen Signatur fest.

 

<position
    x="0"
    y="0"
    width="0"
    height="0"
    coordinates="user"
    metrics="mm"/>

"position": {
  "x": 0,
  "y": 0,
  "width": 0,
  "height": 0,
  "coordinates": "user",
  "metrics": "mm"
}

 

x (Default: 10 Millimeter vom linken Rand)

X-Position des Feldes.

 

y (Default: 10 Millimeter vom unteren Rand)

Y-Position des Feldes

 

width (Default: 80 - in Millimeter)

Breite des Signatur-Feldes

 

height (Default: 40 - in Millimeter)

Höhe des Signatur-Feldes

 

coordinates (Default: "user")

Legt das Koordinatensystem und somit den Ursprung für die Angaben fest.

user = User-Koordinatensystem (Ausgangspunkt links oben)

pdf = PDF-Koordinatensystem (Ausgangspunkt links unten)

 

metrics (Default:"mm")

Maßeinheit für die Angaben der X/Y-Position und der Höhe und Breite des Signatur-Feldes:

mm = Millimeter

px = Pixel