ViewSign Cloud On-Premise SDK Documentation API Documentation

API Documentation

We declared SOAP as deprecated and therefore SOAP will not be included in versions after 20.76. Latest release including SOAP API for eSAW will be 20.76, released in spring 2021 and with the software maintenance on 20.76 until spring 2023.

Therefore, we recommend REST technology for integration. Please see also the migration guide.

API and Samplecode

The API is for developers, who want to integrate eSignAnyWhere into their application and for administrators, who want to script interactions with eSignAnyWhere (e.g. user synchronization).

Quick Overview: eSAW uses REST or SOAP (with JSON or XML) as API. We recommend the REST interface. The basic workflow is to upload a document (uploadTemporarySspFile) and then call sendEnvelope with a envelope configuration. The configuration consists out of the envelope part (workflow configuration) and for each recipient a definition and a signing configuration (workstep configuration). The workstep configuration is the description (as JSON for REST) of tasks for signer (e.g. Signature Fields, Form-Fields) and additional document configurations.

The easiest way to start is enabling the DeveloperMode for a user. As developer (and power user) you can send envelopes via eSignAnywhere in the UI and download the complete envelope configuration (including the workstep configurations). So eSAW can be a seen as configuration designer, where you can easily prepare the envelope configuration. After you downloaded the configuration you just have to replace the recipient information and configuration.

Resources

API Reference*	Example
eSAW SOAP API endpoint	Example
eSAW SOAP WSDL	Example
Usermanagement SOAP API endpoint	Example
Usermanagement SOAP WSDL	Example
REST with JSON + Swagger ( eSAW v3.1+)	Example
Migration Guides*	Example
Sample Code in C# and Java	Example
Tutorial: Hello World*	Example
Tutorial: SoapUI (SOAP)	Example
'Tutorial: Postman* (REST) 'REST in SOAPUI	Example
Developer mode*	Example
SignAnyWhere Viewer 2019	Example
SignAnyWhere Viewer Extended Customization	Example
The Envelope XML and WorkstepConfiguration XML	Example
Tutorial: Java Library Tutorial and Sample Code	Example
Integration & Use Cases	Example
How To’s	Example
Developer FAQ	Example
eSAW Error Codes	Example

* Recommended

The User Guide, Signer Guide and Administration Guide (for on-premise customers) can be also helpful.