Client WS Interface

The SignServer Client Web Services interface can be used to request signings from SignServer.

The WSDL file is located at the URL http://<hostname>:8080/signserver/ClientWSService/ClientWS?wsdl and locally in the sources under modules/SignServer-Client-ClientWS/xml-resources/web-service-references/ClientWS/wsdl/localhost_8080/signserver/ClientWSService/ClientWS.wsdl.

Operations

processData

Generic operation for request signing of any binary (or character) data.

Parameters:

  • worker (string)
    Name of worker in SignServer which should handle the request.
  • metadata (sequence of key-value pairs)
    Optional additional request data. For instance the PDFSigner accepts the PDF password as a request data.
  • data (base64Binary)
    The document/data to process.

Output:

  • archiveId (string) 
    Identifier for the request if archiving was used.
  • data (base64Binary)
    The signed binary/document.
  • metadata (sequence of key-value pairs)
    Any optional additional response data.
  • requestId (integer)
    Identifier for the request/response.
  • signerCertificate (base64Binary)
    The signer certificate in binary format if available.

Faults:

  • RequestFailedException
  • InternalServerException

processSOD

Operation for requesting an SOD to be created and signed.
The ePassport production system calls this operation to get an SOD for the supplied data groups.

Parameters:

  • worker (string)
    Name of worker in SignServer which should be used for constructing the SOD.
  • metadata (sequence of key-value pairs)
    Optional additional request data. Not used.
  • sodData (a sodRequest structure)
    The sodRequest should contain a sequence of datagroups (id 1-16 and their values), optionally also the version of the LDS to use and the version of Unicode.

Output:

  • archiveId (string) 
    Identifier for the request if archiving was used.
  • data (base64Binary)
    The SOD binary.
  • metadata (sequence of key-value pairs)
    Any optional additional response data.
  • requestId (integer)
    Identifier for the request/response.
  • signerCertificate (base64Binary)
    The signer (DS) certificate in binary format if available.

Faults:

  • RequestFailedException
  • InternalServerException